Nápověda:Šablony

This page is a translated version of the page Help:Templates and the translation is 100% complete.
PD Poznámka: Editací této stránky souhlasíte s uvolněním svého příspěvku pod licencí CC0. Více informací se dočtete na stránce Public Domain Help Pages.
PD

Máte-li standardní texty, které chcete zařadit na několika stránkách, je funkce šablon ideálním nástrojem. Na rozdíl od rozšíření a mediálních souborů zde není žádné centrální úložiště šablon. Šablony mohou být nově napsány nebo pro uložení již provedené duplicitní práce exportovány z jiné wiki např. Wikipedie a poté importovány do cílové wiki.

Vytvoření

Šablony jsou standardní wiki stránky, jejichž obsah je navržen tak, aby byl transkludován (vložen) do jiných stránek. Šablony se řídí konvencí, že název má předponu "Template:" a přiřazuje jej k tomuto jmennému prostoru. Kromě toho je můžete vytvořit jako kteroukoli jinou wiki stránku.

Nejjednodušší použití šablon je následující. Pokud vytvoříte stránku s názvem "Template:Welcome" s obsahem:

Ahoj! Vítejte na wiki.

vytvořili jste svou první šablonu! Pokud zadáte kód:

{{Welcome}}

na jakékoli jiné stránce se místo se zobrazí místo {{Welcome}} zobrazí text "Ahoj! Vítejte na wiki.". Obsah šablony je "přenesen" na tuto stránku, tj. je na stránce integrován.

Kód {{Welcome}} můžete vložit na kterékoli místo jakékoli stránky, na které chcete někoho přivítat. Předpokládejme, že se používá na 100 stránkách. Pokud změníte obsah šablony na:

Ahoj! Vítejte na této skvělé wiki.

znovu na kterékoli ze 100 stránek, kde byla šablona použita, uvidíte již nový text místo původního. Tímto způsobem jste změnili obsah 100 stránek, aniž byste je upravovali, protože na tyto stránky je přenesena šablona.

Toto je základní princip. Existuje několik dalších funkcí transluze, které obohacují tento mechanismus a činí šablony velmi užitečnými.

Použití

Šablony lze použít na jiných stránkách těmito způsoby:

  • {{Name}} - jak je popsáno výše, bude tento odkaz dynamicky nahrazen aktuálním obsahem [[Template:Name]] v okamžiku načtení stránky s odkazem na šablonu. Odkaz zůstane ve zdroji stránky nezměněn.
  • {{subst:Name}} - při použití tohoto odkazu šablony bude jednou provždy nahrazen obsahem [[Template:Name]] v době, kdy je stránka s odkazem uložena: Kopie obsahu [[Template:Name]] bude nahrazena odkazem na šablonu. Obsah je pak součástí stránky a může být upravován normálně, odděleně od originálu. Poznámka: Pozdější změny na stránce zdrojové šablony nebudou přeneseny na stránku s odkazem na šablonu.
  • {{safesubst:Name}} - toto bylo zavedeno s cílem umožnit nahrazení, které nepřerušuje transkluzi (zahrnutí stejného obsahu do více dokumentů, aniž by bylo nutné tyto dokumenty upravovat samostatně), viz w:Help:Substitution#The safesubst: modifier.
  • {{msgnw:Name}} - obsahuje šablonu ve formě, která ji zobrazuje jako nezpracovanou wiki syntaxi (způsobem ‎<nowiki>), když je načtena stránka, která ji obsahuje.

Ve skutečnosti lze běžnou wiki stránku použít také jako šablonu, jednoduše zadáním jmenného prostoru, ve kterém se nachází, takže:

  • {{Template:Pagename}} zahrnuje [[Template:Pagename]]
  • {{Talk:Pagename}} zahrnuje [[Talk:Pagename]]
  • {{:Pagename}} zahrnuje [[Pagename]]
    • {{subst::Pagename}} se nahrazuje obsahem[[Pagename]]

Pokud takový jmenný prostor neexistuje, považuje se celý název za šablonu:

  • {{Foo:Bar}} zahrnuje [[Template:Foo:Bar]]

