Help:TemplateData/cs

 je rozšíření, které ukládá informace a parametry spojené s šablonou wikitextu a zpřístupňuje je editačnímu rozhraní, které je může načíst a prezentovat v editoru šablon – to vše pomáhá uživatelům přidávat a upravovat šablony na stránky.

Od dubna 2019 je funkce TemplateData součástí výchozího uživatelského prostředí pro všechny uživatele na všech Wikimedia wiki, když přidávají šablonu, včetně neregistrovaných uživatelů. Výchozí zdroj i vizuální editory jej nějakým způsobem začleňují. Pokud máte vlastní wiki, budete muset nainstalovat.

Přidání TemplateData do šablony pro použití tohoto rozšíření v podstatě spočívá ve vložení malého, jednoduchého bloku kódu JSON (vysvětleno níže) na stránku dokumentace šablony. Můžete to udělat ručně nebo pomocí editoru TemplateData, grafického uživatelského rozhraní, ke kterému máte přístup na stránkách šablony "Edit"/"Edit source" (Upravit/Upravit zdroj) na wiki s nainstalovaným rozšířením TemplateData. JSON obsahuje seznam parametrů šablony a informace o těchto parametrech a o šabloně jako celku (podrobnosti viz níže).

Šablony, které obsahují TemplateData, zobrazí tyto informace v uživatelském rozhraní, pokud uživatel přidá šablonu. V některých případech se změní chování editoru, když jej použijete k úpravě nebo vložení dané šablony. Což uživatelům výrazně usnadní provádění kroků potřebných k přidání dané šablony.

Historie
TemplateData byl původně vyvinut na začátku roku 2013 s ohledem na, což bylo v té době ve fázi testování MediaWiki. VisualEditor je hlavní vizuální editační rozhraní pro Wikimedia wikis a TemplateData mu umožnilo mít užitečnější rozhraní při přidávání šablon. To bylo oficiálně podporováno VisualEditor okamžitě. Vzhledem k tomu, že VisualEditor byl rozšířen na různé hlavní Wikimedia wiki jako výchozí funkce od roku 2013 do roku 2016, TemplateData se také stala jejich součástí.

In December 2016, the VisualEditor interface was made available for editing source code as a beta feature. This was termed the 2017 wikitext editor. This brought the features of TemplateData to source editing for the first time.

V březnu 2018 společnost Sam Wilson vyvinula rozšíření, rozšíření editoru GUI pro výchozí zdrojový editor Wikimedia, (jinak známý jako editor wikitext 2010), jehož cílem je usnadnit proces přidávání šablon pomocí informací z TemplateData. V dubnu 2019 byl TemplateWizard nastaven jako výchozí součást editoru wikitext 2010 na všech Wikimedia wiki. To znamenalo, že TemplateData byla nyní výchozí součástí vizuálního editoru i zdrojového editoru na Wikimedia wikis.

Adding or editing TemplateData
To add or edit TemplateData, first navigate to a template's page, located at "/Template:Templatename".

Checking the current state
Before adding or editing TemplateData, check whether the template has a documentation subpage. Then check whether the template already contains TemplateData and, if so, whether it's located on the template page or the documentation subpage.

Documentation subpages
There are two main ways templates on most Wikimedia wikis store their usage notes and other data that shouldn't be included in the actual template itself, like categories the template should be contained in:

On pages like this, the Documentation template transcludes all the /doc page's content onto the template page, keeping the template's source code much cleaner.
 * The vast majority of templates keep usage notes and other data that doesn't belong on the template page itself on a documentation subpage: "/Template:Templatename/doc".
 * On templates with documentation subpages, the "Test Template Info-Icon - Version (2).svg Template documentation" heading will be followed by links such as [view], [edit], [history] and [purge].

You can spot it on these pages by looking for an occurrence of  between  tags.
 * A few template pages have retained that information on the template's main page.

Different wikis may present all this differently. Rarely, main template pages may still contain documentation even when you've checked all of the foregoing; here, a user will have added a custom /doc page title between " " and " " and then added content after " ".

You can also look for a notice at the bottom of the page similar to this: "The above documentation is transcluded from Template:Templatename/doc".

Templates without documentation subpages
If a template doesn't have a documentation subpage, create it and move the template's documentation there (or a placeholder for it). Then you can add TemplateData to the documentation subpage.

Creating the subpage and moving the documentation
.

To create the documentation subpage, click "Edit"/"Edit source" on the main template page; look for the tags and their contents (usually at the bottom).

It should look something like this:

You may also find that it already contains TemplateData. If so, it will look something like this:

