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 wiki Wikimedie, pokud přidávají šablonu, včetně neregistrovaných uživatelů. Jak výchozí zdrojové, tak vizuální editory jej určitým způsobem zahrnují, stejně jako mnoho skriptů, nástrojů a gadgetů. 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 ""/"" 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 wiki Wikimedie a TemplateData mu umožnilo mít užitečnější rozhraní při přidávání šablon. To bylo okamžitě oficiálně podporováno VisualEditorem. Vzhledem k tomu, že VisualEditor byl rozšířen na různé hlavní wiki Wikimedie jako výchozí funkce od roku 2013 do roku 2016. TemplateData se také stala jejich součástí.

V prosinci 2016 bylo rozhraní VisualEditor zpřístupněno pro úpravy zdrojového kódu jako funkce beta. Bylo nazýváno. To poprvé přineslo funkce TemplateData do úpravy zdroje.

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 wiki Wikimedie. To znamenalo, že TemplateData se stala výchozí součástí vizuálního editoru i zdrojového editoru na wiki Wikimedie.

Přidání nebo úprava TemplateData
Chcete-li přidat nebo upravit TemplateData, nejprve přejděte na stránku šablony, která se nachází v "/Template:Templatename".

Kontrola aktuálního stavu
Před přidáním nebo úpravou TemplateData zkontrolujte, zda má šablona podstránku dokumentace. Poté zkontrolujte, zda šablona již obsahuje TemplateData a pokud ano, zda se nachází na stránce šablony nebo na podstránce dokumentace.

Dokumentace podstránek
Existují dva hlavní způsoby, jak šablony na většině wiki Wikimedie ukládají své poznámky k použití a další data, která by neměla být zahrnuta do samotné šablony, jako jsou kategorie, ve kterých by šablona měla být obsažena:


 * Velká většina šablon uchovává poznámky k použití a další data, která nepatří na samotnou stránku šablony, na podstránce dokumentace: "/Template:Templatename/doc". Na stránkách, jako je tato, šablona {{}} přenese veškerý obsah stránky /doc na stránku šablony, přičemž zdrojový kód šablony bude mnohem čistší.
 * Na šablonách s podstránkami dokumentace budou za nadpisem "Test Template Info-Icon - Version (2).svg Dokumentace šablony" následovat odkazy jako [zobrazit], [upravit], [historie] a [vyčistit].


 * Několik stránek šablony si zachovalo tyto informace na hlavní stránce šablony. Na těchto stránkách to můžete najít tak, že mezi značkami vyhledáte výskyt.

Různé wiki mohou toto vše prezentovat různě. Zřídkakdy mohou hlavní stránky šablon trvale obsahovat dokumentaci, i když jste zkontrolovali vše výše uvedené. Zde uživatel přidá vlastní název stránky /doc mezi " " a " " a poté přidá obsah za " ".

Můžete se také podívat na upozornění v dolní části stránky podobné tomuto: "Výše uvedená dokumentace je převzata ze šablony:Templatename/doc".

Šablony bez podstránek dokumentace
Pokud šablona nemá podstránku dokumentace, vytvořte ji a přesuňte tam dokumentaci šablony (nebo její zástupný symbol). Poté můžete přidat TemplateData na podstránku dokumentace.

Vytvoření podstránky a přesun dokumentace
Chcete-li vytvořit podstránku dokumentace, klikněte na ""/"" na hlavní stránce šablony; vyhledejte značky a jejich obsah (obvykle dole).

Mělo by to vypadat nějak takto:

Můžete také zjistit, že již obsahuje TemplateData. Pokud ano, bude to vypadat nějak takto:

Vyberte vše po " " a před "" a vystřihněte to do schránky nebo uložte do dočasného dokumentu. Smažte " " a ponechte pouze následující:

Uložte stránku šablony.

Chcete-li nyní vytvořit novou podstránku, podívejte se do adresního řádku prohlížeče a na konec adresy URL přidejte /doc. Stiskněte Enter a vyberte možnost vytvoření nové stránky.

Pokud má tato wiki šablonu oznámení {{}}, přidejte ji na začátek nové stránky. Můžete také chtít přidat (pokud to daná wiki podporuje) další šablony, jako je odkaz {{}} nebo {{}}. Další informace naleznete na stránce s dokumentací k šablonám.

Vložte text, který jste vystřihli nebo uložili do předchozího textu (pod šablonu oznámení, pokud existuje).

Zabalte všechny kategorie do značek tak, aby se vztahovaly pouze na hlavní stránku šablony:

