Nápověda:Jak dokumentovat šablony

Přehled nápovědy
Nastavení práv pro mediawiki Registrace účtu a přihlášení
Editace obsahu
Nápověda:Jak editovat stránku Nápověda:Jak smazat stránku nebo soubor Nápověda:Kategorizace Nápověda:Jak psát správně odkazy Multijazyčné odkazy na stránky Nápověda:Jak kombinovat stránky Nápověda:Jak používat šablony Nápověda:Jak dokumentovat šablony Nápověda:Widgety Nápověda:Systémové proměnné a jejich použití Nápověda:Jazykové mutace stránek Nápověda:Jak pracovat s tabulkami Nápověda:Grafy a diagramy Nápověda:Jak pracovat s obrázky Nápověda:Jak vkládat do wiki soubory Nápověda:Jak psát poznámky pod čarou Navigace pro související stránky
Pro thewoodcraft.org
Nápověda:Dynamicky generované stránky Nápověda:Rozcestníky a redirekty Nápověda:Webliografie článků
Knihy
Nápověda:Jak dělat správně korektury Nápověda:Jak pracovat s knihami Nápověda:Jak sestavit knihu
Systém wiki
Nápověda:Jmenné prostory a jejich význam Nápověda:Údržba a kontrola Nápověda:Navigační panel Nápověda:Komunikace mezi uživateli wiki
Zabezpečení stránek
Nápověda:Jak omezit přístup ke stránce Nápověda:Jak získat přístup do databáze
Zásady
Časté chyby Etiketa na wiki Jak používat diskuzi Autorská práva

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:

<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

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

<img src="https://disklessui.kapica.cz/wiki/images/0/02/Poznamka.svg" width="5%" resource="./File:Poznamka.svg" style="float: right; margin: 15px 0px 15px 15px;" alt="Poznámka" title="Poznámka">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

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

<noinclude>
[[Kategorie:Šablony]]
[[Kategorie:Výstražné šablony]]
{{Dokumentace}}
</noinclude>

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

[[Kategorie:Šablony (dokumentace)]]

Dokumentace podstránek

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