Select everything after " " and before "" and cut it into your clipboard or save it in a temporary document. Delete " ", leaving only the following:

Save the template page.

Now, to create the new subpage, look at your browser's address bar and add  to the end of the URL. Press Enter, then choose the option to create a new page.

If this wiki has a Documentation subpage notice template, add it at the top of the new page. You may also wish to add other templates, such as a Purge button or Purge link (if supported by the wiki in question). See m:Help:Template documentation for more info.

Insert the text you cut or saved in the previous text (beneath the notice template, if applicable).

Wrap any categories in tags so that they apply only to the template's main page:

Many wikis have a template. Use this template here if it's likely that the template you're editing exists in a sandbox version (located at ) in order to prevent the categories from applying to the sandbox page:

Finally, publish the page.

You can now add and edit the TemplateData on the documentation subpage using the instructions described in.

Adding and editing TemplateData on the main template page
If you can't create the  page, you can add and edit TemplateData on the template's main page by following the instructions in.

If a template has a documentation subpage, check both the main page and the documentation subpage for the presence of TemplateData (the  tag followed by an array inside curly brackets:   ).

Alternatively, the TemplateData extension can perform this check for you. Click "Edit" or "Edit source" on either page. If the template already has TemplateData on either page, you will see a yellow notice at the top of the page saying either:


 * "Please note: there is already a TemplateData block on the related page "Template:Templatename/doc"", or


 * "Please note: there is already a TemplateData block on the related page "Template:Templatename""

If the template has TemplateData on its documentation subpage

If the template has TemplateData on its documentation subpage, this is the page you should edit. You can do this by clicking the "[edit]" located after the heading " Template documentation" (or similar), or, if you are already on the /doc page, by clicking "Edit" or "Edit source" at the top. Follow the guidance at to add or edit the TemplateData.

If the template has TemplateData on its main page

If the template has TemplateData on its main page, you once again have two options:


 * You can either move to its documentation subpage. This is the preferred option.
 * Or, you can edit it on the main template page.

Moving TemplateData to the documentation subpage

To do this, click "Edit"/"Edit source" on the main template page, and look for the tags, enclosed within  tags. It should look something like this:

Cut only the tags and their contents out of the code, then save the page.

Next, edit the documentation subpage by clicking the "[edit]" located after the heading " Template documentation" (or similar).

Type a heading, like "TemplateData", then beneath it paste the TemplateData.

You can now edit the TemplateData based on the guidance at.

Editing TemplateData on the main template page

If you do not wish to move the TemplateData to the /doc page, you can edit it on the main template page. See for how to edit TemplateData.

If the template does not yet have TemplateData but has a doc subpage

If the template does not yet have TemplateData, you should add it to the documentation subpage.

Do this by clicking the "[edit]" located after the heading " Template documentation" (or similar), or, if you are already on the /doc page, by clicking "Edit" or "Edit source" at the top. Type a heading, like "TemplateData", then add it beneath this heading. The section explains how to add TemplateData.

Metoda editoru TemplateData
This is a simple way to add or edit TemplateData, recommended for less experienced users.

Editor TemplateData je grafické uživatelské rozhraní pro přidávání a úpravy TemplateData. It is part of the TemplateData extension, available on any template's page (or documentation subpage) by clicking "Edit" or "Edit source".

After clicking "Edit" or "Edit source", you will see a button above the editing area and page title that says "".

Kliknutím na toto tlačítko vstoupíte do editoru TemplateData. Pokud stránka, na které jste, již obsahuje TemplateData, automaticky se zde zobrazí.

Features in the above window:


 * The top item chooses the language of the interface text. It allows you to enter text content in multiple languages, displayed to users based on their settings in Preferences, not based on the wiki's language; different wikis have entirely different template databases. If no language TemplateData exists, the interface will only offer users the wiki's own language, but users can click "Add language" to add more inputs. The language code is displayed in brackets next to the parameters to which it can be applied, such as descriptions and labels.
 * The next item is the template description. This is the description of the template as a whole; it's shown to users in numerous places in the template editors while adding a template. This parameter and its effects are outlined here.
 * The third item controls the wikitext formatting of the template. This parameter determines how the wikitext will be laid out when the user clicks "Insert", the two main types being "inline" (on one line) and "block" (on new lines). This parameter and its effects are outlined here.
 * If the user chooses "Custom", they can enter wikitext under "Custom format string" according to rules outlined here, in order to create a custom layout for the template when the user clicks "Insert".


 * The fourth item configures a template's parameters. If parameters have already been defined in TemplateData, this area displays them in a list. If the template's source code specifies parameters for which no TemplateData exists, you may see a button labeled "Add suggested parameters". The editor extracts these suggestions from the template's source code by looking for  or  . Clicking "Add suggested parameters" will add these parameters using their names as defined in the source code. A green notice will also appear at the top, for example, "2 new parameters were imported: names of parameters".
 * At the bottom of the window you see an "Add parameter" button. This allows you to add a parameter manually with a custom name.

