Nápověda:Vytvoření šablony

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

K vytvoření šablony je vhodné znát alespoň základy formátování textu. Pokročilí wikipedisté mohou případně využít i CSS styly a HTML kód. Pro komplexnější šablony je pak možné využít i tzv. moduly. Zejména u složitější šablony se doporučuje poskytnout detailní návod na její použití včetně příkladů, který se umístí na její dokumentační podstránku.

Zjednodušený návod[editovat | editovat zdroj]

  1. Před vytvořením šablony vždy zkontrolujte, že dotyčná šablona ještě neexistuje. Můžete projít ručně udržovaný seznam význačných šablon na Wikipedie:Šablony. Všechny existující šablony pak najdete přímo v kategorii Wikipedie:Šablony a nekategorizované šablony potom na speciální stránce. Ke kontrole můžete také zkusit vyhledat možné názvy ve vyhledávacím poli vpravo nahoře.
  2. Pokud šablona ještě neexistuje, můžete ji vytvořit. Vraťte se na seznam význačných šablon, do kategorie Wikipedie:Šablony i na seznam nekategorizovaných šablon a pokuste se zde najít šablonu, která se formátem nejvíce podobá vámi zamýšlené nové šabloně. Pokud uspějete, otevřete si zdrojový kód této šablony a zkopírujte si jej.
  3. Vraťte se znovu do seznamu význačných šablon a připište do něj nebo do příslušné podstránky záznam o šabloně, kterou se chystáte vytvořit. Stránku uložte a klikněte na červený odkaz vaší nové, zatím neexistující, šablony. Vložte do editačního okna zkopírovaný kód a upravte ho na svoji šablonu. Po zkontrolování šablony v náhledu ji uložte.

Pokud jste nenašli žádnou formátem podobnou šablonu vámi zamýšlené nové šabloně, můžete se pokusit šablonu sami sestavit podle sekce #Kód šablony níže.

Kód šablony[editovat | editovat zdroj]

Kód šablony na rozdíl od článků a jiných stránek často obsahuje parametry označené třemi složenými závorkami, např. {{{1}}} nebo {{{název}}}. Při použití šablony se vyplní hodnoty a ty se použijí na místo odpovídajících parametrů. Dalším prvkem často používaným v šablonách jsou kouzelná slůvka, např. {{PAGENAME}}, které se nahradí názvem článku, do kterého je šablona vložena.

Příklad kódu šablony s parametry (šablona {{Upravit}})
{{Cedule
 |typ =content
 |obrázek =Broom icon.svg
 |nadpis =Tento článek potřebuje úpravy.
 |text =Můžete Wikipedii pomoci tím, že ho <span class="plainlinks">[{{fullurl:{{FULLPAGENAME}}|action=edit}} vylepšíte]</span>. Jak by měly články vypadat, popisují stránky [[Wikipedie:Vzhled a styl|Vzhled a styl]], [[Wikipedie:Encyklopedický styl|Encyklopedický styl]] a [[Wikipedie:Průvodce (odkazy)|Odkazy]].
 |poznámka ={{Cedule/komentář|{{{poznámky|{{{1|<noinclude>příklad poznámky</noinclude>}}}}}}|pretext=Konkrétní problémy: }}
 |id =
}}<includeonly>{{Kategorie|Články k úpravě}}</includeonly><noinclude>
{{Dlouhodobě polozamčeno}}
{{Dokumentace}}<!-- KATEGORIE, PROSÍME, PŘIDÁVEJTE DO /doc PODSTRÁNKY. DĚKUJEME -->
</noinclude>

Části šablony

  • Vlastní kód šablony je tvořen jinou šablonou, {{Cedule}}, která zobrazuje úvodní upozornění. V šabloně Cedule jsou vyplněny jednotlivé parametry, které určují typ, ikonu, nadpis, text a poznámku. V textu je pomocí kódu [{{fullurl:{{FULLPAGENAME}}|action=edit}} vylepšíte] doplněn odkaz na editaci daného článku. Jediný parametr šablony Upravit je poznámka, která se tedy vloží prvním nepojmenovaným parametrem {{{1|<noinclude>příklad poznámky</noinclude>}}}, text „příklad poznámky“ se zobrazí jen na stránce šablony; lze použít i parametr se jménem, proto je tento parametr vložen do {{{poznámky}}}.
  • Dále následuje zařazení článku do kategorie článků k úpravě. Štítky <includeonly> zajistí, že se do ní nevloží i samotná stránka šablony, použití šablony {{Kategorie}} navíc omezí použití dané kategorie jen na články (stránky v hlavním jmenném prostoru).
  • Dále následuje část označená štítky <noinclude>, která se do článků nevkládá. Obsahuje dvě šablony, uzamčení před vandalismem a dokumentaci (nápovědu), která se kompletně včetně kategorizace šablony přebírá z jejího umístění na podstránce /doc.