Parametry

Pro obohacení mechanismu transkluze umožňuje MediaWiki předat parametry šabloně, když je transkludována. Parametry umožňují šabloně vytvářet různý obsah nebo mít různé chování.

Předpokládejme, že chcete vložit malou poděkovací poznámku na diskusní stránku dalších uživatelů, například:


Díky… za vaše úsilí. Zdraví Tonda


Jako první parametr šablony bude uvedeno zač je děkováno (v tomto případě "vaše úsilí") a jako druhý jméno děkujícího (např. "Tonda"). Vaším cílem je, aby kterýkoli uživatel mohl tímto způsobem za něco poděkovat jinému uživateli, kupř. v rámci diskuze.

Šablonu, například s názvem Template:Thankyou , použijete proto aby tahle poznámka vypadala stejně všude tam, kde se použije. I když bude vypadat každé poděkování podobně, jeho obsah (tj. důvod a podpis) se bude lišit vždy, pokud ji použije k poděkování někdo jiný, někomu jinému, za něco jiného. A to je obsah, který se bude předávat přes parametry. Zapomeňme pro tuto chvíli na ostatní prvky, které ovlivňují podobu rámečku a umístění obrázku. Z hlediska obsahu šablony, je rozhodující následující obsah:

'''Díky...'''
za {{{1}}}.
Zdraví {{{2}}}

Všimněte si použití {{{1}}} a {{{2}}}. Tak se do šablony vloží parametry předané při použití šablony. Identifikátory parametrů jsou uzavřeny do ztrojených složených závorek: {{{ }}}. To zajistí, že se nebudou interpretovat jako názvy šablony.

Když se šablona používá na stránce, oddělují se parametry znakem "svislítko" (|). MediaWiki identifikuje parametry předané šabloně třemi způsoby: podle pozice, čísla nebo jména.

Nepojmenované, poziční parametry

Pokud parametry předané šabloně nepojmenujete, bude rozhodující jejich pořadí:

{{Thankyou|vaše úsilí|Tonda}}

V tomto případě se šabloně {{Thankyou}} předají dva poziční parametry {{{1}}}=vaše úsilí a {{{2}}}=Tonda:


Díky… za vaše úsilí. Zdraví Tonda


Pořadí, ve kterém jsou parametry uvedeny, je pro jejich zpracování důležité. Podívejme se, jak bude vypadat výsledek zpracování, pokud uvedeme tyto parametry v obráceném pořadí:

{{Thankyou|Tonda|vaše úsilí}}

a tohle je výsledek:


Díky… za Tonda. Zdraví vaše úsilí


Podle pozice se zpracovávají pouze nepojmenované parametry. Pokud použijete při pojmenování číslo pozice (např. {{{1}}} atd.) nemusí šablona fungovat správně. Žádné parametry identifikované jménem, jak je uvedeno níže, nebudou pro šablonu přístupné pomocí pořadových čísel.
Pozor také na znak "rovnítka" =. Pokud se objeví v hodnotě pozičního parametru, může být předchozí textová hodnota tohoto parametru chybně interpretována jako identifikátor pojmenovaného parametru (což vysvětlujeme níže). Stává se to poměrně často, pokud chcete jako poziční parametr šablony použít externí link nebo parametrizovaný HTML element (viz úkol T16235). Vyhnete se mu, pokud místo pozičních parametrů použijete parametry pojmenované, resp. očíslované.

Číslované parametry

Předávané parametry lze identifikovat podle čísla už při jejich předání:

{{Thankyou|2=Tonda|1=tvé přátelství}}

Tentokrát jsou šabloně {{Thankyou}} předané dva očíslované parametry {{{1}}}=tvé přátelství a {{{2}}}=Tonda. A přestože byly v šabloně uvedené v obráceném pořadí,jsou zpracované takto:


Díky… za tvé přátelství. Zdraví Tonda


To se hodí, obzvláště pokud by mohl některý z parametrů obsahovat znak "=".
Příklad
{{Thankyou|1=přidání "="|2=Tonda}}

