Šablona:Podstránka s dokumentací

Z DCEwiki
Přejít na: navigace, hledání

[editovat]

Template-info.svg Dokumentace


MediaWiki:Image:Information icon with gradient background.svg Tato šablona používá velmi složitou syntaxi nebo funkce parseru.

Nepokoušejte se kód měnit, nejste-li si naprosto jisti, co děláte; pokud editace způsobí nečekané následky, urychleně ji vraťte. Veškeré experimenty byste měli provádět na pískovišti nebo ve svém uživatelském prostoru a nikoli zde.


Šablona:Podstránka s dokumentací na začátku /doc podstránky přidává upozornění, že jde o obsah dokumentační podstránky a u něj také link na tu tuto podstránku, jak je vidět výše i zde.

Šablona se vzájemně doplňuje s šablonou {{Dokumentace}}.

Použití[editovat]

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

Poznámka
 {{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:

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

 </includeonly>
 


Poznámka 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í.