Nápověda:Jak používat šablony
|
Každou šablonu je třeba po odzkoušení řádně zdokumentovat - viz Jak dokumentovat šablony |
Šablony lze použít již hotové, nebo vlastní. Pro jejich vytvoření je nutné vědět něco málo o použití CSS stylů a HTML.
Existující šablony, resp. jejich seznamy můžete najít buď přes speciální stránku Kategorie, případně Speciální:Nekategorizované šablony - ve wiki se totiž mohou vyskytnout i šablony, které ještě nebyly zařazeny do kategorie Šablony).
Existující šablony lze také dohledat ve jmenném prostoru Šablony ( přes speciální stránku Všechny stránky )
Kód šablony
Vlastní šablona vypadá podobně jako běžný článek, kromě přednastavených parametrů může také obsahovat proměnné do kterých jsou pak při použití dosazeny hodnoty atributů, případně i další šablony.
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}}}]]''
|-
! '''Born''' || {{{datum_narození}}}, {{{rok_narození}}}<br/>{{{místo_narození}}}
|-
! '''Died''' || {{{datum_úmrtí}}}, {{{rok_úmrtí}}}<br/>{{{místo_úmrtí}}}
|}
Pozn.: Aby nevznikala řada nevyužitých šablon, tak prosím pro testování vlastní šablony použijte šablonu Šablona:Test teprve po vyladění vytvořte vlastní šablonu. Během práce s touto šablonou přidejte do jejího kódu následující kód {{Pracujese}} 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ý.Při tvorbě šablon zachovávejte také jistou dávku štábní kultury. Každá šablona by měla mít:
- svůj popis
- příklad použití
- ev. zařazení do kategorie Šablony
Aby se tyto informace nevkládaly spolu se šablonou, je třeba uzavřít je do tagu <noinclude> Viz:
{| style="padding:2px; margin:2px;"
|-valign="top"
| [[Image:Poznamka.svg|32px|Poznámka]]
| style="background-color:#fffff0; border-left: 4px solid yellow; padding-left: 6px; " | {{{obsah|}}}
|}
<noinclude>
__NOTOC__
=Popis=
Šablona pro vyznačení poznámky v textu.
=Použití=
<nowiki>{{Poznámka|Obsah poznámky, který může být klidně i na více řádků}}</nowiki>
Krom toho existuje ještě jiná poznámka [[Šablona:Poznámka]], upozornění [[Šablona:Pozor]] a příklad [[Šablona:Příklad]].
[[Kategorie:Šablony]]
</noinclude>
Parametry
(podporované ve verzi 1.3 a vyšší)
Parametry šablon jsou pojmenované, nebo číslované. Syntaxe je {{šablona_jméno|par_jméno1=par_hodnota1|par_jméno2=par_hodnota2}} s tagem {{{par_jméno}}} v šabloně, nebo {{šablona_jméno|par_hodnota1|par_hodnota2}} s použitím v šabloně {{{1}}}, {{{2}}}. (Všimněte si, že tagy parametů mají 3 složené závorky místo dvou.)
Mechanismus šablon tedy zahrnuje dva druhy nahrazování:
- volání šablony (dvojté závorky) jsou nahrazeny obsahem šablony
- parametry (trojité závorky) jsou nahrazeny hodnotou parametru
Od verze srpen 2004 může hodnota parametru obsahovat odkaz se svislítkem; znak "|" v takovém odkazu není považován za oddělovač parametru.
Při zobrazování jsou ignorovány přebytečné parametry. V případě menšího počtu parametrů je výsledek závislý na zbývajících parametrech.
Parametry jsou citlivé na velikost písmen i s respektováním prvního písmena a mezery jsou rozlišovány od podtržítka, i když stránka šablony tyto rozdíly nezobrazuje.
Proměnné
V šablonách, ale také textu stránek, lze využívat systémových proměnných. Výsledek, který tyto proměnné vrací, závisí na čase, projektu nebo stránce, ve které se vyskytují.
Více o jejich použití se dozvíte na stránce nápovědy věnované systémovým proměnným a jejich použití.
Funkce
Kromě systémových proměnných lze u naší wiki používat také nejrůznější logické funkce. To zajišťuje rozšíření ParserFunctions. Níže uvádím pouze příklad použití. Více podrobností o tom jaké funkce nabízí a jak je lze využít se dočete na stránce DCEwiki:Extensions
Vlevo je uvedena proměnná, vpravo jak bude zobrazena.
Konstanty závislé na projektu a parametrech
| {{ns:-2}} or {{ns:Media}} | Média |
| {{ns:-1}} or {{ns:Special}} | Speciální |
| {{ns:1}} or {{ns:Talk}} | Diskuse |
| {{ns:2}} or {{ns:User}} | Uživatel |
| {{ns:3}} or {{ns:User_talk}} | Diskuse s uživatelem |
| {{ns:4}} or {{ns:Project}} | Thewoodcraft.org |
| {{ns:5}} or {{ns:Project_talk}} | Diskuse k Thewoodcraft.org |
| {{ns:6}} or {{ns:Image}} | Soubor |
| {{ns:7}} or {{ns:Image_talk}} | Diskuse k souboru |
| {{ns:8}} or {{ns:MediaWiki}} | MediaWiki |
| {{ns:9}} or {{ns:MediaWiki_talk}} | Diskuse k MediaWiki |
| {{ns:10}} or {{ns:Template}} | Šablona |
| {{ns:11}} or {{ns:Template_talk}} | Diskuse k šabloně |
| {{ns:12}} or {{ns:Help}} | Nápověda |
| {{ns:13}} or {{ns:Help_talk}} | Diskuse k nápovědě |
| {{ns:14}} or {{ns:Category}} | Kategorie |
| {{ns:15}} or {{ns:Category_talk}} | Diskuse ke kategorii |
| {{ns:100}} | |
| ... (depending on custom namespaces) | |
| {{ns:121}} | |
| {{SITENAME}} | thewoodcraft.org |
| {{SERVER}} | https://www.thewoodcraft.org |
| {{localurl:pagename}} | /wiki/index.php/pagename |
| {{localurl:pagename|query string}} | /wiki/index.php?title=pagename&query string |
Závislé na čase
| {{CURRENTMONTH}} | 11 |
| {{CURRENTMONTHNAME}} | listopad |
| {{CURRENTMONTHNAMEGEN}} | listopadu |
| {{CURRENTDAY}} | 21 |
| {{CURRENTDAYNAME}} | čtvrtek |
| {{CURRENTYEAR}} | 2024 |
| {{CURRENTTIME}} | 11:46 |
| {{NUMBEROFARTICLES}} | 7 371 |
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ů, pahýlů 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 |
| {{PAGENAME}} | Jak používat šablony |
| {{PAGENAMEE}} | Jak_pou%C5%BE%C3%ADvat_%C5%A1ablony |
PAGENAMEE zobrazuje nadpis stránky ve formě, která je použita v URL, to znamená s podtržítky místo mezer a escape kódy speciálních znaků (diakritika ...), a jsou proto používány pro vytváření URL. Například na stránce jménem "Another test", PAGENAMEE produkuje "Another_test" místo "Another test". Podívejte se také na Variables {{PAGENAME}} and {{PAGENAMEE}}
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.
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 a vloží ji do textu při uložení článku (substituce). Bez slova "subst" bude obsah šablony vkládán do textu stránky vždy při prohlížení, proces známý jako "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 je také, ž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 vložení do stránky, použijte "subst". Jestliže nepotřebujete obsah měnit a chcete, aby se změny v šabloně automaticky projevily ve stránkách, "subst" nepoužijte.