zobrazí se:


Díky… za přidání "=". Zdraví Tonda

  Varování: Pokud ale použijete k identifikaci některého parametru číslo, tak byste měli uvést identifikátor i u těch ostatních.

Pojmenované parametry

Místo čísel můžete použít jako identifikátory i textové řetězce. V tomto případě by se obsah šablony změnil na:

'''Díky...'''
za {{{reason}}}.
Zdraví {{{signature}}}

V šabloně nyní místo čísla použijeme pro první parametr {{{reason}}} a pro druhý {{{signature}}}:

{{Thankyou|signature=Tonda|reason=to že jsi tím, kým jsi}}

V tomto případě šablona {{Thankyou}} převezme parametry {{{{reason}}}=to že jsi tím, kým jsi a {{{signature}}}}=Tonda a vytvoří:


Díky… za to že jsi tím, kým jsi. Zdraví Tonda


Pojmenované parametry rozlišují velká a malá písmena, takže:

{{Thankyou|signature=Tonda|Reason=to že jsi tím, kým jsi|reason=tohle zobrazím, protože u identifikátorů záleží na psaní velkých a malých písmen}}

zobrazí:


Díky… za tohle zobrazím, protože u identifikátorů záleží na psaní velkých a malých písmen. Zdraví Tonda


Výhodou použití pojmenovaných parametrů ve vaší šabloně, kromě toho, že lze předat parametry v jiném pořadí, je i to, že je kód šablony snáze pochopitelný, a to i při použití mnoha parametrů.

Výchozí hodnoty

Pokud převedete šablonu, která očekává parametry, ale neposkytnete jejich argumenty, tímto způsobem:

{{Thankyou}}

v příkladu s číslovanými parametry, uvedeném výše, získáte následující:


Díky… za {{{1}}}. Zdraví {{{2}}}


Vzhledem k tomu, že nebyly předány žádné argumenty, představuje šablona samotné parametry namísto jejich příslušných hodnot. V těchto případech může být užitečné definovat výchozí hodnoty pro parametry, tj. hodnoty, které budou použity, pokud nebude předána žádná hodnota. Například pokud se obsah šablony změní na:

'''Děkuji...'''
za {{{reason|všechno}}}.
kdo, {{{signature|Já}}}

pak {{reason|všechno}} definuje, že pokud není poskytnut žádný argument pro parametr {{{reason}}}, pak bude použita hodnota všechno. Podobně {{{signature|Já}}}, výchozí parametr {{{signature}}} má hodnotu . Výsledkem opětovného převedení šablony bez předání argumentu je následující:


Díky… za všechno. Zdraví Já


The value of a parameter can be an empty string. For example, in {{foo|bar=}} or {{foo|bar=|baz=qux}}, the foo template considers the bar parameter to be "". This is different from omitting the parameter altogether, which leaves it undefined and triggers the default value mechanism described above.

K určení alternativních názvů parametrů se často používají výchozí hodnoty. Pokud máte například {{{a|{{{b|}}} }}}, šablona nejprve vyhledá parametr s názvem "a". Pokud není nastaven, použije parametr s názvem "b". Pokud není nastaveno ani "a" ani "b", nevypíše se nic.


Hodnocení

Toto je pokročilé téma, které můžete přeskočit, pokud jej nepotřebujete.

Obecně řečeno, parametry šablony jsou nahrazeny do šablony po tokenizaci (dělání symbolů), ale tak, jak jsou. Nejsou hodnoceny, dokud nejsou použity.

To má několik důsledků. First of all, if you have a Template:Start containing {{mytemplate, and a Template:End containing |foo=bar}}, and put {{start}}{{end}} on a page, mytemplate isn't transcluded, because tokens like "|" cannot be added by a template and keep their special meaning in templates. K ovládání názvu parametru nebo šablony můžete stále používat šablony, ale nemůžete rozdělit volání šablony mezi více šablon.

