Documentatie Joomla! extensie ’Attachments’
Version 1.2 - 20 Februari 2008
Nederlandse vertaling door
Parvus
- Inleiding
- Beperkingen
- Instellingen
- Bestandsnamen
- De lijst van bijlagen opmaken
- Pictogrammen
- Tips
- Upgraden
- Dankwoord
Inleiding
Met de Joomla! extensie ’Attachments’ kan u bestanden als bijlage
aan een artikel toevoegen. ’Attachments’ bevat twee plugins en een
component. De plugins laten u toe bijlagen te tonen en toe te voegen; de
component verzorgt zowel het verzenden van bestanden van uw PC naar de
webserver als het beheer van de reeds verzonden bestanden op de webserver.
Verschillende opties zorgen voor de nodige flexibiliteit en verhogen het
gebruiksgemak. U kan ook zelf bepalen wie de bijlagen kan openen en wie
bijlagen aan een artikel kan toevoegen. Alle opties zijn in te stellen in de
component Artikel Bijlagen in de back-end.
’Attachments’ is alleen geschikt voor Joomla! 1.5 of hoger.
’Attachments’ kan gemakkelijk worden vertaald naar je eigen
taal. De volgende talen zijn reeds beschikbaar:
- Traditioneel en vereenvoudigd Chinees Vertaald
door Baijianpeng.
- Nederlands Vertaald door
Parvus.
- German: Vertaald door Michael Scherer.
- Finnish: Vertaald door Tapani Lehtonen.
- Norwegian: Vertaald door Espen Gjelsvik.
- Portugees / Braziliaans Vertaald door Arnaldo Giacomitti en Cauan Cabral.
- Spanish: Vertaald door Carlos Alfaro.
- Engels Van de hand van de auteur
Jonathan M. Cameron.
Een woord van dank aan alle vertalers! Als u wilt helpen om uw eigen taal toe
te voegen of te verbeteren, aarzel dan niet en neem contact op met
Jonathan M. Cameron.
[Index]
Beperkingen
Niet alle bestanden kunnen verzonden worden naar de webserver.
’Attachments’ weigert bestanden die niet zijn toegelaten door de
Media instellingen. Deze zijn terug te vinden in de back-end via
Algemene instellingen in de tab systeem (u heeft
hier wel super-administrator rechten voor nodig). U kan daar de toegestane
bestandstypen en MIME typen voor media bestanden inkijken en aanpassen.
’Attachments’ respecteert al deze instellingen, alleen de
instelling Toegestane afbeeldingsextensies (bestandstypen) wordt
genegeerd.
[Index]
Instellingen
Alle instellingen voor ’Attachments’ zijn ondergebracht bij de
component Artikel Bijlagen. Deze zijn terug te vinden in de back-end
via pluginbeheer onder het menu Extensies. Kies daarna voor het
bewerken van de plugin Content-Attachments. Aan de rechterkant van de
pagina vindt u dan de lijst van instellingen.
- Wie kan de bijlagen inkijken
Hier kan u aangeven wie de bijlagen kan openen of bewaren op zijn PC. Er zijn
twee mogelijkheden:
- Iedereen
Iedereen kan de bijlagen inkijken door op de voorziene link klikken, ook al
zijn ze niet aangemeld.
- Elke geregistreerde gebruiker
Alleen gebruikers die zich hebben aangemeld kunnen de bijlagen inkijken door
op de voorziene link klikken.
- Wie kan bijlagen toevoegen
Hier kan u aangeven wie bijlagen kan toevoegen aan een artikel. Er zijn twee
mogelijkheden:
- Alleen de auteur
Alleen de auteur van het artikel kan bijlagen toevoegen aan het artikel.
- Elke geregistreerde gebruiker
Elke gebruiker die zich heeft aangemeld kan een bijlage toevoegen aan het
artikel.
- Automatisch publiceren
Hier kan u aangeven of de bijlagen automatisch worden gepubliceerd zodra ze
zijn toegevoegd aan een artikel. Niet-gepubliceerde bijlagen zijn voor niemand
zichtbaar tot ze gepubliceerd worden door een administrator in the back-end.
- Waarschuwing indien niet automatisch gepubliceerd
Hier kan u aangeven of ’Attachments’ een waarschuwing moet geven
indien een nieuwe bijlage niet automatisch wordt gepubliceerd. De waarschuwing
kan u zelf opstellen, en deze mag HTML code bevatten.
- Toon hoofding
Hier kan u aangeven of de lijst van bijlagen een hoofding voor elke kolom
bevat.
- Toon beschrijving
Hier kan u aangeven of de beschrijving van een bijlage wordt getoond in de
lijst van bijlagen onderaan een artikel.
- Toon grootte
Hier kan u aangeven of de grootte in KB van elk bestand wordt getoond in de
lijst van bijlagen onderaan een artikel.
- Toon datum van laatste wijziging
Hier kan u aangeven of de datum van laatste wijziging van elk bestand wordt
getoond in de lijst van bijlagen onderaan een artikel. Indien u hier
Nee
kiest, wordt geen datum toegevoegd.
- Formaat van datum van laatste wijziging
Hier kan u opgeven hoe de datum getoond moet worden. Het formaat van de PHP
functie date()
wordt hiervoor gebruikt. Standaard is dit
M-j-Y g:ia
wat zich bijvoorbeeld vertaald tot
Sep-29-2007 5:05pm
. Indien u alleen M-j-Y g:ia
opgeeft, wordt dit Sep-29-2007
.
- Voorvoegsel bij bestandsnaam
Hier kan u aangeven welk voorvoegsel de verzonden bestanden krijgen. Er zijn 3
mogelijkheden:
- Artikel ID
Bestanden krijgen als voorvoegsel het artikel ID. Het vermindert de kans op
gelijke bestandsnamen, en zorgt er voor dat in de folderlijsten de bestanden
van eenzelfde artikel gegroepeerd weergegeven worden. Eenzelfde bestand kan
meerdere malen worden verzonden, indien het telkens aan een ander artikel
wordt toegevoegd.
- Bijlage ID
Bestanden krijgen als voorvoegsel het bijlage ID. Het elimineert de kans op
gelijke bestandsnamen, en zorgt er voor dat in de folderlijsten de bestanden
in volgorde van verzenden worden getoond. Eenzelfde bestand kan meerdere malen
worden verzonden, zelfs aan hetzelfde artikel.
- Niets
Met deze optie worden de bestanden bewaard op de webserver zoals ze op uw PC
stonden. Deze optie verhoogt de kans op dubbele bestandsnamen.
- Folder voor bijlagen
’Attachments’ zal de verzonden bestanden bewaren in de opgegeven
folder onder uw Joomla! website. Opgepast: bij wijziging van deze folder,
worden de reeds verzonden bestanden niet verplaatst en de bestaande bijlagen
zullen nog steeds wijzen naar de oude folder.
- Aangepaste titels
Standaard geeft ’Attachments’ de lijst van bijlagen de titel
Bijlagen - maar uiteraard alleen indien er bijlagen zijn. Maar soms
is een aangepaste titel te verkiezen. Hier kan u voor specifieke artikels deze
aangepaste titel opgeven. Indien u bijvoorbeeld voor het artikel met ID 211
een aantal formulieren als bijlage toevoegt, kan u hier
211 Formulieren
plaatsen. Gebruik voor elke aangepaste
titel een aparte lijn.
- Verberg bijlagen voor:
Lijst van trefwoorden of ID's van secties en categoriƫen waar de lijst van bijlagen niet getoond mag worden. Er zijn twee trefwoorden (zonder quotes) voorzien: 'frontpage' om de bijlagen te verbergen op de voorpagina, en 'all_but_article_views' om de bijlagen alleen te tonen in een 'Weergave artikel' pagina. De ID's moeten ingegeven worden als het nummer van de sectie, of als het nummer van de sectie gevolgd door een schuine streep en het nummer van de categorie (dus: sectienummer/categorienummer). Bijvoorbeeld: 23/10, 23/11, 24, frontpage.
- Beveiligde toegang
Standaard bewaart ’Attachments’ de verzonden bestanden in een
folder die publiekelijk toegankelijk is. Dit wil zeggen dat iedereen die de
volledige link kent naar een bestand, deze ook kan afhalen. Hij kan dit doen,
zelfs indien hij geen rechten heeft om de bijlage te zien in het artikel
waaraan het toegevoegd is. Maar met optie beveiligde toegang
aangevinkt, zal nooit de rechtstreekse link naar een bestand getoond worden.
Bovendien wordt de folder met bijlagen publiekelijk ontoegankelijk gemaakt.
Een gebruiker zonder de juiste rechten die toch zo’n link weet te
bemachtigen, kan dan nog steeds niet het bestand afhalen.
- Hoe bijlagen tonen
Hier kan u aangeven hoe de bestanden getoond moeten worden, indien er
beveiligde toegang gebruikt
wordt. Er zijn twee mogelijkheden:
- inline Bestanden die worden ondersteund door uw browser (zoals
tekst of foto’s) worden getoond in uw browser.
- link Van alle bestanden (ook tekst en foto’s) wordt alleen
een link gegeven, en kunnen alleen worden ingekeken door er op te klikken.
Ongeacht deze instelling worden bestanden die uw browser niet ondersteunt,
getoond als een link.
[Index]
Bestandsnamen
Standaard wordt de volledige bestandsnaam getoond in de lijst van bijlagen als
link om het bestand af te halen. Indien gewenst kan u in het veld Toon
bestandsnaam een andere naam of label opgeven die getoon moet worden in
plaats van de volledige bestandsnaam. Dit kan ook aangepast worden in de
back-end.
Indien de bestandsnamen te lang zijn, kan de tabel van bijlagen niet
netjes worden getoond. U kan een bestandsnaam automatisch afkorten met de
plugin optie Maximum lengte van de bestandsnaam. Dit heeft geen invloed
op de naam waaronder ze worden bewaard: de naam wordt dan alleen verkort
weergegeven. De waarde 0 schakelt het inkorten uit: de lengte wordt dan niet
beperkt.
[Back to top]
De lijst van bijlagen opmaken
De lijst van bijlagen die getoond worden bij een artikel maken gebruik van een
specifieke div
die een tabel bevat. Met deze tabel zijn een
aantal CSS classes geassocieerd, om een administrator de flexibiliteit te
geven de opmaak van de tabel aan te passen aan ieders eigen noden en wensen.
In de plugin van ’Attachments’ kan u een css bestand vinden
waar de css class definitie terug te vinden is, zie
./plugins/content/attachments.css
.
Om een eigen opmaak op te stellen, vertrekt u best van het voorbeeld wat u
daar vindt. Het is ten sterkste aangeraden om de css class
attachmentsList
eerst te kopieren, dan te
hernoemen, om tenslotte in de nieuwe css class uw wijzigingen aan te
brengen.
In de component Artikel Bijlagen in de back-end kan u bij de instelling
Attachments table style uw nieuwe css class opgeven. Als u de
raadgeving hierboven opvolgt, is het gemakkelijk om terug te gaan naar de
originele - en gegarandeerd werkende - toestand. U kan ook de css instructie
@import gebruiken; dit maakt het gemakkelijker om een overzicht te bewaren
over alle wijzigingen en bij een upgrade deze opnieuw aan te brengen.
[Index]
Pictogrammen
’Attachments’ toont een pictogram bij elke bestand in de lijst van
bijlagen. U kan aangeven welk pictogram u wenst te gebruiken voor een bepaald
bestandstype:
- Voeg het pictogram toe aan
./media/attachments/icons
, indien
nodig.
- Bewerk het bestand
./components/com_attachments/file_types.php
door een extra lijn toe te voegen aan de static array
$attachments_icon_from_file_extension
, die bijhoudt welk pictogram
er gebruikt moet worden voor elk bestandtype.
- Het kan zijn dat u ook een extra lijn moet toevoegen aan de array
$attachments_icon_from_mime_type.
- Wees er zeker van dat u van zowel het pictogram als de wijzigingen in het
php bestand een kopie maakt, zodat de aanpassingen gemakkelijk opnieuw kunnen
worden aangebracht na het upgraden van ’Attachments’.
[Index]
Tips
- Als u bestanden toevoegt die privé zijn of gevoelig van
aard, beveilig dan zeker de toegang tot de bijlagen.
Zonder de optie beveiligde toegang worden alle bestanden bewaard in
een publiekelijk toegankelijke folder, en wordt de rechtsreekse link geplaatst
bij het artikel. Iedereen die deze link kent kan dan de bestanden inkijken.
Met de optie beveiligde toegang worden gebruikers zonder de juiste
rechten de toegang versperd. Zie ook de uitleg bij de instelling
beveiligde toegang hierboven.
- Telkens u een bestand toevoegt, wordt nagekeken of de folder reeds
bestaat. Indien nodig wordt er geprobeerd deze aan te maken. Het is altijd
mogelijk dat deze poging mislukt. In dat geval moet u de folder zelf aanmaken.
Zorg er dan voor de geschikte toegangsrechten toe te kennen. Op een Linux
webserver betekent dit dat u de rechten
744
toekent.
- Indien u problemen heeft om een bepaald bestand toe te voegen, kijk dan na
of het bestandstype toegelaten is. De beperkingen die de media instellingen
opleggen zijn nodig om mogelijk gevaarlijke bestanden te weren, zoals HTML of
PHP bestanden. Zie het hoofstuk
Beperkingen hierboven.
- De tweede plugin ’Button - AddAttachment’ laat u toe om
bijlagen toe te voegen terwijl u het artikel bewerkt. Inden deze plugin
geactiveerd is, wordt de knop Voeg bijlage toe toegevoegd onder het
tekstgebied waar u het artikel kan aanpassen.
Merk wel op dat de knop niet getoond kan worden wanneer het artikel aangemaakt
wordt en nog niet bewaard is: in dat geval kunnen bijlagen nog niet gelinkt
worden aan het artikel, omdat ze nog niet bekend is bij de achterliggende
database.
- Deze versie lijkt goed te werken met SEF & Joomla! 1.5 RC3 & RC4. Er zijn
wel problemen gekend met SEF & 1.5 RC2.
[Index]
Upgraden
Indien u al bestanden heeft toegevoegd aan artikels, voor de installatie van
een nieuwe versie, kunt u het volgende doen om deze bijlagen te behouden:
- Bewaar de inhoud van de tabel
jos_attachments
(u kan hiervoor
Export
functie van
phpMyAdmin
gebruiken, of een gelijkaardige functie in een ander MySQL programma).
Opgelet! Vink bij de functie Export
onder data
zeker Complete inserts
aan, en vink zeker Extended inserts
uit.
- Deïnstalleer de ’Attachments’ component.
- Deïnstalleer de ’Attachments’ plugins.
- Installeer de nieuwe ’Attachments’ plugins.
- Installeer de nieuwe ’Attachments’ component.
- Activeer de ’Attachments’ plugins.
- Gebruik uw SQL programma om de data van de bewaarde tabel naar de nieuw
aangemaakte tabel
jos_attachments
te kopieren.
- Indien u upgrade van een versie ouder dan 1.0, dient u de juiste
verwijzingen naar de pictogrammen nog toe te voegen in de database. Dit kan u
doen door in de back-end als super-administrator in te loggen en daarna de
volgende URL in te geven: /administrator/index.php?option=com_attachments&task=add_icon_filenames
Merk op dat het deïnstalleren van de ’Attachments’ extensie
de bestanden zelf in de bijlage folder niet verwijderd, alleen de referenties
er naar in de database. Alle referenties naar die bestanden worden bewaard in
de tabel jos_attachments
.
Het kan ook zijn dat u niet wil dat tabel in de database weer hersteld wordt.
De bijhorende bestanden zitten dan nog steeds in uw bijlage folder zitten.
Vergeet dan zeker niet deze te verwijderen.
[Index]
Dankwoord
Een woord van dank aan:
- Het boek Learning Joomla! 1.5 Extension Development: Creating Modules,
Components, and Plugins with PHP, door Joseph L. LeBlanc. Het was (is)
zeer nuttige lectuur bij het maken van deze extensie.
- De pictogrammen zijn afgeleid van verschillende bronnen, waaronder:
De meeste pictogrammen die ’Attachments’ gebruikt zijn aangepast
en verschillen van het origineel. Indien u de originele pictogrammen wilt,
kunt u ze afhalen van de bovenvermelde websites.
[Back to top]
Fouten, opmerkingen en suggesties worden graag behandeld door
jmcameron@jmcameron.net.