Šablona:Podstránka s dokumentací/doc

Toto je dokumentační podstránka šablony Šablona:Podstránka s dokumentací.

Vedle návodu k použití obsahuje kategorie, odkazy interwiki a další obsah, který není součástí kódu šablony.

Šablona {{Podstránka s dokumentací}} na začátku podstránky /doc přidává upozornění, že jde o obsah dokumentační podstránky, jehož součástí je také link na šablonu, jak je vidět výše i zde. Tahle šablona se tedy vzájemně doplňuje s šablonou {{Dokumentace}}.

Pro složité šablony zde existuje ještě jedna šablona {{Složitá šablona}}, která generuje varování pokud je šablona pro běžného uživatele příliš složitá.

Použití

Pokud chcete dokumentovat např. šablonu Šablona:Hypotetická, pak na závěr kódu šablony přidáte párový tag <noinclude> který bude obsahovat šablonu {{Dokumentace}}

Na prvním řádku dokumentační podstránky Šablona:Hypotetická/doc pak umístěte odkaz na tuto pomocnou šablonu, a upozornění pro budoucí editory. Viz příklad

 {{Podstránka s dokumentací}}
 <!-- KATEGORIE a odkazy do INTERWIKI, přidávejte až na spodek této stránky. Děkujeme! -->
 

Tento text však není třeba kopírovat ručně: Vhodný rámec dokumentační podstránky se tvoří automaticky už při jejím založení, a to na šabloně linkem, který vkládá právě {{Dokumentace}}.

Kategorie a interwiki pak přijdou na konec dokumentace:

 <includeonly>
 <!-- KATEGORIE a odkazy do INTERWIKI, přidávejte sem -->

 </includeonly>
 

Další funkcí šablony {{Podstránka s dokumentací}} je, že šablonu k níž je přidaná /doc podstránka zařadí do přidaných kategorií. Tyto kategorie a odkazy do interwiki je však třeba uzavřít do párového tagu <includeonly>, protože jinak by byla přiřazena do těchto kategorií kromě šablony i podstránka s dokumentací.