Druhým důsledkem je odstranění mrtvého kódu. If you make a template call like {{foo|{{DISPLAYTITLE:Bar}} }}, and Template:Foo does not contain {{{1}}}, then the displaytitle is not used, since it is only evaluated when needed, and it there is no parameter to substitute it into, so it is never evaluated. This usually comes into play when using Extension:ParserFunctions, and can be especially noticed when used in combination with the int: magic word that varies by user language.

Template calls starting with the magic word subst: or safesubst: are evaluated in a separate first pass that only happens at save time, along with ~~~~ and links using the pipe trick. If they cannot be evaluated during the first pass, subst: calls are ignored, and safesubst: are treated as if a normal template.

Mnoho, ale ne všechny funkce analyzátoru, značky analyzátoru a transkludované speciální stránky nejsou přímo zahrnuty jako šablony, ale místo toho jsou nahrazeny "značkou stripu". To znamená, že nemůžete manipulovat s výsledky pomocí funkcí analyzátoru, jako je padleft: nebo podobných funkcí z rozšíření, protože místo výsledku funkce analyzátoru vidí značku stripu.


Rekurze v šablonách

Zahrnutí šablony samo o sobě nespustí MediaWiki do nekonečné rekurze (určitá procedura nebo funkce je znovu volána dříve, než je dokončeno její předchozí volání). MediaWiki zastaví rekurzi tučným názvem šablony. Pokud je například obsah Template:Aaaa a {{Aaaa}} z, zobrazí se "a a Template loop detected: Template:Aaaa z z".

Forbidden idiom

This safeguard precludes a potentially useful template idiom where a template self-normalizes its own calling arguments. In this forbidden example template:d can either be called {{d|20200311}} or {{d|y=2020|m=3|d=11}}. If called in the first manner, it recurses into itself with the second argument structure (obtained using string parser functions), which then follows a unified processing path.

