Nápověda:Jak dokumentovat šablony
Nápověda:Jak dokumentovat šablony
Každá šablona by měla být náležitě zdokumentována a kategorizována, aby bylo zřejmé jakým způsobem a pro jaký účel ji lze použít. Vlastní dokumentace se ovšem neprovádí v obsahu šablony, ale na samostatné podstránce. V šabloně je nutné pouze bezprostředně za vlastní obsah šablony vložit následující řetězec:
|
<noinclude>{{Dokumentace}}</noinclude>
|
|
Pozor na odřádkování! U šablon může v takovém případě docházet k nežádoucí interpretaci. |
Dokumentace se šablony se pak provede na podstránce Doc k šabloně. Na ni se lze dostat přímo ze šablony kliknutím na příslušný odkaz.
Náležitosti dokumentace
Každá dokumentace k šabloně musí obsahovat následující:
- Popis šablony - co dělá, k čemu slouží, pro jaký účel byla vytvořena
- Syntaxe - jak má vypadat zápis šablony, případně jaké lze u ní použít parametry
- Použití - ukázka interpretace šablony
- Kategorie - i šablony musí být odpovídajícím způsobem kategorizovány
U komplikovaných šablon je vhodné vložit hned na počátku obsahu dokumentace do párového tagu noinclude šablonu {{Složitá šablona}}, aby byl každý předem varován, že nežádoucí úpravou šablony může dojít k narušení její funkcionality