Přeskočit na obsah

Šablona:Podstránka s dokumentací/doc

Z Wikicest

Šablona {{Podstránka s dokumentací}} na začátek /doc podstránky přidá upozornění, že jde o dokumentační podstránku i s odkazem na samu šablonu, jak je vidět výše i zde na této /doc podstránce samotné.

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

Použití

[editovat]

Pokud např. dokumentujete šablonu Šablona:Hypotetická, pak závěr její noinclude části bude obsahovat volání {{Dokumentace}} (podrobnosti umístění kódu vizte tam) a první řádek dokumentační podstránky Šablona:Hypotetická/doc bude obsahovat tuto pomocnou šablonu. Obvykle se na úplný začátek /doc stránek vkládá tento kód:

{{Podstránka s dokumentací}}<!--  KATEGORIE PROSÍM PŘIDÁVEJTE AŽ NA KONEC STRÁNKY  -->

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}}.

Zmiňované kategorie pak přijdou na spodek dokumentace:

<includeonly><!--  KATEGORIE PŘIDÁVEJTE SEM, DĚKUJEME  -->

</includeonly>

Automatická kategorizace

[editovat]

Další funkcí šablony {{Podstránka s dokumentací}} je, že vytvořenou /doc podstránku sama zařadí do kategorie dokumentací šablon.

Související šablony

[editovat]
  • {{Dokumentace}} – Zpětný odkaz z šablony samotné na dokumentační podstránku, vzájemně se doplňující šablony.