Help:Templates/cs

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í (extensions) a mediálních souborů neexistuje centrální úložiště šablon. Do šablony lze nově psát nebo uložit duplicitní práci, která již byla provedena, exportovat z jiné wiki, např. Wikipedia a poté importovat do cílové wiki.

Vytvoření
Šablony jsou standardní wiki stránky, jejichž obsah je navržen tak, aby byl uvnitř jiných stránek  přeložen (vložen). Šablony se řídí konvencí, že název je předponou " " a přiřadí jej tomuto jmennému prostoru; kromě toho je můžete vytvořit jako každou jinou wiki stránku.

Nejjednodušší použití šablon je následující. Pokud vytvoříte stránku s názvem „Template:Welcome“ (Šablona: Vítejte) s obsahem:

Ahoj! Vítejte na wiki.

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

na jakékoli jiné stránce se zobrazí text „Ahoj! Vítejte na wiki.“. Obsah šablony je „přenesen“ na tuto stránku, tj. Je integrován na stránce.

Kód  můžete vložit na kterémkoli místě které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 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:


 * - 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.
 * - 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.
 * - 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:en:Help:Substitution.
 * zahrnuje šablonu ve formě, která ji zobrazuje jako syrovou syntaxi wiki (způsob  ano), když je stránka, která ji obsahuje, načtena.

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:


 * zahrnuje
 * zahrnuje
 * zahrnuje
 * se nahrazuje obsahem

Pokud takový obor názvů neexistuje, považuje se celý název za šablonu:


 * zahrnuje

Parametry
Pro obohacení mechanismu transkluze umožňuje MediaWiki předávání parametrů do šablony, když je transkluována. Parametry umožňují šabloně produkovat odlišný obsah nebo mají 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:

Poděkování bude mít důvod (v tomto případě „všechno vaše úsilí“) a podpis („Já“). Vaším cílem je, aby se kterýkoli uživatel mohl z jakéhokoli důvodu poděkovat jinému uživateli.

Aby poznámka vypadala všude, kde se používá stejně, můžete definovat například šablonu s názvem. Ačkoli poznámka vypadá podobně, kdykoli uživatel děkuje jinému uživateli, jeho konkrétní obsah (tj. Důvod a podpis) se bude lišit. Z tohoto důvodu byste "Důvod" a "Podpis" měli předat jako parametry. Pokud ignorujeme zbývající prvky pro formátování rámečku a umístění obrázku, bude hlavní obsah šablony následující:

Všimněte si použití  a. Toto je způsob, jak v rámci šablon identifikovat parametry, které budou předány při použití šablony. Všimněte si, že v rámci šablony je každý parametr obklopen třemi složenými závorkami:. To se liší od běžného použití názvu šablony.

Při použití šablony na stránce vyplníte hodnoty parametrů oddělené znakem „svislítko“. MediaWiki umožňuje předávání parametrů do šablony třemi způsoby: anonymně, číslováním a pojmenováním.

Anonymní parametry
Chcete-li předat anonymní parametry, zadejte postupně seznam hodnot těchto parametrů:

V tomto případě,  šablona přijímá parametry   a , vytvoří:

Pořadí, ve kterém jsou předávány anonymní parametry, je pro jeho chování zásadní. Obrácení pořadí parametrů:

by přineslo tento výsledek:

Číslované parametry
Chcete-li předat parametry podle čísla, identifikujte každý parametr při jeho předávání:

Tentokrát šablona  přijímá parametry   a , i když byly dodány v obráceném pořadí a produkují:

Pojmenované parametry
Třetí způsob je předávání parametrů namísto čísel. V tomto případě by se obsah šablony změnil na:

Děkuji... za. kdo,

V šabloně používáme parametr  a   místo čísla. Chcete-li tyto parametry předat jménem, identifikujte při předávání každý parametr:

V tomto případě šablona  přijímá parametry   a   a produkuje:

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

zobrazí:

Výhodou použití pojmenovaných parametrů ve vaší šabloně, kromě toho, že lze předat parametry v objednávce, je to, že kód šablony je mnohem snáze pochopitelný, pokud existuje mnoho parametrů.

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

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

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:

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

Pořadí hodnocení
S několika výjimkami jsou parametry šablony vyhodnoceny před jejich předáním do šablony. Pokud je tedy jedním z vašich parametrů volání do jiné šablony, je skutečně předán i rozšířený parametr.

Z se stává než se zobrazí:

Za několika okolností se toto pořadí hodnocení změní z alternativy. (Alternativou je kontrola výsledků volání šablony, abyste zjistili, zda existují další šablony rozšíření.)

Nejprve lze název šablony rozbalit současně a stejným způsobem jako parametry.

Tím pádem se může rozšířit na Aby šablona s názvem  mohla zobrazit poděkování v preferovaném jazyce (nicméně to bylo určeno).

Za druhé, volaná šablona nemůže sestavit šablonu z kusů volaných později. Šablona, která měla podobu nebude fungovat když  byl a byl.

Za třetí je předávaný parametr rozšířen pouze jednou, nikoli každé místo, kde je parametr použit v šabloně. To je víc efektivní na serveru Mediawiki.

Volaná šablona nakonec nemůže parametr rozšířil úplně. I když šablona používá pouze parametr za některých daných okolnostech bude vždy před provedením zprávy rozšířena.

Výjimky z pořadí hodnocení
Za několika okolností nejsou parametry šablony před předáním do šablony vyhodnoceny.

