Sjabloon:Sjabdoc

Uit Wikipedia, de vrije encyclopedie
Ga naar: navigatie, zoeken
[bekijk] [bewerk]Template-info.svg Sjabloondocumentatie

Deze sjabloon wordt gebruikt voor de documentatie van sjablonen. Aangezien de sjabloon ook op zichzelf is toegepast, kan hier het resultaat worden gezien.

Gebruik

Plaats aan het eind van de sjabloonpagina[1]:

''[--laatste regel sjablooncode--]''<noinclude>
<!--
    Hier geen documentatie, plaats die in de /doc
-->
{{sjabdoc}}
<!--
    Plaats hier de categorieën en interwiki's.
-->
</noinclude>

Plaats de <noinclude> direct achter de sjablooncode, op dezelfde regel.

Als deze sjabloon wordt toegepast op een bestaande sjabloon, verplaats dan de documentatie naar de /doc pagina. Plaats de categorieën van het sjabloon tevens op de /doc-pagina tussen <noinclude> en </noinclude>.

Via de bewerk-link kan de /doc subpagina bewerkt worden. Als deze nog niet bestaat wordt de starttekst Sjabloon:Sjabdoc/preload automatisch geladen.

Voordeel

Voordeel boven andere methoden, waaronder Sjabloon:Sjablooninfo:

  • Een sjabloon kan beveiligd worden terwijl de documentatie te bewerken blijft.

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 &#124;.

Als de documentatie includeonly- of noinclude-tags binnen nowiki-tags bevat, vervang dan "<" door "&lt;".

Vergelijking met Sjabloon:Sjablooninfo

Sjabloon:Sjablooninfo wordt standaard gebruikt en heeft de voorkeur als het sjabloon niet beveiligd is. Het heeft als voordeel dat niet persé een aparte pagina aangemaakt hoeft te worden en de documentatie en het sjabloon overzichtelijk bij elkaar te vinden zijn.

Stijl van die sjabloon:


De sjabloonbeschrijving hieronder wordt niet afgebeeld wanneer het sjabloon wordt geplaatst.

{{{1}}}

Voetnoot

  1. Let op, de Engelse Wikipedia heeft andere conventies.