{{#if:{{{1|}}}|{{d|y={{#sub:{{{1}}}|0|4}}|m={{#sub:{{{1}}}|4|2}}|d={{#sub:{{{1}}}|6|2}}}}|<!-- processing path with arguments y,m,d regardless of original call pattern -->}}

If template:d is modified to recurse into template:d/2 and template:d/2 is an identical manual copy of template:d this idiom works fine as the self-recursion safeguard operates dynamically and not statically.

A feasible way for the MediaWiki software to loosen the self-recursion rule would be to require that each recursive call have a distinct argument count from all previous active calls, at most once recursing with the argument count non-decreasing. That would provide a strong guarantee against infinite self-recursion while enabling useful idioms such as the one described here in a flexible manner.

If the processing path is of low complexity, a simple solution using only one template is to handle each calling convention on a separate if/else branch, duplicating the logic of the processing path within each case. If the processing path is more complex, each call-structure case can delegate to an implementation template with a unified call structure which provides the final template behaviour.

Tables in parameters

Since the syntax for wikitables involves pipes in single braces ({ }) and using the pipe trick will not work in transclusion parameters, one will have to create a table as a separate page and transclude it from there.[1]

Zahrnutí kontrolní šablony

Ve výchozím nastavení je obsah šablony zobrazen jako celek. A to jak při přímém prohlížení, tak při zahrnutí na jinou stránku. Můžete však určit, pomocí značek ‎<noinclude>, ‎<includeonly> a ‎<onlyinclude>, které části šablony se budou zobrazovat a zahrnovat.

Všechno mezi ‎<noinclude> a ‎</noinclude> bude vidět pouze tehdy, když se stránka šablony prohlíží přímo, ale ne, když je zahrnuta do jiné stránky. To je užitečné, pokud chcete do šablony zahrnout text nebo kód, který nechcete šířit na žádné stránky, které jej obsahují, jako například:

  • Odkazy při kategorizaci samotné šablony.
  • Mezijazyčné odkazy na podobné šablony v jiných jazycích.
  • Vysvětlující text k použití šablony.

Podobně bude cokoli mezi ‎<includeonly> a ‎</includeonly> zpracováno a zobrazeno pouze při zahrnutí stránky, ale ne při přímém prohlížení stránky šablony. To je užitečné v situacích, jako například:

  • Kategorizace stránek obsahujících šablonu. Poznámka: Při změně kategorií použitých šablonou tímto způsobem nemusí být kategorizace stránek, které tuto šablonu obsahují, aktualizována okamžitě, ale až za nějaký čas: Zpracovává ji fronta úloh . Chcete-li vynutit změnu kategorizace konkrétní stránky, otevřete ji pro úpravy a uložte ji beze změn.
  • Zajištění, že kód šablony nebude spuštěn při prohlížení samotné stránky šablony. Obvykle je to proto, že očekává parametry a provedení bez parametrů má nežádoucí výsledek.

Všechno mimo ‎<noinclude> a ‎<includeonly> je zpracováno a zobrazeno normálně. To znamená, když se stránka šablony prohlíží přímo nebo když je šablona zahrnuta na jiné stránce. Důraz je kladen na to, co je uvnitř těchto dvou značek.

Všechno mimo ‎<onlyinclude> tagy je při převodu vyřazeno. Dokonce i sekce označené pouze includeonly (včetně) jsou při převodu zahozeny, pokud nejsou označeny jako onlyinclude (zahrnout pouze). Důraz je kladen na to, co je mimo tuto značku.

Je také možné vnoření těchto značek.

Tři značky pro částečný přechod umožňují všechny možné kombinace toho, co je zpracováno a vykresleno. Roli plní i komentáře.

Organizování šablon

Aby byly šablony efektivní, uživatelé je musí jednoduše najít a zjistit, jak je správně používat.

Uživatelé je mohou najít:

  1. Klikněte na Speciální stránky > Všechny stránky
  2. V seznamu Jmenný prostor: zvolte Template a klikněte na Přejít.

Chcete-li poskytnout informace o způsobu použití, připojte na stránku šablony takovýto příklad:

<noinclude>
== Použití ==
Uživatelé vítejte:
{{Thankyou|reason=tvůj důvod|signature=tvůj podpis}}
</noinclude>

Redaktor potom podobnou stránku vytvoří tak, že příklad jednoduše zkopíruje.

Propojení na šablonu

Stránku šablony lze propojit s jakoukoli jinou stránkou wiki. Například odkaz Template:Navbar je generován pomocí wikicode [[Template:Navbar]].

Na mnoha wikinách Template:Tl lze použít k vytvoření odkazu na šablonu formátovanou způsobem, který ukazuje wikicode "double curly-braces" nezbytný k převedení šablony bez skutečného provedení převodu. Například kód {{tl|Navbar}} může být použit k vytvoření odkazu {{Navbar}}.

Tento způsob se běžně používá v dokumentaci šablon, na stránkách nápovědy a na diskusních stránkách při odkazování na šablony. Stejného efektu lze dosáhnout použitím {{[[Template:Navbar|Navbar]]}}, ale použití {{tl}} vyžaduje o dost méně psaní. Na jakékoli dané wiki šablona Tl, pokud existuje, může nebo nemusí vykreslit text v prvku "kód" nebo jako typ monospace. Pokud ne (jako na této wiki), může tak učinit jiná podobně pojmenovaná šablona. Viz například část "Viz také" naší dokumentace Template:Tl.

Kopírování z jedné wiki do druhé

Šablony často vyžadují CSS nebo jiné šablony, takže uživatelé mají často potíže s kopírováním šablon z jedné wiki do druhé. Následující kroky by měly fungovat pro většinu šablon.

MediaWiki code

Pokud máte nová importní práva (konkrétně importupload):

  1. Přejděte na Special:Export na původní wiki a stáhněte soubor .xml s úplnou historií všech potřebných šablon, takto:
    • Do textového pole zadejte název šablony, např. "emplate:Welcome". Zvláštní pozornost věnujte malým a velkým písmenům a zvláštním znakům - pokud není název šablony přesně správný, může dojít k exportu, ale soubor XML nebude mít očekávaná data.
    • Zaškrtněte políčko "Zahrnout šablony".
    • zaškrtněte políčko "Zahrnout jen současnou verzi, ne plnou historii".
    • Klikněte na "Exportovat".
  2. Na nové wiki přejděte na Special:Import a nahrajte soubor .xml.

Pokud nemáte nová importní práva na novou wiki:

  1. Přejděte na šablonu, kterou chcete zkopírovat z původní wiki. Přejděte na stránku úprav a zkopírujte celý wikitext
  2. Na nové wiki přejděte na stránku se stejným názvem jaký má kopírovaná šablona. Stiskněte vytvořit a upravit a vložte wikitext, který jste zkopírovali. V souhrnu úprav každé šablony vytvořte odkaz na původní stránku pro přiřazení.
  3. V původní wiki v editačním okně pod editačním polem sledujte seznam "Templates used on this page" (šablony použité na této stránce). Pro každou uvedenou šablonu postupujte podle těchto pokynů. Totéž udělejte pro jakoukoli šablonu používanou kteroukoli z těchto šablon atd.

Tím se zkopíruje celý nezbytný kód a bude stačit pro některé šablony. Všimněte si, že se exportují pouze prvky stránky analyzované při vykreslování stránky, takže například podstránky dokumentace nejsou exportovány jako součást tohoto procesu. Pokud to nefunguje, zkontrolujte také červené odkazy uvedené v části "Pages transcluded onto the current version of this page:" (stránky přenesené na aktuální verzi této stránky) pod editačním polem. Pokud nějaké existují, opakujte výše uvedené kroky i pro ně a také zkopírujte kód do modulů.

Po úspěšném importu šablony a všech souvisejících šablon z druhé wiki šablonu upravte tak, aby vyhovovala vaší wiki. Chcete-li například změnit logo, odeberte nadbytečné kategorie nebo červené odkazy.

Rozšíření

Přípona často používaná v šablonách je ParserFunctions. Navštivte stránku Nápověda:Rozšíření:ParserFunctions a zkontrolujte, zda se ve zkopírovaných šablonách nepoužívají některé ze zde uvedených funkcí. Pokud ano, musíte nainstalovat rozšíření Rozšíření:ParserFunctions . K jeho instalaci budete potřebovat systémový administrátorský přístup k serveru vaší instalace MediaWiki.

Další závislost, kterou lze použít v šablonách, zejména na Wikipedii, je Lua (programovací jazyk). Dobré je mít {{#invoke: }} v kódu šablony. V případě, že se používá, musíte nainstalovat rozšíření Scribunto . I zde je vyžadován přístup správce systému. Na této stránce naleznete další pokyny k instalaci a používání rozšíření.

CSS a kód JavaScript

Kromě kódu MediaWiki mnoho šablon využívá CSS a některé spoléhají na plné fungování JavaScriptu. Pokud se zkopírované šablony nebudou chovat podle očekávání, může zde být příčina. Chcete-li zkopírovat požadované CSS a JavaScript na svou wiki, obvykle budete potřebovat administrátorská oprávnění, protože budete upravovat systémové zprávy ve jmenném prostoru "MediaWiki:".

  1. Vyhledejte v textu šablony použití tříd CSS (text jako class="foobar"). Pokud se tyto třídy objeví v "MediaWiki:Common.css" nebo "MediaWiki:Monobook.css" na původní wiki, zkopírujte tyto třídy do "MediaWiki:Common.css" na nové wiki a zkontrolujte, zda je šablona v pořádku.
  2. Jestliže zkopírovaná šablona stále nefunguje podle očekávání, zkontrolujte, zda se na původní wiki nachází kód "MediaWiki:Common.js" nebo "MediaWiki:Monobook.js". Pokud ano, můžete jej zkusit zkopírovat na "MediaWiki:Common.js" na nové wiki. Obvykle je vhodné kopírovat kód pouze z důvěryhodných zdrojů a nejprve procházet kód, identifikovat a vybrat části, které jsou relevantní. Můžete najít komentáře, které mohou sloužit jako vodítka pro identifikaci funkčnosti každé části.

Související stránky

Externí odkazy