Nápověda:Šablony

Jako šablona se na AppleWikipedii 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ř. {{Ohryzek}}, bude tento kód nahrazen textem šablony Šablona:Ohryzek. 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 Apple (odděleným svislou čárou): {{Hlavní článek|Apple}}, parametr se takto objeví ve vkládaném textu:

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 AppleWikipedie:Šablony nebo přímo v kategorii Kategorie:Šablony AppleWikipedie. Nekategorizované šablony potom na speciální stránce.

Pokud chceme vytvořit vlastní šablonu, je vhodné nejdříve přečíst tuto nápovědu a také je dobré vědět něco málo o použití CSS stylů a HTML. Autor by měl zejména u složitější šablony poskytnout detailní návod na její použití včetně příkladů použití, který umístí na dokumentační podstránku šablony či její diskusní stránku.

Než sami vytvoříte šablonu, nejprve se přesvědčte, jestli již nějaká podobná neexistuje.

Kód šablony

Vlastní šablona vypadá podobně jako běžný článek, ovšem může obsahovat přednastavené parametry, které se pak při použití nahradí vlastním obsahem encyklopedického hesla.

Příklad kódu šablony s parametry:

{| style="width:256px;padding:2px;border:1px solid;float:right"
! style="text-align:center;background-color:#efefef;font-weight:600;
         font-size:larger" colspan="2" | <big>{{{jméno}}}</big>
|-
|  style="text-align:center" colspan="2" | [[Image:{{PAGENAME}}.jpg|none|250px|{{{bublina}}}]]
 {{{popisek}}}
|-
|  style="text-align:center" colspan="2" | ''[[Wikiquote:{{PAGENAME}}|{{{motto}}}]]''
|-
! '''Narození''' || {{{datum_narození}}}, {{{rok_narození}}}<br/>{{{místo_narození}}}
|-
! '''Úmrtí''' || {{{datum_úmrtí}}}, {{{rok_úmrtí}}}<br/>{{{místo_úmrtí}}}
|}

Testování šablon

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í:ExpandTemplates, 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ý.

Parametry šablon

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ý není považován za oddělovač v parametru.

Pojmenované parametry

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 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, bude platit ten později zadaný.

Číslované parametry

Z článku šablonu voláme:

