Nápověda:Šablony

Jako šablona se na Wikipedii označuje speciální druh pomocné stránky, jejíž obsah se vkládá do jiných článků. Umožňuje vkládat stejný nebo obdobný obsah do většího počtu stránek. Výhody jsou, že se nemusí pokaždé vkládat opakující se text či složité formátování, při editaci je text stránky kratší a přehlednější, podoba textu je ve všech článcích jednotná a úprava či vylepšení šablony se automaticky promítne do všech článků, ve kterých je použita.

^v_e Ve Vizuálním editoru je pro vložení šablony do článku potřeba v horní liště kliknout na Vložit > Šablona > název šablony > Přidat šablonu > Vložit. Na zvoleném místě se pak objeví přímo obsah vložené šablony.

Většinu šablon je možné nebo je přímo nutné přizpůsobit pomocí parametrů. Jednoduchý příklad: Pokud použijeme šablonu Šablona:Podrobně s parametrem Praha, parametr se použije ve vkládané šabloně takto:

V editoru wikitextu se pak šablona vkládá pomocí jejího názvu ve dvojitých složených závorkách: {{Název šablony}}. Parametry se vkládají oddělené svislou čárou: Pokud použijeme Šablona:Podrobně s parametrem Praha: {{Podrobně|Praha}}, dostaneme stejný výsledek jako výše.

Obsah některých šablon se do článku vkládá jednorázově, jejich kód zapsaný ve tvaru {{subst:Název šablony}} se při uložení editace nahradí (substituuje) obsahem šablony a stane se tak přímo součástí dané stránky, kde ho lze dalšími editacemi i změnit.

Existuje velké množství různých druhů šablon k různým účelům. Příkladem mohou být navigační šablony nebo šablony pro vložení zeměpisných souřadnic. Řada šablon je mnohem složitějších než výše popsané příklady, např. ty sloužící ke vkládání infoboxů.

Ručně udržovaný seznam významných šablon najdete na Wikipedie:Šablony, systematicky jsou tříděny pod kategorií Wikipedie:Šablony (seznam nekategorizovaných šablon je na speciální stránce).

Stránka šablony

Šablony se nacházejí ve vlastním jmenném prostoru pod názvem Šablona:Název šablony. Na stránce se nachází vlastní šablona a pod ní se zobrazuje dokumentace, která popisuje její použití. Dokumentace se zobrazuje v rámečku se světle žlutým pozadím a je uložená na pomocné podstránce Šablona:Název šablony/doc.

Vlastní šablona

Podle případu se šablona na své vlastní stránce zobrazí podobně jako v článku, s ukázkou vyplněných údajů nebo chybně – tak, jak se v článku objeví, pokud nevyplníte povinné parametry.

Některé šablony, například jednoduché navigační boxy, mohou mít jednoduchý kód, který zvládne upravit i trochu zkušenější wikipedista. Mnoho dalších však vyžaduje pokročilejší znalosti wikitextu, případně dalších značkovacích jazyků (CSS a HTML); některé šablony pak jsou psány v programovacím jazyce Lua pomocí modulů.

Stránka šablony zpravidla obsahuje pouze její kód, doprovodný text (a kategorie, do kterých je šablona zařazena) jsou umístěny na podstránce dokumentace.

Dokumentace

Dokumentace, jak šablonu používat, může mít různý rozsah, od podrobného popisu po stručnou informaci, případně může úplně chybět. Umístěna je na podstránce (Šablona:Název šablony/doc), na stránce šablony je přístup pro práci s ní pomocí odkazů v hranatých závorkách za nadpisem Dokumentace. Ty jsou přesměrované na podstránku, podobně jako i odkazy [editovat zdroj] u nadpisů.

Obsáhlejší dokumentace má obvykle následující základní strukturu:

Použití – v úvodu je základní popis, kde a jak se šablona používá
Parametry – podrobný popis jednotlivých parametrů, popis možných chyb ap.
další technická data
Související šablony – šablony používané v podobných případech, obdoba souvisejících článků

A samozřejmě se mohou dle potřeby vyskytovat další oddíly, např. podrobnější příklady použití atd.

Kategorie, do kterých má být vložena šablona (nikoli sama dokumentace), se vkládají na konec dokumentace. Jejich seznam je vložen mezi značky <includeonly> a </includeonly>. Případně, pokud stránka dokumentace není, se kategorie vkládají na konec vlastní šablony mezi značky <noinclude> a </noinclude>.

Použití šablony

Šablona se do článku vkládá uzavřením jejího jména (bez označení jmenného prostoru Šablona:) do dvojitých složených závorek:

