Sjablonen zijn een krachtig hulpmiddel van de MediaWiki-software, maar zijn voor nieuwe en zelfs voor ervaren gebruikers soms moeilijk te begrijpen.
Overzicht beheerpagina's |
---|
Om bij een sjabloon door de wikicode te moeten lopen om uit te vinden hoe het precies werkt zou daarnaast een tijdrovende klus zijn. Daarom is het zaak sjablonen goed te documenteren om zo de bruikbaarheid en toegankelijkheid te verbeteren. De documentatie moet duidelijk uitleggen wat het sjabloon doet en hoe het werkt. Een gebruiker zonder al te veel kennis van de syntaxis van sjablonen zou aan de hand van de documentatie het sjabloon correct moeten kunnen gebruiken.
Sjabloondocumentatie zou tenminste één, maar liever meerdere van de volgende punten moeten bevatten:
Voor de weergave van de documentatie wordt sjabloon {{Documentatie}} gebruikt. Plaats dit sjabloon onderaan het te documenteren sjabloon, tussen
-tags. Dit laatste zorgt ervoor dat de documentatie niet wordt getoond op pagina's waar het sjabloon gebruikt wordt, maar alleen zichtbaar is op de sjabloonpagina zelf. De documentatie plaats je in de eerste parameter van Documentatie. Dat ziet er dan als volgt uit:
Het sjabloon Documentatie zorgt ervoor dat de documentatie in een duidelijk van het sjabloon te onderscheiden box komt te staan. Plaats de openende
-tag vlak achter de sjablooninhoud en niet op een nieuwe regel. De nieuwe regel zou anders terechtkomen op pagina's waar het sjabloon gebruikt wordt en dat is meestal onwenselijk. Plaats de categorieën van het sjabloon buiten het Documentatie-sjabloon, maar bínnen de
-tags.
Bovenstaande methode is de aanbevolen manier. Het heeft als voordeel dat er geen aparte pagina aangemaakt hoeft te worden en de documentatie en het sjabloon overzichtelijk bij elkaar te vinden zijn. In sommige gevallen is het echter wenselijk of noodzakelijk de documentatie op een aparte pagina te plaatsen. Voorbeelden van zulke situaties zijn:
|
of het magic word {{!}}
. Zeker bij grotere tabellen kan dat onhandig zijn.In dergelijk gevallen kan voor de documentatie een subpagina van het sjabloon worden aangemaakt met de naam /doc. Bovenaan de subpagina wordt het sjabloon {{Doc subpagina}} geplaatst, om aan te geven dat het om een documentatiepagina gaat. Plaats vervolgens onderaan de sjabloonpagina het Documentatie-sjabloon, maar nu zonder parameters. De documentatie op de subpagina verschijnt vanzelf in de box op de sjabloonpagina.
Let op: De categorieën van het sjabloon horen altijd op de sjabloonpagina, niet op de /doc-pagina.
Voor groepen van sjablonen met eenzelfde functionaliteit is het aan te raden één documentatiepagina aan te maken en deze te delen met de verschillende sjablonen. Gebruik hiervoor de parameter |pagina=
van sjabloon Documentatie en vul deze op elk van de te documenteren sjablonen in met de naam van de gedeelde pagina:
In de box wordt de inhoud van de opgegeven pagina getoond.
Plaats de gedeelde documentatiepagina in Categorie:Wikipedia:Sjablonen gedeelde documentatie.
-tags.This article uses material from the Wikipedia Nederlands article Wiki:Sjabloondocumentatie, which is released under the Creative Commons Attribution-ShareAlike 3.0 license ("CC BY-SA 3.0"); additional terms may apply (view authors). De inhoud is, tenzij anders aangegeven, beschikbaar onder CC BY-SA 4.0 Images, videos and audio are available under their respective licenses.
®Wikipedia is a registered trademark of the Wiki Foundation, Inc. Wiki Nederlands (DUHOCTRUNGQUOC.VN) is an independent company and has no affiliation with Wiki Foundation.