{{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í. Číslo pořadí obalíme trojicí párů složených závorek, tedy například {{{1}}}, {{{2}}} a {{{3}}}.

Kombinace typů parametrů

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

Kategorie v šablonách

Šablony jsou řazeny v kategoriích. Neřadíme je ale mezi encyklopedické kategorie, nýbrž do specifické kategorie šablon AppleWikipedie (a její podkategorií). Pomocí specifických HTML tagů lze ovlivnit, zda do kategorie bude zařazena pouze šablona a nebo zda se do kategorie budou řadit pouze články obsahující danou šablonu (přičemž daná šablona v ní nebude).

Pro první případ, tedy kdy se do kategorie má zařadit pouze šablona, ale články, které ji obsahují, již nikoliv nikoliv, vložíme kategorie mezi tagy <noinclude> a </noinclude>. Příkladem může být

<noinclude>[[Kategorie:Šablony na diskusní stránky]]</noinclude>

Ve druhém případě, kdy mají být do kategorie vloženy pouze stránky, jež šablonu obsahují (ale vlastní šablona již ne), vložíme kategorie mezi tagy <onlyinclude> a </onlyinclude>. Příkladem budiž

<onlyinclude>[[Kategorie:Londýnská letiště]]</onlyinclude>

Kategorizace prostřednictvím šablon se využívá zejména pro zařazování článku do údržbových kategorií (například šablona {{Upravit}} řadí články do kategorie Články k úpravě.

Modifikátory šablon

použití	vysvětlení
{{:xyz}}	Dvojtečka není modifikátor, ale označení hlavního jmenného prostoru. Srovnejte např. článek {{:Zpráva}} a šablonu {{Zpráva}}
{{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.

Proměnné

Toto je seznam proměnných, které mohou být použity ve wikitextu, nejen v šablonách. Způsob jejich zobrazení závisí na čase, projektu nebo stránce, ve které se vyskytuje.

Vlevo je uvedena proměnná, vpravo jak bude zobrazena.

Konstanty závislé na projektu a parametrech

{{ns:-2}} nebo {{ns:Media}}	Média
{{ns:-1}} nebo {{ns:Special}}	Speciální
{{ns:1}} nebo {{ns:Talk}}	Diskuse
{{ns:2}} nebo {{ns:User}}	Uživatel
{{ns:3}} nebo {{ns:User_talk}}	Diskuse s uživatelem
{{ns:4}} nebo {{ns:Project}}	AppleWikipedie
{{ns:5}} nebo {{ns:Project_talk}}	Diskuse k AppleWikipedie
{{ns:6}} nebo {{ns:Image}}	Soubor
{{ns:7}} nebo {{ns:Image_talk}}	Diskuse k souboru
{{ns:8}} nebo {{ns:MediaWiki}}	MediaWiki
{{ns:9}} nebo {{ns:MediaWiki_talk}}	Diskuse k MediaWiki
{{ns:10}} nebo {{ns:Template}}	Šablona
{{ns:11}} nebo {{ns:Template_talk}}	Diskuse k šabloně
{{ns:12}} nebo {{ns:Help}}	Nápověda
{{ns:13}} nebo {{ns:Help_talk}}	Diskuse k nápovědě
{{ns:14}} nebo {{ns:Category}}	Kategorie
{{ns:15}} nebo {{ns:Category_talk}}	Diskuse ke kategorii
závislé na idividuálním nastavení jmených prostorů:
{{ns:100}}, {{ns:101}}, etc.	, , etc.
{{ns:100}}
{{ns:101}}
{{SITENAME}}	AppleWikipedia
{{SERVER}}	http://applewikipedia.org
{{SERVERNAME}}	applewikipedia.org
{{localurl:Jméno stránky}}	/index.php?title=Jm%C3%A9no_str%C3%A1nky
{{localurle:Jméno stránky}}	/index.php?title=Jm%C3%A9no_str%C3%A1nky
{{localurl:Jméno stránky|řetězec požadavku}}	/index.php?title=Jm%C3%A9no_str%C3%A1nky&řetězec požadavku
{{fullurl:Jméno stránky}}	http://applewikipedia.org/index.php?title=Jm%C3%A9no_str%C3%A1nky
{{fullurl:pagename|řetězec_požadavku}}	http://applewikipedia.org/index.php?title=Jm%C3%A9no_str%C3%A1nky&řetězec_požadavku
{{int:fromwikipedia}}	<fromwikipedia>

Závislé na čase

{{CURRENTMONTH}}	04
{{CURRENTMONTHNAME}}	duben
{{CURRENTMONTHABBREV}}	4.
{{CURRENTMONTHNAMEGEN}}	dubna	genitiv názvu měsíce (pro některé jazyky)
{{CURRENTWEEK}}	16
{{CURRENTDAY}}	19
{{CURRENTDAY2}}	19	dvoumístné číslo (např. 01, 02)
{{CURRENTDAYNAME}}	pátek
{{CURRENTDOW}}	5	číslo dne v týdnu (0=neděle, 1=pondělí)
{{CURRENTYEAR}}	2024
{{CURRENTTIME}}	22:24
{{CURRENTTIMESTAMP}}	20240419222434
{{NUMBEROFARTICLES}}	146
{{NUMBEROFFILES}}	27

NUMBEROFARTICLES: počet stránek v hlavním jmenném prostoru, které obsahují odkaz a nejsou přesměrovány, tj. počet článků, ohryzků obsahujících odkaz a nejednoznačných stránek.

Závisí to na systémové proměnné $wgUseCommaCount. Pokud je „true“, počítadlo článků bude obsahovat pouze články obsahující čárky (,). Pokud je „false“, bude započítávat články s odkazy ([[). Implicitní nastavení v DefaultSettings.php je „false“, může být změněno v LocalSettings.php.

Závislé na stránce

{{NAMESPACE}}	Nápověda
{{NAMESPACEE}}	N%C3%A1pov%C4%9Bda
{{PAGENAME}}	Šablony
{{PAGENAMEE}}	%C5%A0ablony
{{FULLPAGENAME}}	Nápověda:Šablony
{{FULLPAGENAMEE}}	N%C3%A1pov%C4%9Bda:%C5%A0ablony
{{TALKSPACE}}	Diskuse k nápovědě
{{SUBJECTSPACE}}	Nápověda
{{TALKPAGENAME}}	Diskuse k nápovědě:Šablony
{{SUBJECTPAGENAME}}	Nápověda:Šablony

Šablony se zdvojeným E na konci zobrazují název stránky ve formě, která je použita v URL, tj. s podtržítky místo mezer a escape kódy speciálních znaků (diakritika, …), a proto se používá pro vytváření URL. Například na stránce jménem „Jiný test“ PAGENAMEE produkuje „Jin%C3%BD_test“. Podívejte se také na :en:AppleWikipedia:Page name (anglicky).

Při použití v šabloně tyto tři proměnné ukazují na stránku, ve které je šablona vložena, ne na stránku šablony.

Kouzelná slůvka

slovo	vysvětlení
__NOTOC__	Vypne tabulku obsahu na stránce.
__FORCETOC__	Vynutí si zobrazení tabulky obsahu.
__TOC__	Umístí tabulku obsahu na dané místo (přebíjí __NOTOC__).

Další kouzla

slovo	vysvětlení
__NOEDITSECTION__	Vypne generování odkazu pro editaci jednotlivých sekcí.
__NEWSECTIONLINK__	[MW1.7+] Přidá odkaz „+“ vedle záložky editovat, pro vytvoření nové sekce na nediskuzních stránkách.
__END__	Umožní uložit mezery na konci článku.
__HIDDENCAT__	[MW1.12+] Skryje zobrazení kategorie na dolní liště v článcích (vkládá se na stránku kategorie).

Formátování

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í šablony

Jsou dva základní způsoby, jak vložit obsah šablony do stránky: {{Moje šablona}} a {{subst:Moje šablona}}.

Způsob {{subst:Moje šablona}} vytvoří kopii obsahu šablony a vloží ji do textu při uložení článku (substituce).

Bez slova "subst" bude aktuální obsah šablony vkládán do textu stránky vždy při prohlížení, kterýžto proces je známý jako „transkluze“ (transclusion).

Jinými slovy, po úpravách šablony nemusíte opravovat stránky, které šablonu používají, pokud použijete tvar bez direktivy „subst“.

Nápověda a krátké dočasné zprávy, které budou brzy smazány, by měly bý vkládány pomocí „subst“ (výhodou také je, že obsah šablony se stane součástí zdrojového textu stránky). Standardní poznámky, které budou součástí stránky po delší dobu, by měly být vkládány bez direktivy „subst“, aby se lépe udržovaly.

Pokud potřebujete upravovat obsah šablony po jejím vložení do stránky a nechcete, aby se změny v ní později udělané na této stránce projevily, použijte „subst“. Jestliže nepotřebujete obsah měnit a chcete, aby se změny v šabloně automaticky projevily na stránkách, kam byla vložena, „subst“ nepoužijte.

Opožděné projevení změn

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.

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

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

Další informace

Podrobnějí popis práce s parametry, podmíněných příkazů apod. lze nalézt na anglické verzi této stránky.