Nápověda:Šablony

Z Wikipedie, otevřené encyklopedie
Skočit na: Navigace, Hledání

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íci se text, 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ům, ve kterých je použita.

Šablona se do článku vkládá pomocí jejího názvu ve dvojitých složených závorkách: {{Název šablony}}. Pokud do článku vložíme např. {{Pahýl}}, bude tento kód nahrazen textem šablony Šablona:Pahýl. Na stránce šablony je kromě vlastní šablony i další text (upozornění, dokumentace ap.), který se do článku nevloží. Většinu šablon lze nebo je přímo nutné přizpůsobit pomocí parametrů. Jednoduchý příklad: Pokud použijeme Šablona:Hlavní článek s parametrem Praha (odděleným svislou čárou): {{Hlavní článek|Praha}}, parametr se takto objeví ve vkládaném textu:

Hlavní článek: Praha

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.

Existuje velké množství různých druhů šablon k různým účelům. Příkladem mohou být navigační šablony nebo šablona 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ů.

Seznam všech existujících šablon najdete na Wikipedie:Šablony nebo přímo v kategorii Kategorie:Šablony Wikipedie. Nekategorizované šablony potom na speciální stránce.

Stránka šablony[editovat | editovat zdroj]

Š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[editovat | editovat zdroj]

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 znalosti dalších značkovacích jazyků (CSS a HTML).

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[editovat | editovat zdroj]

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[editovat | editovat zdroj]

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

{{Název šablony}}

Název se vkládá bez označení Šablona:. Pokud šablona umožňuje nebo vyžaduje uvedení parametrů, budou uvedeny uvnitř složených závorek, od názvu šablony odděleny svislou čarou (|).

{{Název šablony|Parametr}}

Parametrem může být např. název stránky, na kterou má šablona odkazovat. Popis parametrů se nachází v dokumentaci na stránce šablony. Parametrů může být více (oddělují se také svislou čárou), 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 druhoho parametru = vyplněná hodnota
| …
}}

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

Běžné použití (transkluze)[editovat | editovat zdroj]

Transkluze šablony B do článku A.

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 (víceméně ihned) 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)[editovat | editovat zdroj]

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: 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.

Vytvoření vlastní šablony[editovat | editovat zdroj]

Podrobnější nápovědu naleznete na stránce Nápověda:Vytvoření šablony.

Některé jednoduché šablony, například méně složité navigační boxy, 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[editovat | editovat zdroj]

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.