Continue to the next step by clicking any one of the parameters in the list. This will allow you to edit that parameter's info.



All of these features and their effects are outlined in the section #Within a parameter's name.

When finished, click "Apply". This will automatically insert the TemplateData at the bottom of the page before the tag; or, if already present, it will be updated with the new information without changing its position. The TemplateData text will also be selected when you click "Apply".

The TemplateData editor creates a  parameter at the bottom of the TemplateData (or updates it if it already exists). paramOrder contains the current TemplateData parameters in the order in which they were displayed by the TemplateData editor. You can change the paramOrder by dragging the parameters up and down in the TemplateData editor using the three horizontal bars on the left. and its effects are described here.

After this, click "Save" to save your revision of the page.

Manual method
You can also add or edit TemplateData manually. Struktura TemplateData je založena na standardu JSON, ale nemusíte se učit JSON, abyste se naučili, jak umístit TemplateData. TemplateData follows a few very simple rules and accepts only a few dozen possible predefined parameters and values, typically following a  format.

Adding TemplateData manually

Considerations:


 * If you're adding TemplateData on a template's documentation subpage (recommended), you may add it anywhere on the page; check to see if your language's Wikipedia has a preferred location for it. For example, on the English Wikipedia, TemplateData is typically near the bottom of the documentation page; on the German Wikipedia, it is typically at the top.
 * If you're adding TemplateData on a template's main page (not recommended; see #Prior checks), you must make sure to place it inside the  tags.

Click "Edit" or "Edit source" on the respective page, then move to the place in the page where you intend to add TemplateData and write a heading: "TemplateData".

Many wikis have a TemplateData header template that adds a short notice regarding TemplateData. If your wiki does, add it after the heading.

To start adding TemplateData, type an opening and closing tag and a pair of curly brackets on new lines, with an empty line between them:

Next, add an indent on the empty line between the two curly brackets, and start adding parameters. Details for the parameters can be found at. Most are optional; some are highly recommended.

Parameters can be in any order, but what follows is the order that best conforms to TemplateData documentation and makes the content easiest to use for editors:

Ujistěte se také, že parametry, například objektu, jsou v rámci tohoto objektu uchovány nebo zda se při pokusu o uložení zobrazí chyba „Neočekávaná vlastnost“.

Příklad

Here is some example TemplateData for a hypothetical cleanup template. Such a template would display a notice and place the page into a dated category based on the month and year entered. The notice might also contain a link to a talk page section. The TemplateData would look something like this:

The corresponding TemplateData documentation would display as follows:

{	"description": "Use this template to indicate that an article is in need of cleanup.", "format": "inline", "params": { "date": { "label": "Month and year", "description": "The month and year that the template was added", "type": "string", "autovalue": " ", "example": "January 2013", "suggested": true },		"reason": { "aliases": ["1"], "label": "Reason", "description": "The reason the article is in need of cleanup", "type": "string" },		"talk": { "aliases": ["talksection"], "label": "Talk page section", "description": "The section of the talk page containing relevant discussion", "type": "string" }	},	"paramOrder": [ "date", "reason", "talk" ] }

TemplateData parametry
Všechny dostupné parametry TemplateData jsou uvedeny níže s popisem a s příkladem. Jsou také podrobněji uvedeny na Extension:TemplateData#Format.

O názvu parametru
Poznámka: Pokud pro parametr není nastaveno "required" (povinné), "suggested" (navrhované) ani "deprecated" (zastaralé), jeho stav se v dokumentaci TemplateData zobrazí jako "optional" (volitelné).

Až budete hotovi, stiskněte "save" (uložit). Pokud jste udělali chyby, nedovolí vám uložení (což je rušivé, ale znamená, že nic nemůžete zkazit). Pokud narazíte na chyby, vysvětlete na stránce zpětné vazby, co jste se snažili udělat a my vám rádi pomůžeme.

Pokud zneužíváte šablonu hack pro dynamické generování TemplateData, nelze ji před uložením zkontrolovat na chyby.

Všimněte si, že každá položka informací je uzavřena v uvozovkách (s výjimkou  a  ) a je oddělena od dalšího bitu čárkou (pokud není poslední).

Zadejte parametr
Parametr  je určen k tomu, aby editoru šablon signalizoval povahu hodnoty parametru. V některých případech byly editory šablon naprogramovány tak, aby upravovaly uživatelské rozhraní pro určitý parametr podle hodnoty TemplateData, například tak, aby uživateli umožňoval zadávat pouze platné hodnoty, které odpovídají zadanému typu. Tento parametr nemá žádný funkční účinek na parametr šablony nebo jeho hodnotu. Řídí pouze to, jak editoři šablon vidí a zpracovávají parametr v režimu úprav.

How to use

It is used by adding the  parameter, followed by a colon and a space, then adding any of the values listed in the table below in quotation marks.

Example:

Effects

As of February 2020, only 5 of the 13 type values have visible effects in VisualEditor and the 2017 wikitext editor, while 8 have visible effects in TemplateWizard.

The effects of certain values are likely to change as the template editors get updates to support them. One such effort for VisualEditor and the 2017 wikitext editor is tracked in the Phabricator task T55613. A similar effort to get TemplateWizard to support the boolean value is tracked in T200664.

Aktuálně známé účinky jsou následovné.

Vlastní formáty
Při úpravě hodnoty  vytvoříte vlastní formáty zadáním sady symbolů wikitextu pomocí některých předdefinovaných pravidel.


 * - začátek šablony
 * - obsah (např. řetězec, celé číslo nebo parametr). Toto podtržítko slouží k označení minimální délky hodnoty ve znakech a může být opakováno, například . Není-li této délky dosaženo, vyplní zbývající znaky mezerami. To lze použít k zarovnání všech znamének rovná se na konkrétní pozici za parametr (pokud se použije s   pro nové řádky).
 * - potrubí, trubka, svislá čára, svislítko (odděluje parametry)
 * - znaménko rovná se (předchází hodnotě parametru)
 * nebo stisknutí klávesy Enter - nový řádek (ve vstupním poli se zobrazí jako )
 * - mezera (lze použít s  k odsazení nových řádků)
 * - konec šablony

Wikitext by měl splňovat minimálně, jinak dojde k neplatnosti řetězce formátového řetězce.

Prázdná předloha
Můžete zkopírovat prázdnou boilerplate níže a přidat do šablony nová data TemplateData. Zahrnuty jsou pouze nejběžnější značky.

Chyba syntaxe ve formátu JSON / Bad JSON
K této chybě dochází, pokud se pokusíte uložit TemplateData, která obsahuje určité typy neplatných kódů JSON, například duplicitní klíče (parametry) nebo koncové nebo chybějící čárky, v VisualEditor nebo editoru wikitext 2017 (editory založené na JavaScriptu).

"Syntax error in JSON" (Chyba syntaxe v JSON) se zobrazí, pokud se pokusíte takový kód uložit do VisualEditoru nebo do wikitextového editoru 2017, zatímco „Bad JSON format“ (Špatný formát JSON)se zobrazí, pokud se pokusíte otevřít takový kód v editoru GUI TemplateData na stránkách šablon.

These errors can be difficult to detect and come in too many forms to list. The best way to avoid them is to edit template data exclusively with the TemplateData editor; the best way to detect them once they've occurred is to use an external JSON validator, such as JSONLint, which will highlight errors and aid in fixing them.

The 2010 wikitext editor does not check for invalid JSON thanks to an old, unfixed bug. Pages that contain invalid JSON may throw alarming "Internal error" messages. To fix these errors, your best bet is to use a JSON validator (see above).

Požadovaná vlastnost "paramOrder(number)" nebyla nalezena.
K této chybě dochází, pokud uvedete parametr v, který není uveden v. Číslo v hranatých závorkách odkazuje na parametr v, který chybí. To odkazuje na jeho pořadí v sekvenci, ale to je o jeden méně než jeho skutečná pozice, protože  je pole; 0 je první, 1 je druhý atd.

Chcete-li to vyřešit, ujistěte se, že všechny parametry uvedené v  jsou uvedeny v. Alternativně můžete odebrat objekt  a tuto chybu odstranit.

Neplatná hodnota pro vlastnost "paramOrder(number)".
K této chybě dochází, pokud uvedete parametr v, který není uveden v. Číslo v hranatých závorkách odkazuje na parametr v, který by tam neměl být. To odkazuje na jeho pořadí v sekvenci, ale to je o jedno méně než je jeho skutečná pozice, protože  je pole; 0 je první, 1 je druhý atd.

Chcete-li to vyřešit, ujistěte se, že všechny parametry uvedené v  jsou uvedeny v. Alternativně můžete odebrat objekt  a tuto chybu odstranit.

Očekává se, že vlastnost params.parametername.required" bude typu "boolean".
K této chybě dochází, pokud uvozovky umístíte kolem hodnoty buď (required) nebo  (suggested).

Toto jsou booleovské hodnoty, nikoli řetězce, proto nevyžadují žádné uvozovky. Chcete-li to vyřešit, odeberte uvozovky kolem hodnot  nebo   pro tyto parametry.

Očekává se, že "formát" vlastnosti bude ...
Pokud parametr  existuje, ale jeho hodnota není ,   nebo platný řetězec formátu, zobrazí se chybová zpráva: "Vlastnost "format" by měla být "inline", "block" nebo platný formátový řetězec."

Chcete-li to vyřešit, ujistěte se, že hodnota po  se rovná   nebo   a že nedochází k pravopisným chybám. Pokud je to wikitext, ujistěte se, že obsahuje minimálně  a že v syntaxi nejsou chyby, které by normálně způsobily selhání šablony. Jako jsou duplicitní znaménka rovná se nebo chybějící nebo duplicitní složené závorky; viz část #Vlastní formáty pro syntaxi vlastních formátů. Alternativně můžete odstranit tuto chybu pomocí parametru.

Neočekávaná vlastnost "parametername".
This error occurs if you state a parameter that does not exist in TemplateData. This is probably due to spelling mistakes.

Dochází k ní také v případě, že uvedete parametr v jakémkoli objektu TemplateData, který není parametrem daného objektu. Může to být způsobeno pravopisnými chybami, nebo jste možná zapsali parametr jednoho objektu TemplateData pod jiný objekt, ke kterému nepatří.

Například byste mohli napsat parametr  pod kořenový objekt TemplateData namísto uvnitř  :

Pokud je neočekávaný parametr pod parametrem šablony uvnitř, uvidíte jeho název za "params.parametername." omylem.

Chcete-li provést opravu, ujistěte se, že v názvech parametrů nejsou žádné pravopisné chyby a ujistěte se, že vaše parametry jsou správně umístěny. Additionally, make sure you don't state any parameters that don't exist for a TemplateData object. You can check which parameters exist for an object in the section #TemplateData parameters.

Požadovaná vlastnost "params" nebyla nalezena.
K této chybě dochází, pokud v TemplateData není žádný objekt. Toto je nezbytný objekt, protože obsahuje všechny podrobnosti o každém parametru, takže tuto chybu opravte, ujistěte se, že je přidána a že nedochází k pravopisným chybám. Viz část výše o tom, jak přidat parametr.

Omezení a zpětná vazba

 * Chybějící funkce – TemplateData je příkladem nástroje, který byl zpřístupněn s několika funkcemi, v naději, že by uživatelé pomohli řídit vývoj funkcí, které požadovali. Pokud chcete požádat o nové funkce pro TemplateData, dejte nám prosím vědět na.
 * Prodlevy při zobrazování v šablonách – Po přidání TemplateData do šablony by měla být metadata viditelná okamžitě, jakmile se šablona otevře ve vizuálním editoru. Je však možné, že to bude trvat několik hodin, než se metadata zobrazí. Aktualizace můžete vynutit provedením nulové úpravy samotné stránky šablony (nikoli podstránky dokumentace). Chcete-li provést nulovou úpravu, otevřete stránku šablony pro úpravy a stránku uložte bez jakékoli změny a bez přidání souhrnu úprav.
 * Aktuální problémy – Seznam aktuálních chyb a požadavků na funkce je k dispozici v nástroji pro sledování chyb Wikimedia.

Další nástroje

 * : Dialogové okno panelu nástrojů pro zadávání wikitextů šablony pomocí formuláře vytvořeného z TemplateData.
 * TemplateData Wizard: Nástroj, který generuje TemplateData prostřednictvím interaktivního rozhraní.
 * Skeleton TemplateData generator: Nástroj, který čte zdrojovou šablonu wikicodu a snaží se najít všechny použité parametry a vydá dokument kostry s uvedenými parametry.
 * JSONLint: Nástroj, který vám umožní ověřit ručně napsaný JSON, který pomůže najít chyby v syntaxi.
 * [ Seznam všech šablon s TemplateData] na této wiki
 * S dewiki template TemplateData jsou data šablony zobrazena v rámečku a šablona je přidána do kategorie šablon se šablonou data
 * https://query.wikidata.org/ and Query Helper