Vkládaná a nevkládaná část kódu[editovat | editovat zdroj]

V šabloně bývá vlastní obsah šablony, který se vkládá do stránky, a nevkládané části šablony, které se zobrazují pouze na stránce šablony jako např. dokumentace šablony, kategorie šablony, ap.

V šabloně můžete označit části, které se vkládat nemají (značka noinclude):

Vlastní obsah šablony…
<noinclude> Dokumentace… </noinclude>

Méně běžný je opačný postup, kdy označíte části, které jediné se vkládat mají (značka onlyinclude):

<onlyinclude> Vlastní obsah šablony… </onlyinclude>
Dokumentace…

Zejména u vkládání kategorií do článků pomocí šablony je potřeba označit části, které se vkládat mají, ale na stránce šablony se vložit nemají (značka includeonly – pozor na záměnu s předchozí):

Vlastní obsah šablony…
<includeonly> Kategorie článku… </includeonly>

Příkladem jiného použití těchto značek je článek Medailové pořadí na Letních olympijských hrách 2012, kde jsou značkami <onlyinclude> označeny vybrané medailové pozice (předních 10 a česká) a transkluzí vloženy do článku Letní olympijské hry 2012.

Kategorie[editovat | editovat zdroj]

V šablonách se kategorie používají ke dvěma účelům:

  1. zařazení stránky šablony do speciálních kategorií,
  2. automatického zařazení článku (stránky), do kterého je šablona vložena, do kategorie.

1. Stránky šablon se řadí do speciálních kategorií v kategorii Wikipedie:Šablony. Kategorie šablony musí být v nevkládané části stránky, obvykle na konci dokumentační podstránky. Příkladem může být Kategorie:Šablony:Diskusní

2. Články (či jiné stránky) se do příslušné kategorie zařadí, pokud je kategorie obsažena ve vkládané části šablony. Kategorizace prostřednictvím šablon se nejčastěji využívá pro zařazování článku do údržbových kategorií. Například šablona {{Upravit}} do článků transkluzí vkládá Kategorie:Údržba:Články k úpravě. Aby byly do kategorie zařazeny jen články a ne samotná šablona, je potřeba použít kód <includeonly>[[Kategorie:Název]]</includeonly>.

Testování šablon[editovat | editovat zdroj]

Při editaci šablon máte možnost vyplnit jméno stránky, ve které je šablona vložena, a v náhledu uvidíte, jak bude vypadat s právě editovanou verzí této šablony.

Ale ne vždy lze tuto funkci použít. Potom máte následující možnosti:

Stránka pro rozbalení šablon. Jděte na Speciální:Testy šablon, do formuláře vyplňte volání šablony se všemi parametry, jak by se objevilo v reálném článku, a nechte si zobrazit výsledek. Podstatnou nevýhodou této metody je, že šablona musí být nejdřív uložená, takže to samé jste si vlastně mohli vyzkoušet na Pískovišti. Vy však typicky šablonu uložit nechcete, protože už je použita v řadě článků, a pokud uděláte chybu (což je ve složitém kódu např. infoboxů docela snadné), pokazíte vzhled mnoha článků najednou. Místo abyste pak v klidu přemýšleli, jak chybu opravit, případně udělali ještě několik jiných pokusů, musíte rychle vše uvést do původního stavu.

