Wikipedia:Sjabloondocumentatie beheren

Dit is een concept hulp- of instructiepagina bij het gebruik van de TemplateData-editor middels de knop Sjabloongegevens bewerken. Deze knop zie je bij het bewerken van sjablonen (pagina's in de Sjabloon-naamruimte). De tool voegt zogeheten TemplateData toe aan de sjabloon. De Visuele tekstverwerker gebruikt deze TemplateData bij het invoegen van een sjabloon.

Instructies

Het toevoegen van sjabloondocumentatie kan gedaan worden in het bewerkingsscherm van een sjabloonpagina. Bovenaan verschijnt een knop 'Sjabloongegevens bewerken'. Het is verleidelijk om direct op deze knop te klikken, maar doe dat niet; voeg eerst het volgende toe boven de sluitende accolades }} van de Sjablooninfo:

== TemplateData ==
<templatedata>
</templatedata>

Dus zo:

{{Sjablooninfo|1=
... overige sjablooninfo ...

== TemplateData ==
<templatedata>
</templatedata>
}}

Druk pas daarna op de knop 'Sjabloongegevens bewerken'. De TemplateData komt dan op de juiste plaats en volgens correcte JSON-specificatie. Het voorgaande gaat er van uit dat er reeds Sjablooninformatie op de sjabloonpagina staat. Is op de sjabloonpagina nog geen Sjablooninfo ingevoegd, voeg dan Sjablooninfo toe conform de instructies op {{Sjablooninfo}}. Let op dat de sjablooncategorieën binnen het paar <noinclude> </noinclude> staan, om te voorkomen dat de pagina's waarin de sjabloon getranscludeerd worden in de sjablooncategorieën terechtkomen.

Bovenstaande methode voorkomt dat er onbedoeld witruimte op een artikel wordt geïmporteerd, door de witruimte die de TemplateData-editor anders voor de <noinclude> rond de TemplateData invoegt. De <noinclude> dient zonder witruimte (spatie en/of nieuwe regel) aan te sluiten op de voorgaande tekst in de sjabloon.

Achtergrond

Gewenste raamwerk zonder TemplateData

<includeonly>
... dat wat getranscludeerd dient te worden ...
</includeonly><noinclude>{{Sjablooninfo|1=
== Doel ==
...

== Gebruik ==
...

== Voorbeeld ==
...
}}

[[Categorie:Wikipedia:(sjablooncategorienaam)]]
</noinclude>

Gewenste raamwerk met TemplateData

<includeonly>
... dat wat getranscludeerd dient te worden ...
</includeonly><noinclude>{{Sjablooninfo|1=
== Doel ==
...

== Gebruik ==
...

== Voorbeeld ==
...

== TemplateData ==
<templatedata>
{
... de JSON-specificatie van de TemplateData ...
}
</templatedata>
}}

[[Categorie:Wikipedia:(sjablooncategorienaam)]]
</noinclude>

Zoals de TemplateData-editor het invoegt

<includeonly>
... dat wat getranscludeerd dient te worden ...
</includeonly><noinclude>{{Sjablooninfo|1=
== Doel ==
...

== Gebruik ==
...

== Voorbeeld ==
...
}}

[[Categorie:Wikipedia:(sjablooncategorienaam)]]
</noinclude>

<noinclude>
<templatedata>
{
... de JSON-specificatie van de TemplateData ...
}
</templatedata>
</noinclude>

Drie ongewenste dingen heeft dit tot gevolg:

1. Met de TemplateData-editor komt de TemplateData als blok na de categorieën, terwijl gewenst is deze voor de categorieën te hebben.
2. Er komt een </noinclude> <noinclude> paar met witruimte ertussen; dat leidt tot transclusie van witruimte in een artikel waar de sjabloon gebruikt wordt.
3. De TemplateData komt nog niet binnen het raamwerk van de Sjablooninfo op de sjabloonpagina, in het bijzonder ontbreekt het kopje == TemplateData ==.