Dokumentace

Tato dokumentace je sem přenesena z podstránky Šablona:Dokumentace/doc. (historie/editace)

Šablona:Dokumentace je šablona určená k vkládání dokumentace k šablonám.

Tato šablona byla přenesena a upravena z české wikipedie, kde patří ke standardním dokumentačním šablonám.

Smyslem použití zvláštní dokumentační stránky (což umožňuje tato šablona) je oddělit vlastní kód šablony od dokumentace šablony. Popis a dokumentace šablony tak může být upravován bez toho, že by hrozilo zanesení chyby do kódu vlastní šablony (ten lze případně později i uzamknout).

Použití

Běžné

<noinclude>{{dokumentace}}</noinclude>

nebo

<noinclude>{{dokumentace|šablona:nějaká stránka/doc}}</noinclude>

Jednu z variant výše uvedeného kódu připojte na spodek kódu dokumentované šablony tak, aby mezi kódem šablony a připojeným kódem, začínajícím "<noinclude>", nebyla žádná mezera. Optimálně celou vaši šablonu zakončete (včetně komentáře pro jiné) touto neměnnou posloupností:

[--poslední řádek kódu vaší šablony--]<noinclude>
{{Dokumentace}}
<!-- KATEGORIE a INTERWIKI, PROSÍME, PŘIDÁVEJTE DO /doc PODSTRÁNKY. DĚKUJEME -->
</noinclude>

Pokud mezeru ponecháte, způsobí to výskyt této mezery na všech stránkách, ve kterých je vaše šablona použita.

Druhou variantu s parametrem můžete využít pro přesné určení jakékoliv dokumentační stránky namísto implicitní podstránky /doc.

Ani kategorie nebo odkazy interwiki, patřící k dokumentované šabloně, se nezapisují do stránky šablony, ale rovněž do dokumentační podstránky, mezi značky includeonly na jejím závěru.

Dokumentační příklady výpisů zdrojového kódu obalte <code>[kus kódu]</code>, tím ho typograficky odlišíte. Pokud dokumentační stránka šablony obsahuje XML značky jako např. <includeonly> nebo <noinclude> jako součást dokumentace, nahraďte znak "<" znakovou entitou "<".

Úprava zobrazení

Varianta override existuje pro úpravu výstupu ve zvláštních případech:

{{dokumentace|heading=}}: změní text nadpisu "dokumentace". Pokud je položka ponechána prázdná, pak zmizí i celý nadpisový řádek, včetně prvního odkazu [edit].

Funkce

Pokud dokumentační podstránka či stránka šablony neexistuje, pak odkaz "editace" v první řádce dokumentace zahrne parametry preload, takže jeho prokliknutí předvyplní editační formulář základním formátem dokumentační stránky.

Účel

Tato šablona umožňuje k jakékoliv stránce (zejména šabloně) použít dokumentační stránku a umožňuje chránit takové stránky (šablony) při zachování možnosti editovat dokumentaci šablony, kategorie a odkazy interwiki. Rovněž snižuje nároky na zdroje serveru Wikipedie.

Viz rovněž

Zpětný odkaz z dokumentační podstránky na šablonu samotnou: {{Podstránka s dokumentací}}, vzájemně se doplňující šablony.

Nápověda k dodělání

Tento seznam bude upraven po vytvoření českých ekvivalentů:

{{en:Template:tiw}}, template doc (similar template with more documentation; see template comparison)
{{en:Template:tiw}}, documentation subpage (replaces older {{Template doc page viewed directly}} and {{Template doc page transcluded}})
{{en:Template:tim}}, Documentation

w:en:Template:Documentation