Mnoho wiki má šablonu. Tuto šablonu zde použijte, pokud je pravděpodobné, že šablona, kterou upravujete, existuje ve verzi izolovaného prostoru (umístěná v "Template:Templatename/sandbox"), aby se zabránilo použití kategorií na stránce izolovaného prostoru:

Nakonec stránku publikujte.

Nyní můžete přidávat a upravovat TemplateData na podstránce dokumentace pomocí pokynů popsaných v odstavci Metody.

Přidání a úprava TemplateData na hlavní stránce šablony
Pokud nemůžete vytvořit stránku /doc, můžete přidat a upravit TemplateData na hlavní stránce šablony podle pokynů v odstavci Metody.

Pokud má šablona podstránku dokumentace, zkontrolujte na hlavní stránce i na podstránce dokumentace přítomnost TemplateData (značka následovaná polem ve složených závorkách:  ).

Alternativně může tuto kontrolu provést za vás rozšíření TemplateData. Klikněte na "" nebo "" na kterékoli stránce. Pokud šablona již obsahuje TemplateData na kterékoli stránce, uvidíte v horní části stránky žluté upozornění, které říká:



nebo

Pokud šablona obsahuje TemplateData na své podstránce dokumentace

Pokud má šablona na své podstránce dokumentace TemplateData, je to stránka, kterou byste měli upravit. Můžete to udělat kliknutím na "[edit]" umístěným za nadpisem " Dokumentace šablony" (nebo podobným), nebo, pokud jste již na stránce /doc, kliknutím na "" nebo "" nahoře. Chcete-li přidat nebo upravit TemplateData, postupujte podle pokynů v Metodách.

Pokud má šablona na hlavní stránce TemplateData

Pokud má šablona na hlavní stránce TemplateData, máte opět dvě možnosti:


 * Můžete se buď přesunout na jeho podstránku dokumentace. Toto je preferovaná možnost.


 * Nebo jej můžete upravit na hlavní stránce šablony.

Přesun TemplateData na podstránku dokumentace

Chcete-li to provést, klikněte na "" nebo "" na hlavní stránce šablony a vyhledejte značky, které jsou součástí značek. Mělo by to vypadat nějak takto:

Z kódu vyjměte pouze značky a jejich obsah a poté stránku uložte.

Dále upravte podstránku dokumentace kliknutím na "[upravit]" umístěnou za nadpisem " Dokumentace šablony" (nebo podobně).

Zadejte nadpis, například "TemplateData", a pod něj vložte TemplateData.

Nyní můžete upravovat TemplateData na základě pokynů v Metodách.

Úprava dat šablony na hlavní stránce šablony

Pokud si nepřejete přesunout data TemplateData na stránku /doc, můžete je upravit na hlavní stránce šablony. Viz Metody, jak upravit TemplateData.

Pokud šablona ještě nemá TemplateData, ale má podstránku dokumentu

Pokud šablona ještě nemá TemplateData, měli byste ji přidat na podstránku dokumentace.

Udělejte to kliknutím na "[upravit]" umístěným za nadpisem " Dokumentace šablony" (nebo podobným), nebo, pokud jste již na stránce /doc, kliknutím na "" nebo " " nahoře. Zadejte nadpis, například "TemplateData", a poté je přidejte pod tento nadpis. Sekce Metody vysvětluje, jak přidat TemplateData.

Metoda editoru TemplateData
Toto je jednoduchý způsob, jak přidat nebo upravit TemplateData, doporučený pro méně zkušené uživatele.

Editor TemplateData je grafické uživatelské rozhraní pro přidávání a úpravy TemplateData. Je součástí rozšíření TemplateData, které je dostupné na jakékoli stránce šablony (nebo podstránce dokumentace) kliknutím na "" nebo na "".

Po kliknutí na "" nebo "" se nad oblastí úprav a názvem stránky zobrazí tlačítko "".

|453px

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

600px|Nástroj pro úpravy TemplateData na stránce, která dosud neobsahuje TemplateData.

