Sjabloon:Documentatie

Sjabloondocumentatie​[bekijk] [bewerk] [ververs] [geschiedenis]

Deze sjabloon wordt gebruikt voor de documentatie van pagina's, vooral van sjablonen. Het plaatst de documentatie in een omrande, gele box, zoals die waar je nu naar kijkt. Het sjabloon wordt voornamelijk gebruikt voor de documentatie van sjablonen, maar kan ook voor andersoortige documentatie, in andere naamruimten gebruikt worden.

Voor uitleg over de inhoud van sjabloondocumentatie, zie Wikipedia:Sjabloondocumentatie.

Gebruik

Het sjabloon wordt gebruikt met één parameter waarin de documentatie wordt geplaatst, aan het eind van de sjabloonpagina:

<!-- Laatste regel sjablooncode. --><noinclude>
{{Documentatie|1=
<!--
    Plaats hier de documentatie.
-->
}}

[[Categorie:Wikipedia:Sjablonen ...]]
</noinclude>

Plaats de <noinclude> direct achter de sjablooncode, op dezelfde regel. Dit voorkomt mogelijk ongewenste witruimte op plekken waar het sjabloon gebruikt wordt.

Plaats categorieën buiten het sjabloon, maar bínnen de <noinclude>-tags.

Opmerkingen

Een verticale streep ("|") mag in de documentatie alleen binnen 2- en 3-voudige accolades voorkomen, omdat de hele tekst als parameterwaarde wordt gebruikt. Gebruik daarom in de overige gevallen | of het magic word {{!}}.

Als de documentatie <includeonly>- of <noinclude>-tags binnen <nowiki>-tags bevat, vervang dan < door <.

Aparte docpagina

Hoewel het niet is aanbevolen, kan het soms wenselijk zijn om de documentatie op een aparte pagina te hebben staan. Gebruikelijk is het in dat geval om die op een subpagina van het sjabloon te plaatsen met de naam /doc. Zie Wikipedia:Sjabloondocumentatie voor wanneer je een /doc-subpagina het best kunt gebruiken en wat de voor- en nadelen daarvan zijn.

Documentatie wordt dan gebruikt zonder parameters:

<!-- Laatste regel sjablooncode. --><noinclude>
{{Documentatie}}

[[Categorie:Wikipedia:Sjablonen ...]]
</noinclude>

Als de subpagina bestaat wordt de inhoud ervan automatisch in de box getranscludeerd. Daarnaast worden er bovenaan vier links getoond ( [bekijk] [bewerk] [ververs] [geschiedenis] ) die linken naar de /doc-pagina.

Als de documentatie op een andere pagina staat dan de /doc-subpagina, kan |pagina= gebruikt worden, als volgt:

{{Documentatie|pagina=Sjabloon:Naam van gedeelde docpagina}}

Dit is met name handig voor gedeelde documentatie. Ook hier verschijnen er vier links.

Kop

Met |kop= kan een alternatieve kop gekozen worden. In de sjabloon- en modulenaamruimte is de kop standaard Sjabloondocumentatie respectievelijk Moduledocumentatie. In alle andere naamruimten is deze standaard Documentatie.

Als deze parameter wel gedefinieerd is, maar leeg is, wordt de gehele kop weggelaten (inclusief afbeelding en eventuele links).

Parameteroverzicht

1

De documentatie.

pagina

De volledige naam van een pagina waarvan de inhoud in de box getranscludeerd moet worden. Als het de /doc-subpagina betreft, laat deze dan leeg.

kop

Kop bovenaan de box.

Zie ook

• Wikipedia:Sjabloondocumentatie - Uitleg over de opbouw van sjabloondocumentatie.
• {{Doc subpagina}} - Te plaatsen op /doc-subpagina's. Geeft aan dat de inhoud van die pagina documentatie is en linkt naar het gedocumenteerde sjabloon.
• Categorie:Wikipedia:Sjablonen sjabloondocumentatie - Sjablonen die gebruikt kunnen worden voor de documentatie.
• (en) Uitleg <noinclude>-tags.
• Sjabloon:Documentatie/preload

Voetnoot