Šablóna:Documentation/doc
Šablona:Dokumentace je šablona pro dokumentaci jiných šablon.
Tato šablona automaticky zobrazuje pod znázorněním šablony obdélník s dokumentací (např. takovou, jakou vidíte), jejíž obsah je přenesen z jiné stránky. Je určena pro stránky, které jsou přenášeny do ostatních stránek (tj. šablon), ať již se ve jmenném prostoru šablon nachází, nebo nikoliv.
Tato šablona je přenesena a upravena z anglické wikipedie.
Smyslem použití zvláštní dokumentační stránky (pomocí této šablony) je oddělit vlastní kód šablony od dokumentace šablony. Zlepšování dokumentace šablony editací se tak může dít bez ohrožování zápisu kódu vlastní šablony (ten lze případně později i uzamknout), popř. je zápis šablony aspoň jasně oddělen od dokumentace.
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, PROSÍME, PŘIDÁVEJTE DO PODSTRÁNKY /doc. 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.
Ani kategorie, patřící k dokumentované šabloně, se nezapisují do stránky šablony, ale až 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 "<“.
Dokumentace odjinud
|1=\n\n\n\n\n\n"
}
</templatedata></noinclude> nepojmenovaný parametr pro výslovné určení jiné dokumentační stránky než implicitní podstránky /doc.
Do kódu jiné podstránky například {{Dokumentace|{{NAMESPACE}}:{{BASEPAGENAME}}/doc}}.
Úprava zobrazení
Varianta override existuje pro úpravu výstupu ve zvláštních případech:
- {{Dokumentace|nadpis=}}: 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, zobrazí se pouze hláška s odkazem na vytvoření dokumentace, který zahrnuje parametry preload. Jeho prokliknutí pak při založení podstránky s dokumentací předvyplní editační formulář základním formátem dokumentační podstránky.
V případě, že k šabloně existují také podstránky /pískoviště a /test, šablona v úvodu zobrazí také informaci o jejich existenci a doporučení využít je při úpravách.
Úč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, typicky kategorie. Rovněž snižuje nároky na zdroje serveru Wikipedie.
Související šablony
- {{Podstránka s dokumentací}} – Zpětný odkaz z dokumentační podstránky na šablonu samotnou, 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