Funkce ve výše uvedeném okně:


 * Horní položka volí jazyk textu rozhraní. Umožňuje zadávat textový obsah ve více jazycích, který se zobrazuje uživatelům na základě jejich nastavení v Předvolbách, není založen na jazyku wiki. Různé wiki mají zcela odlišné databáze šablon. Pokud neexistuje žádný jazyk TemplateData, rozhraní nabídne uživatelům pouze vlastní jazyk wiki, ale uživatelé mohou kliknout na "" a přidat další vstupy. Kód jazyka je zobrazen v závorkách vedle parametrů, na které může být použit, jako jsou popisy a štítky.
 * Další položkou je popis šablony. Toto je popis šablony jako celku. Zobrazuje se uživatelům na mnoha místech v editorech šablon při přidávání šablony. Tento parametr a jeho účinky jsou popsány zde.
 * Třetí položka řídí formátování wikitextu šablony. Tento parametr určuje, jak bude wikitext rozvržen, když uživatel klikne na "", dva hlavní typy jsou  (na jednom řádku) a   (na nových řádcích). Tento parametr a jeho účinky jsou popsány zde.
 * Pokud uživatel zvolí "", může zadat wikitext pod "" podle pravidel uvedených zde, aby vytvořil vlastní rozvržení pro šablonu, když uživatel klikne na "".


 * Čtvrtá položka konfiguruje parametry šablony. Pokud již byly parametry v TemplateData definovány, tato oblast je zobrazí v seznamu. Pokud zdrojový kód šablony specifikuje parametry, pro které neexistují TemplateData, můžete vidět tlačítko označené "". Editor extrahuje tyto návrhy ze zdrojového kódu šablony vyhledáním  nebo  . Kliknutím na "" přidáte tyto parametry pomocí jejich názvů, jak je definováno ve zdrojovém kódu. Nahoře se také objeví zelené upozornění, například "".
 * Ve spodní části okna vidíte tlačítko "". To vám umožní ručně přidat parametr s vlastním názvem.

Pokračujte dalším krokem kliknutím na některý z parametrů v seznamu. To vám umožní upravit informace o tomto parametru.

600px

Všechny tyto funkce a jejich účinky jsou popsány v části O názvu parametru.

Po dokončení klikněte na "". Tím se automaticky vloží TemplateData na konec stránky před značku. Nebo, pokud již existuje, bude aktualizován o nové informace, aniž by se změnila jeho poloha. Text TemplateData bude také vybrán, když kliknete na "".

Editor TemplateData vytvoří parametr  ve spodní části TemplateData (nebo jej, pokud již existuje, aktualizuje). obsahuje aktuální parametry TemplateData v pořadí, v jakém byly zobrazeny editorem TemplateData. můžete změnit přetažením parametrů nahoru a dolů v editoru TemplateData pomocí tří vodorovných pruhů vlevo. a jeho účinky jsou popsány zde.

Poté klikněte na "" pro uložení revize stránky.

Ruční metoda
TemplateData můžete také přidat nebo upravit ručně. Struktura TemplateData je založena na standardu JSON, ale nemusíte se učit JSON, abyste se zjistili, jak umístit TemplateData. TemplateData se řídí několika velmi jednoduchými pravidly a přijímá pouze několik desítek možných předdefinovaných parametrů a hodnot, obvykle ve formátu.

Ruční přidávání TemplateData

Na zřetel:


 * Pokud přidáváte TemplateData na podstránku dokumentace šablony (doporučeno), můžete je přidat kamkoli na stránku. Zkontrolujte, zda má Wikipedie ve vašem jazyce preferované umístění. Například na anglické Wikipedii jsou TemplateData obvykle v dolní části stránky s dokumentací. Na německé Wikipedii je obvykle nahoře.
 * Pokud přidáváte TemplateData na hlavní stránku šablony (nedoporučuje se; viz Předchozí kontroly), musíte je umístit mezi tagy .

Click "" or "" 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 #TemplateData parameters. 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, že parametry, například v objektu, zůstávají uvnitř tohoto objektu. Jinak při pokusu o uložení spustíte chybu "(properlyname)".

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 ani,   ani   nejsou pro parametr nastaveny jako  , jeho stav se v dokumentaci TemplateData zobrazí jako.

Až budete hotovi, stiskněte "". 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.

/ Bad JSON
K těmto chybám dochází při ukládání TemplateData, obvykle ručně upravovaných, s neplatným kódem JSON (duplicitní klíče/parametry, koncové nebo chybějící čárky atd.) ve VisualEditoru nebo v editoru wikitextu 2017.

"" se objeví ve VisualEditoru a editoru wikitextu 2017. Při úpravách v editoru GUI TemplateData se zobrazí "Bad JSON format" (špatný formát JSON).

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 "" 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ď  nebo.

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 "format" vlastnosti bude ...
Pokud parametr  existuje, ale jeho hodnota není ,   nebo platný řetězec formátu, zobrazí se chybová zpráva: "".

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