Testovací šablona. Kód šablony, kterou měníte, zkopírujete do testovací šablony, kterou běžné články nevolají. Tuto testovací šablonu tedy můžete bez obav uložit. Pak už máte několik způsobů, jak si prohlédnout její vzhled s reálnými parametry: buď pomocí výše uvedené stránky pro rozbalení šablon, nebo voláním šablony z pískoviště, nebo si rovnou necháte zobrazit náhled článku, který šablonu používá: název původní šablony nahradíte názvem testovací šablony, parametry a umístění v článku zůstanou netknuté. A protože je to jen náhled, zbytek světa nic divného neuvidí. Až bude šablona odladěná, nahradíte novým kódem starý kód pod skutečným názvem šablony a uložíte ji. (Pozor, abyste neuložili článek, na kterém jste šablonu ladili, s odkazem na testovací šablonu.)

Aby nevznikala řada nevyužitých šablon, tak prosím pro testování vlastní šablony použijte šablonu Šablona:Test. Během práce s touto šablonou přidejte do jejího kódu šablonu {{Pracuje se}}, která vloží informaci, že se šablonou zrovna někdo něco dělá. Po skončení práce pak kód testovací šablony smažte, aby ji mohl použít někdo jiný. Pokud se věnujete šablonám více, je také možné vytvořit si šablonu ve jmenném prostoru wikipedisty (např. Wikipedista:Jméno/Šablona:Test) a používat na testování tuto.

Neočekávané odřádkování[editovat | editovat zdroj]

Podrobnější nápovědu naleznete na stránce Nápověda:Neočekávaná odřádkování a mezery.

Při testování šablon je potřeba ohlídat vznik nežádoucího odřádkování nebo vložení mezery, které se neprojeví při samostatném použití šablony, ale v kombinaci s další šablonou či kouzelným slůvkem.

Parametry šablon[editovat | editovat zdroj]

Parametry šablon jsou buď pojmenované, nebo číslované. Oba způsoby ale lze (i v téže šabloně) vzájemně kombinovat.

Pokud se při volání šablony vyskytne více zadaných parametrů, než zobrazení šablony potřebuje, budou nadbytečné parametry ignorovány. V opačném případě (tedy pokud je zadáno méně parametrů) je výsledek volané šablony závislý na ostatních parametrech.

Od srpna 2004 mohou jednotlivé zadané parametry šablony obsahovat i svislítka (symbol „|“), která nejsou považována za oddělovač v parametru.

Pojmenované parametry[editovat | editovat zdroj]

Z článku šablonu voláme:

{{Název volané šablony
 | parametr A = hodnota parametru A
 | parametr B = hodnota parametru B
 | parametr C = hodnota parametru C
}}

Při tvorbě vlastní šablony pracujeme s jednotlivými zadanými hodnotami pomocí jejich názvů, které obalíme třemi páry složených závorek. Například tedy {{{parametr A}}}, {{{parametr B}}} a {{{parametr C}}}.

Názvy parametrů jsou citlivé na velikost písmen či přítomnost mezery. Totožné tedy nejsou parametry nazev a Nazev, ani název a Název či pojmenování stavby a pojmenování_stavby.

Oproti číslovanému zápisu parametrů šablony má však tento zápis výhodu v možnosti proměnného pořadí zadávání parametrů šablony. Totožný výstup bude šablona dávat při volání:

{{Název volané šablony
 | parametr A = hodnota parametru A
 | parametr B = hodnota parametru B
 | parametr C = hodnota parametru C
}}

tak při volání například (s prohozeným pořadím zápisu prvních dvou parametrů):

{{Název volané šablony
 | parametr B = hodnota parametru B
 | parametr A = hodnota parametru A
 | parametr C = hodnota parametru C
}}

Jestliže ale bude parametr ve volané šabloně zadán vícekrát, použije se ten později zadaný a stránka bude zařazena do údržbové kategorie.

Číslované parametry[editovat | editovat zdroj]

Z článku šablonu voláme (povšimněte si absence názvu jednotlivých proměnných i nepřítomnosti rovnítek):

{{Název volané šablony
 | hodnota parametru A
 | hodnota parametru B
 | hodnota parametru C
}}

Při tvorbě vlastní šablony pracujeme s jednotlivými zadanými hodnotami podle pořadí jejich zadání (číslovány jsou od jedničky výše). Číslo pořadí obalíme trojicí párů složených závorek, tedy například {{{1}}}, {{{2}}} a {{{3}}}.

Kombinace typů parametrů[editovat | editovat zdroj]

