Nápověda:Jak dokumentovat šablony

From thewoodcraft.org
Jump to navigation Jump to search
Přehled nápovědy
Editace obsahu
Pro thewoodcraft.org
Knihy
Systém wiki
Zabezpečení stránek
Zásady
Upozornění 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

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:

Poznámka
<noinclude>{{Dokumentace}}</noinclude>
Upozornění 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

Každá dokumentace k šabloně musí obsahovat následující:

  1. Popis šablony - co dělá, k čemu slouží, pro jaký účel byla vytvořena
  2. Syntaxe - jak má vypadat zápis šablony, případně jaké lze u ní použít parametry
  3. Použití - ukázka interpretace šablony
  4. Kategorie - i šablony musí být odpovídajícím způsobem kategorizovány
PoznámkaU 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

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
Šablona, která je závislá na některém z rozšíření 
se přidá do kategorie šablon které používají příslušného rozšíření např. Kategorie:Šablony užívající ParserFunctions
Poznámka
<noinclude>
[[Kategorie:Šablony]]
[[Kategorie:Výstražné šablony]]
{{Dokumentace}}
</noinclude>

Samotná podstránka s dokumentací se zařadí do kategorie Kategorie:Šablony (dokumentace).

Poznámka
[[Kategorie:Šablony (dokumentace)]]

Dokumentace podstránek

Se provádí stejně jako u šablony, ovšem