{{Název šablony}}

Vstupní parametry

Pokud šablona umožňuje nebo vyžaduje uvedení parametrů, budou uvedeny uvnitř složených závorek, oddělené od názvu šablony svislou čárou (|):

{{Název šablony|Parametr}}

Parametrem může být např. název stránky, na kterou má šablona odkazovat; pokud je parametrů více, oddělují se také svislou čárou. Popis parametrů se nachází v dokumentaci na stránce šablony. Některé šablony používají parametry určené jen svým pořadím (zejména jednodušší šablony s jedním či několika málo parametry):

{{Název šablony|Parametr|Druhý parametr}}

Jiné šablony používají parametry pojmenované, u těch se vždy uvádí nejprve název parametru následovaný rovnítkem a příslušnou hodnotou:

{{Název šablony|parametr=Hodnota|jiný parametr=Hodnota jiného parametru}}

Zejména složitější šablony mohou připomínat formulář a pro přehlednost se může každý parametr nacházet na novém řádku:

{{Název šablony
| Název prvního parametru = vyplněná hodnota
| Název druhého parametru = vyplněná hodnota
| …
}}

Příkladem takové šablony je {{Citace monografie}}, která slouží k vložení informací o tištěné knize a kde jednotlivé parametry odpovídají názvu knihy, autorovi, datu vydání atd.

Pokud do šablony používající nepojmenované parametry chceme vložit hodnotu obsahující rovnítko, je potřeba číslování uvést explicitně, jinak bude obsah pochopen jako pojmenovaný parametr s dlouhým názvem odpovídajícím části před rovnítkem:

Chybně: {{Název šablony|Víte, že 1+2=3?}}

Takový zápis je pochopen jako pojmenovaný parametr „Víte, že 1+2“ s hodnotou „3?“. V takovém případě je proto potřeba psát:

{{Název šablony|1=Víte, že 1+2=3?}}

Běžné použití (transkluze)

Kód šablony zapsaný výše uvedeným způsobem {{Název šablony}} zůstává v kódu článku v nezměněné podobě a vždy až při zobrazování stránky v prohlížeči se kód nahradí obsahem šablony. To je většinou výhodou, protože každá úprava či vylepšení šablony se pak (někdy ne hned) projeví ve všech článcích, do kterých je šablona vložena. Popsaný princip se nazývá transkluze (z angl. transclusion).

Náhrada (substituce)

Obsah některých šablon se vkládá přímo do článku, protože není potřeba nebo ani žádoucí, aby se obsah aktualizoval při každém načtení stránky.

{{subst:Název šablony}}

Kód subst: nebo vložit: před názvem šablony zajistí, že při uložení editace se tento vložený kód nahradí (substituuje) kódem šablony. Při další editaci článku se tedy na místě vložení šablony bude nacházet kopie jejího textu (kódu).

Příkladem takové šablony je {{subst:mnm}}, sloužící ke vložení zkratky nadmořské výšky (m n. m.) za číselný údaj ve správném tvaru s nezlomitelnými mezerami. Text zkratky se nebude měnit a tudíž není nutné ji při každém otevření stránky načítat nanovo. Kód editované stránky s vloženou šablonou:

Sněžka je vysoká 1603{{subst:mnm}}

Při příští editaci již v kódu článku nebude šablona, ale označení m n. m.:

Sněžka je vysoká 1603 m n. m.

Náhrada pomocí subst je vhodná např. pro nápovědu na diskusních stránkách uživatelů nebo pro krátké dočasné zprávy, které budou brzy smazány.

Substituce se také používá pro doplnění časového razítka do šablony. Výsledkem substituce je šablona vložená běžným způsobem (transkluzí), ale doplněná číselným kódem jako parametrem, který udává datum a čas vložení šablony (uložení editace). Vložení časového razítka substitucí umožňuje (a vyžaduje) kód některých údržbových šablon, které například určují lhůtu k úpravě od data označení, např. {{subst:Významnost}}.

Vytvoření vlastní šablony

Některé jednoduché šablony, například méně složité navigační šablony, lze vytvořit zkopírováním a úpravou kódu podobné, již existující šablony. Vytváření jiných nebo složitějších šablon již vyžaduje další znalosti a zkušenosti.

Stránky používající šablonu

Pokud chcete zjistit, které stránky danou šablonu používají, můžete využít možnost Odkazuje sem v levém panelu, případně stránku Speciální:Odkazuje sem. Vložení šablony na stránku bude v zobrazeném seznamu označeno pomocí slova „(vložení)“ za názvem stránky.

Související články