Šablona:Upravit dokumentaci

Dokumentace  

Pro šablony s nevysvětleným účelem nebo používající parametry, které ale nejsou uvedeny, popř. nemají vysvětleno, co je jejich účel nebo jak tyto parametry použít. U složitějších šablon v případech, kde chybí názorné ukázky vložení. Zdokumentováno má být obojí: „proč“ i „jak“.

Použití

Šablonu je vždy nutné vkládat na začátek šablony do <noinclude></noinclude>.

<noinclude>{{upravit dokumentaci}}</noinclude>

Paramety

|poznámka nebo komentář – volitelný parametr pro poznámky, vyjmenování konkrétních problémů

Účinek

Šablona automaticky vkládá články do Kategorie:Údržba:Šablony s dokumentací k úpravě.

Příklady

<noinclude>{{upravit dokumentaci}}</noinclude>

<noinclude>{{upravit dokumentaci|popsat parametry, prázdná šablona k vložení, vyjmenovat vkládané kategorie, ukázat použití}}</noinclude>

<noinclude>{{upravit dokumentaci|založit dokumentaci, přesunout kategorie do dokumentace}}</noinclude>

Data šablony

Tato sekce obsahuje strukturovaný popis parametrů této šablony využívající rozšíření TemplateData, který umožňuje snadnější používání této šablony v prostředí Vizuálního editoru.

Upravit dokumentaci

Šablona slouží k označení šablon potřebujících založení či upravení dokumentace. Vkládá se na začátek kódu šablony do <noinclude></noinclude>.

Parametry šablony[Upravit strojový popis šablony]

Tato šablona upřednostňuje parametry formátované v jediném řádku.

Parametr		Popis	Typ	Stav
Poznámky	poznámky komentář 1	Parametr slouží k vyjmenování konkrétních problémů Příklad založit dokumentaci, přesunout kategorie do dokumentace	Obsah	doporučený