Oba způsoby zadávání parametrů (pojmenovaný a číslovaný) lze vzájemně kombinovat. V takovém případě budou při volání šablony:

  • zadané hodnoty pojmenovaných parametrů přiřazeny k hodnotám příslušně pojmenovaných parametrů
  • zadané hodnoty nepojmenovaných (tedy číslovaných) parametrů přiřazeny podle pořadí jejich zadání ke zbývajícím parametrům šablony
Příklad

Příkladem budiž šablona pojmenovaná „Pokus“ mající tuto podobu:

* Vypiš první parametr: {{{parametr A}}}
* Vypiš druhý parametr: {{{1}}}
* Vypiš třetí parametr: {{{2}}}
* Vypiš čtvrtý parametr: {{{parametr B}}}

Při jejím volání:

{{Pokus | parametr A = stůl | dveře | parametr B = židle | okno}}

vypíše

  • Vypiš první parametr: stůl
  • Vypiš druhý parametr: dveře
  • Vypiš třetí parametr: okno
  • Vypiš čtvrtý parametr: židle

VisualEditor[editovat | editovat zdroj]

Pro možnost plnohodnotného vkládání šablony pomocí VisualEditoru je potřeba do dokumentace šablony (případně přímo do šablony) vložit speciální tabulku parametrů. Umisťuje se pod vlastní dokumentaci, před Související šablony, pod tento nadpis a informační šablonu:

== Data šablony ==
{{TemplateDataHeader}}

Vkládá se pomocí tlačítka Spravovat TemplateData nad editačním oknem se šablonou. Nápověda (anglicky) se nalézá pod odkazem vedle tohoto tlačítka. Příklad tabulky se nachází v šabloně {{Citace monografie}}

Kouzelná slůvka a proměnné[editovat | editovat zdroj]

Podrobnější nápovědu naleznete na stránce Nápověda:Kouzelná slůvka.

Při tvorbě šablon lze také využít některé kódy pro speciální účely nazývané kouzelná slůvka. Patří k nim kódy ovlivňující zobrazení obsahu článku (např. __NOTOC__ jej skryje) a další funkce (__NOEDITSECTION__ zakáže editace jednotlivých oddílů stránky).

Speciální kategorií jsou proměnné, které se zobrazují jako různé hodnoty v závislosti na použití. Například {{CURRENTTIME}} zobrazí aktuální čas nebo {{TALKPAGENAME}} se nahradí názvem stránky diskuse ke stránce, do které je šablona vložena.

Malá a velká písmena[editovat | editovat zdroj]

slovo příklad vysvětlení
{{LC:}} {{LC:AbC dEf}} = abc def [MW1.5+] malá písmena
{{UC:}} {{UC:aBc DeF}} = ABC DEF [MW1.5+] velká písmena
{{LCFIRST:}} {{LCFIRST:Ab Cd}} = ab Cd [MW1.5+] první písmeno malé.
{{UCFIRST:}} {{UCFIRST:aB cD}} = AB cD [MW1.5+] první písmeno velké.

Použití šablon[editovat | editovat zdroj]

Opožděné projevení změn[editovat | editovat zdroj]

Změny v šabloně se mohou na stránkách, které ji používají, projevit se zpožděním. Vynutit jejich okamžité respektování je možno funkcí Purge, například kliknutím na tlačítko „editovat“ a ihned poté na „uložit“. Taková editace se neuloží do historie, ale aktualizuje cache stránky.

Modifikátory šablon[editovat | editovat zdroj]

použití vysvětlení
{{:xyz}} Dvojtečka není modifikátor, ale označení hlavního jmenného prostoru. Srovnejte např. článek {{:Chemie}} a šablonu {{Chemie}}
{{int:xyz}} Zobrazí {{MediaWiki:xyz}} nebo <xyz>, nikoliv šablonu {{xyz}}. Příklad: {{int:edit}} = Editovat.
{{msgnw:xyz}} Je zobrazen zdrojový wikitext.
{{subst:xyz}} Do stránky je uložen obsah šablony.

Stránky používající šablonu[editovat | editovat zdroj]

Pokud chcete zjistit, které stránky danou šablonu používají, můžete využít stránku Speciální:Co odkazuje na. Vložení šablony na stránku bude v zobrazeném seznamu označeno pomocí slova „(vložení)“ za názvem stránky.

Související stránky[editovat | editovat zdroj]