Šablona:Dokumentace
Dokumentace [Zobrazit] [editovat] [historie] [vyprázdnit paměť]
Š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, kde nyní (říjen 2007) patří k současné metodice dokumentace šablon.
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í
[editovat]Běžné
[editovat]<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 /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, 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í
[editovat]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
[editovat]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
[editovat]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 a kategorie. Rovněž snižuje nároky na zdroje serveru Wikipedie.
Viz rovněž
[editovat]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í
[editovat]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