Sjabloon:Sjablooninfo

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

{{{1}}}

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

Doel

Dit sjabloon kan worden gebruikt voor het toevoegen van informatie over het doel en gebruik van een sjabloon op Wikipedia. Tevens dient het ervoor om een scheiding aan te brengen tussen een sjabloon en de informatie over het gebruik die niet wordt meegenomen als een sjabloon wordt geplaatst.

Gebruik

Het sjabloon kan worden gebruikt met één parameter en dient tussen <noinclude> en </noinclude> gezet te worden. De <noinclude> dient direct achter het laatste teken te komen en niet op een eigen regel omdat dat meestal opmaakproblemen geeft. Op de plaats van de puntjes dient de sjablooninformatie ingevoegd te worden:

<noinclude>{{Sjablooninfo|1=
== Doel ==
...

== Gebruik ==
...
}}
</noinclude>

Standaard gebruiken we daar altijd de volgende onderdelen:

• Doel
• Gebruik

En eventueel:

• Voorbeeld

In de sectie Gebruik wordt er een leeg parameteroverzicht getoond die gebruikers eenvoudig kunnen kopiëren en plakken in het artikel om het aldaar in te vullen.

Andere kopjes

Naast deze parameters komen in de sjabloonuitleg ook andere kopjes voor waar die zinvol zijn, waaronder bijvoorbeeld:

• Kopjes met specifieke uitleg over bepaalde parameters van het sjabloon
• Aanbeveling - hoe een sjabloon gebruikt dient te worden
• Categorieën - welke categorieën worden er wanneer ingevoegd
• Parameteroverzicht - geeft een overzicht van de parameters met uitleg, omschrijving en meer
• TemplateData - onder dit kopje wordt code toegevoegd om de sjabloonmodule (TemplateData) van de visuele tekstverwerker te laten werken
• Gebruikte afbeeldingen - toont met behulp van Sjabloon:Ontlinkte afbeelding de in het sjabloon gebruikte afbeeldingen die linken naar iets anders dan de bestandspagina
• Gebruikte sjablonen - overzicht van hulpsjablonen die in de broncode van het sjabloon ingevoegd zijn
• Zie ook - geeft relevante links en verwante sjablonen), Referenties (toont de referenties die een sjabloon soms mede invoegt in een artikel

Tabel

Op zich gebruiken we meestal eerder een opsomming, maar indien er binnen dit sjabloon een tabel ingevoegd moet worden dienen alle pipes van de tabel vervangen te worden door het sjabloon {{!}}, omdat anders deze pipes gezien worden als het begin van een nieuwe parameter.

Vergelijking met Sjabloon:Sjabdoc

Sjabloon:Sjablooninfo heeft de voorkeur bij gebruik omdat bij het wijzigen van het sjabloon meteen de documentatie aangepast kan worden, maar heeft in sommige gevallen een alternatief: Sjabloon:Sjabdoc. Dit sjabloon werkt met aparte /doc pagina's, zie voordeel. Stijl van dat sjabloon: Sjabloon:Sjabdoc