Šablona:Podstránka s dokumentací

Z VarenWiki
Verze z 3. 5. 2018, 15:00, kterou vytvořil Rataj (diskuse | příspěvky) (Založena nová stránka s textem „<!-- přímo na Šablona:Podstránka s dokumentací se nezobrazí, ale ukáže ji její /doc -->{{#ifeq: {{lc:{{#TITLEPARTS:{{FULLPAGENAME}}||-1}}}} | {{{o…“)
(rozdíl) ← Starší verze | zobrazit aktuální verzi (rozdíl) | Novější verze → (rozdíl)
Přejít na: navigace, hledání
ikona
Tato šablona je velmi často použita (i dalšími šablonami).
Každá změna se tak projeví na mnoha místech. Editujte ji s maximální obezřetností, jen pokud víte jistě, co děláte. Pokud úprava způsobí nečekané následky, urychleně ji vraťte. Veškeré experimenty byste měli raději provádět na pískovišti nebo ve svém uživatelském prostoru.
ikona
Tato šablona používá velmi složitý zápis nebo funkce parseru.
Editujte ji s maximální obezřetností, jen pokud víte jistě, co děláte. Pokud úprava způsobí nečekané následky, urychleně ji vraťte. Veškeré experimenty byste měli raději provádět na pískovišti nebo ve svém uživatelském prostoru.

Š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í

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>

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

Související šablony

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

Související články

Citováno z „https://varen.cz/wiki/index.php?title=Šablona:Podstránka_s_dokumentací&oldid=17“