Parametry pro rozšíření  nejsou vyhodnoceny, ale jsou předávány doslova.

Některá magická slova nejsou vyhodnocena jako parametry. Jejich hodnocení je zpožděno, protože mají vedlejší účinky. Například: nebude


 * 1) vyhodnocen
 * 2) změněn zobrazovaný název stránky a
 * 3) volání   s parametrem 1 je prázdné

namísto


 * 1)   by nebyl hodnocen (zatím)
 * 2) Volání   s parametrem 1 je
 * 3) pouze pokud je   vyhodnoceno v , změnil by se zobrazovaný název stránky.

Magická slova která jsou hodnocena pozdě, protože to nebylo úplně zdokumentováno. Mezi známé patří:

Rekurze v šablonách
Zahrnutí šablony samo o sobě nespustí MediaWiki do nekonečné rekurze (určitá procedura nebo funkce 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“ „ “, zobrazí se jako „Template:Aaaa“ a zobrazí Zjištěná smyčka šablony: Template:Aaaa.

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, které části šablony se budou zobrazovat a zahrnout pomocí značek,   a.

Všechno mezi  a   bude vidět pouze tehdy, když se stránka šablony prohlíží přímo, ale ne, když je zahrnuta na jiné stránce. 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  a   zpracováno a zobrazeno pouze při zahrnutí stránky, ale ne při přímém prohlížení stránky šablony a je užitečné v situacích, jako například:


 * kategorizace stránek, které obsahují š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 . 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 jeho provedení bez parametrů má nežádoucí výsledek.

Všechno mimo  a   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  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" (pouze zahrnout). 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. Komentáře také plní roli.

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 ' > '
 * 2) V seznamu ' zvolte Template a klikněte na '.

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

Usage
Welcome users:

Then, an editor can simply copy and paste the example to use the template.

Linking to a template
A template page can be linked to like any other wiki page. For example, the link is generated using the wikicode.

On many wikis, Template:Tl can be used to provide a link to a template formatted in a way that shows the "double curly-braces" wikicode necessary to transclude the template without actually doing the tranclusion. For example, the code  may be used to create the link Navbar.

This construct is commonly used in template documentation, on help pages, and on talk pages when referring to templates. The same effect can be achieved by using, but the tl approach involves much less typing. On any given wiki the Tl template, if it exists, may or may not render the text in a "code" element, as shown here. If not, another similarly named template may do so. See, for example, the "See also" section of the documentation of en:Template:Tl at the English Wikipedia.

Copying from one wiki to another
Templates often require CSS or other templates, so users frequently have trouble copying templates from one wiki to another. The steps below should work for most templates.

MediaWiki code
If you have import rights (Specifically importupload) on the new wiki:


 * 1) Go to Special:Export on the original wiki, and download an .xml file with the complete history of all necessary templates, as follows:
 * 2) * Enter the name of the template in the big text box, e.g. "Template:Welcome". Pay special attention to capitalization and special characters — if the template name isn't exactly correct, the export may still occur but the .xml file will not have the expected data.
 * 3) * Check the box "".
 * 4) * Uncheck the box "".
 * 5) * Click "".
 * 6) Go to Special:Import on the new wiki and upload the .xml file.

If you don't have import rights on the new wiki:


 * 1) Go to the template you want to copy from the original wiki. Go to the edit page, and copy all the wikitext
 * 2) On the new wiki, go to the page with the same name as the template you copied. Hit create/edit and paste the wikitext you copied. In the edit summary of each template, link to the original page for attribution.
 * 3) Back in the original wiki at the edit window, below the edit box, look at the list of "Templates used on this page". For each template listed follow these instructions. Also do that for any template used by any of these templates, and so on.

This will copy the entire code necessary, and will suffice for some templates. If it doesn't work also check for red links listed under "Pages transcluded onto the current version of this page:", below the edit box. If there are any repeat the above steps for these as well.

After successfully importing the template and all its linked templates from the other wiki, edit it to change customisations to suit your wiki. For example to change a logo, remove redundant categories or red links.

Extensions
An extension often used in templates is ParserFunctions. Visit page and check if any of the functions listed there are used in the templates you've copied. If so, you have to install the extension. To install it, you'll need system admin access to the server of your MediaWiki installation.

Another dependency that may be used in templates, especially those on Wikipedia, is Lua. Having  in template code is a good sign for it. In case it's used, you need to install the extension and system admin access is required too. See that page for more instructions about installing and using the extension.

CSS and JavaScript code
Besides MediaWiki code, many templates make use of CSS and some rely on JavaScript to work fully. If the copied templates are not behaving as expected, this may be the cause. To copy the required CSS and JavaScript to your wiki you'll normally need to have admin privileges, because you'll be editing system messages in the "MediaWiki:" namespace.


 * 1) Look for the use of CSS classes (text like  ) in the template text. If those classes appear in "MediaWiki:Common.css" or "MediaWiki:Monobook.css" on the original wiki, copy those classes to "MediaWiki:Common.css" on the new wiki and check if the template is now fine.
 * 2) If the copied template is still not working as expected, check if there is code in "MediaWiki:Common.js" or "MediaWiki:Monobook.js" on the original wiki. If so, you can try copying it to "MediaWiki:Common.js" on the new wiki. Normally, it is a good idea to only copy code from trusted sources, and first browsing the code to identify and select the parts that are relevant. You may find comments that can serve as clues to identify the functionality of each part.