Nápověda:Jak dokumentovat šablony
|
Každá šablona musí být náležitě zdokumentována a kategorizována, aby bylo zřejmé jakým způsobem a pro jaký účel se může použít. |
Dokumentace šablony[edit]
Vlastní dokumentace šablony se neprovádí v obsahu šablony, ale na samostatné podstránce.
Do šablony se pouze bezprostředně za vlastní obsah šablony vloží následující řetězec:
|
<noinclude>{{Dokumentace}}</noinclude>
|
|
|
Pozor na odřádkování! U některých šablon může v takovém případě docházet k nežádoucí interpretaci. |
Zápis dokumentace k šabloně se pak provádí na její podstránce Doc. Tu lze zavolat buď přímo z URL, nebo kliknutím na příslušný odkaz v šabloně, která má vloženou šablonu {{Dokumentace}}.
Náležitosti dokumentace[edit]
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
|
Kategorizace šablony[edit]
Kategorizace šablon se provádí výhradně se prostřednictvím dokumentační podstránky /Doc
- Každá šablona, která není podstránkou
- se zařadí do kategorie Kategorie:Šablony.
- Šablona, která je sama podstránkou nějaké šablony nebo je na nějaké jiné šabloně závislá
- se zařadí do kategorie Kategorie:Šablony závislé
- Šablona, která má na něco upozornit, či před něčím varovat
- se přidá do kategorie Kategorie:Výstražné šablony
Níže uvedený příklad má výsledný efekt takový, že jak stránka s dokumentací, tak vlastní šablona jsou zařazeny do kategorie Kategorie:Šablony, ale samotná šablona je navíc zařazená do kategorie Kategorie:Výstražné šablony.
|
|
[[Kategorie:Šablony]]
<includeonly>
[[Kategorie:Výstražné šablony]]
<includeonly>
|
Dokumentace podstránek[edit]
Se provádí stejně jako u šablony, ovšem
