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:

Numbered parameters
To pass in parameters by number, identify each parameter when passing it:

This time, template  receives parameters   and , though they have been supplied in inverse order, and produces:

Named parameters
The third way of passing parameters is by name instead of numbers. In this case, the template contents would be changed to:

A little thank you... for. hugs,

Within the template, we use  and   to identify each parameter, instead of a number. To pass these parameters by name, identify each parameter when passing it:

In this case, template  receives parameters   and   and produces:

Named parameters are case-sensitive, so:

produces:

The advantage of using named parameters in your template, besides also being flexible in the order parameters can be passed, is that it makes the template code much easier to understand if there are many parameters.

Default values
If you transclude a template that expects parameters, but do not provide their arguments, in this way:

in the numbered parameters example above you would get the following:

Since no arguments were passed in, the template presents the parameters themselves, instead of their respective values. In these cases, it may be useful to define default values for the parameters, i.e. values that will be used if no value is passed in. For example, if the template contents are changed to:

then  defines that if no argument is provided for parameter , then the value   will be used. Similarly,, defaults parameter   to value. Now, transcluding the template again without passing any argument results in the following:

Order of evaluation
With a few exceptions, template parameters are fully evaluated before they are passed to the template. So if one of your parameters is a call to another template, what is actually passed is the expanded parameter.

becomes before it becomes:

In a few circumstances, this order of evaluation makes a difference from the alternative. (The alternative being to check the results of the template call to see if there are additional templates to be expanded.)

First, the name of the template can be expanded at the same time and in the same way as the parameters.

Thus might expand to So that a template called  could display the thank you in the preferred language (however that was determined.)

Secondly, the template being called can't construct a template from pieces to be called later. A template that took the form would not work if was and was.

Thirdly, the parameter being passed is expanded only once, rather than every place the parameter is used in the template. This is more efficient on the mediawiki server.

Finally, the template being called can't stop the parameter from being expanded altogether. Even if a template only uses a parameter in some circumstances, it will always have been expanded before the call was made.

Exceptions to the order of evaluation
In a few circumstances, template parameters are not evaluated before being passed to the template.

Parameters to a  expansion are not evaluated, but are passed literally.

Some magic words are not evaluated as parameters. Their evaluation is delayed because they have side-effects. For example, would not


 * 1) evaluate
 * 2) change the display title of the page and
 * 3) call   with parameter 1 being blank

instead


 * 1)   would not be evaluated (yet)
 * 2)   would be called with parameter 1 being
 * 3) only if   is evaluated in , would the display title of the page be changed.

Which magic words are evaluated late like this has not been fully documented. Known ones include:

Recursion in templates
Including a template in itself won't throw MediaWiki into infinite recursion. MediaWiki will stop the recursion with the template's name in bold. For example, if the content of "Template:Aaaa" is " ", it'll show as "Template:Aaaa" and display Template loop detected: Template:Aaaa.

Control template inclusion
By default, a template's content is displayed in its entirety, both when viewed directly and when included in another page. However, you can control which parts of a template will be seen and included by the use of the,   and   tags.

Anything between  and   will be seen only when the template's page is being viewed directly, but not when it is included in another page. This is useful when you want to include text or code in a template that you do not want to propagate to any pages which include it, such as:


 * Category links when categorizing the template itself
 * interlanguage links to similar templates in other languages
 * Explanatory text about how to use the template

Likewise, anything between  and   will be processed and displayed only when the page is being included, but not when the template page is being viewed directly, and is useful in situations such as:


 * Categorizing pages which include the template. Note: when changing the categories applied by a template in this fashion, the categorization of the pages which include that template may not be updated until some time later: this is handled by the . To force the re-categorization of a particular page, open that page for editing and save it without changes.
 * Ensuring that the template's code is not executed when viewing the template page itself. Typically this is because it expects parameters, and its execution without parameters has an undesired result.

Everything outside  and   is processed and displayed normally; that is, both when the template page is being viewed directly and when the template is included in another page. The focus is on what is inside these two tags.

Everything outside  tags is discarded in the transclusion. Even sections tagged includeonly are discarded in the transclusion unless they are also tagged as onlyinclude. The focus is on what is outside this tag.

Nesting of these tags is also possible.

The three partial transclusion tags enable all possible combinations of what is processed and rendered. Comments also fill a role.

Organizing templates
For templates to be effective, users need to find them, and find out how to use them.

To find them, users can:
 * 1) Click ' > '
 * 2) In the ' list, choose Template and click '.

To give usage information, include an example like this one on the template page:

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.