Nápověda:TemplateData

Poznámka: Úpravou této stránky souhlasíte s uvolněním vašeho příspěvku pod licencí CC0. Více informací získáte na stránce nápovědy veřejné domény. Translate

TemplateData 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 Rozšíření:TemplateData .

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 "Editovat"/"Editovat 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 VisualEditor , 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 Editor wikitextu 2017 . To poprvé přineslo funkce TemplateData do úpravy zdroje.

V březnu 2018 společnost Sam Wilson vyvinula rozšíření TemplateWizard , rozšíření editoru GUI pro výchozí zdrojový editor Wikimedia, WikiEditor (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.

Nezapomeňte zkontrolovat, zda existuje podstránka. Pokud přidáte TemplateData na hlavní stránku šablony, zatímco existuje podstránka s TemplateData, TemplateData na hlavní stránce přepíše data na podstránce.

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 {{Documentation }} 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 " 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 ‎<noinclude> vyhledáte výskyt {{Documentation|content=.

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 "{{Documentation|" a "|content=" a poté přidá obsah za "|content=".

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

Na mnoha wiki Wikimedie můžete vytvořit stránku pouze v případě, že jste tam byli registrovaným uživatelem několik dní a provedli jste minimální počet úprav.

Chcete-li vytvořit podstránku dokumentace, klikněte na "Editovat"/"Editovat zdroj" na hlavní stránce šablony; vyhledejte značky ‎<noinclude> a jejich obsah (obvykle dole).

Mělo by to vypadat nějak takto:

<noinclude>
{{Documentation|content=
== Použití ==

Informace o použití.

== Další příklady nadpisů ==

Další ukázkový obsah

[[Category:Example category|Kategorie:Příklad kategorie]]
[[Category:Example category 2|Kategorie:Příklad kategorie 2]]
}}
</noinclude>

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

<noinclude>
{{Documentation|content=
...
<templatedata>
{
    "description": "",
    "params": {
        "1": {
            "label": "Příklad parametru",
            "description": "Příklad popisu parametru",
            "type": "string"
        }
    }
}
</templatedata>
</noinclude>

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

<noinclude>
{{Documentation}}
</noinclude>

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í {{Documentation subpage }}, 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 {{Purge button }} nebo {{Purge }}. 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 ‎<includeonly> tak, aby se vztahovaly pouze na hlavní stránku šablony:

<includeonly>
[[Category:Example category]]
[[Category:Example category 2]]
</includeonly>

Mnoho wiki má šablonu {{Sandbox other}}. 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:

<includeonly>{{sandbox other||
[[Category:Example category]]
[[Category:Example category 2]]
}}</includeonly>

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 ‎<templatedata> 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 "Editovat" nebo "Editovat zdroj" 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á:

Upozornění: Blok strojového popisu šablony je již uveden na související stránce „[[Šablona:Název šablony/doc]]“.

nebo

Upozornění: Blok strojového popisu šablony je již uveden na související stránce „[[Šablona:Název šablony]]“.

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 "Editovat" nebo "Editovat zdroj" 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 "Editovat" nebo "Editovat zdroj" na hlavní stránce šablony a vyhledejte značky ‎<templatedata>, které jsou součástí značek ‎<noinclude>. Mělo by to vypadat nějak takto:

<noinclude>
{{Documentation}}
<templatedata>
{
    "description": "",
    "params": {
        "1": {
            "label": "Příklad parametru",
            "description": "Příklad popisu parametru",
            "type": "string"
        }
    }
}
</templatedata>
</noinclude>

Z kódu vyjměte pouze značky ‎<templatedata> 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 "Editovat" nebo "Editovat zdroj " nahoře. Zadejte nadpis, například "TemplateData", a poté je přidejte pod tento nadpis. Sekce Metody vysvětluje, jak přidat TemplateData.

Metody

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 "Editovat" nebo na "Editovat zdroj".

Po kliknutí na "Editovat" nebo "Editovat zdroj" se nad oblastí úprav a názvem stránky zobrazí tlačítko "Upravit strojový popis šablony".

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

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 neexistují žádná data šablony jazyka, rozhraní nabídne uživatelům pouze vlastní jazyk wiki, ale uživatelé mohou kliknout na "Přidat jazyk" 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 "Použít", dva hlavní typy jsou "inline" (na jednom řádku) a "block" (na nových řádcích). Tento parametr a jeho účinky jsou popsány zde.

Pokud uživatel zvolí "Vlastní", může zadat wikitext pod "Vlastní formátovací řetězec" podle pravidel uvedených zde, aby vytvořil vlastní rozvržení pro šablonu, když uživatel klikne na "Použít".

• Č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é "Přidat 2 navržené parametry". Editor extrahuje tyto návrhy ze zdrojového kódu šablony vyhledáním {{{parametername}}} nebo {{{parametername|}}}. Kliknutím na "Přidat 2 navržené parametry" 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 "Byly naimportovány 2 nové parametry: názvy parametrů".
• Ve spodní části okna vidíte tlačítko "Přidat parametr". 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.

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

* Editor TemplateData vám nedovolí změnit parametr "Název" na prázdný. Parametry v datech šablony, které nějakým způsobem získávají prázdné řetězce jako názvy, nezpůsobí problémy v editoru wikitextu 2010 s TemplateWizard, ale ani VisualEditor ani editor wikitextu 2017 je vůbec nezobrazí. Toto je v editoru dat šablony jediné povinné pole.

• Kliknutím na "Odstranit informace o parametru" smažete parametr a všechny jeho informace z dat šablony. Nemůžete je v datech šablony načíst nebo vrátit zpět, pokud poté nekliknete na "X". Jakékoli změny provedené po kliknutí na "Použít" můžete vrátit zpět kliknutím na Ctrl+Z.
• Ukončení editace dat šablony po provedení změn vás vyzve k potvrzení, že chcete změny zrušit.

Po dokončení klikněte na "Použít". Tím se automaticky vloží TemplateData na konec stránky před značku ‎</noinclude>. 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 "Použít".

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

Poté klikněte na "Uložit" 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 "parameter": "value".

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 ‎<noinclude>...‎</noinclude>.

Klikněte na "Editovat" nebo "Editovat zdroj" na příslušné stránce, poté se přesuňte na místo na stránce, kam chcete přidat TemplateData, a napište nadpis: "TemplateData".

Mnoho wiki má šablonu {{TemplateData header}}, která přidává krátké upozornění týkající se TemplateData. Pokud vaše wiki ano, přidejte ji za nadpis.

Chcete-li začít přidávat TemplateData, zadejte otevírací a uzavírací značku ‎<templatedata> a pár složených závorek na nové řádky s prázdným řádkem:

<templatedata>
{

}
</templatedata>

Dále přidejte odsazení na prázdný řádek mezi dvě složené závorky a začněte přidávat parametry. Podrobnosti o parametrech lze nalézt na Parametry TemplateData. Většina je volitelná. Některé jsou důrazně doporučeny.

Parametry mohou být v libovolném pořadí, ale následuje pořadí, které nejlépe odpovídá dokumentaci TemplateData a usnadňuje editorům použití obsahu:

<templatedata>
{
    "description": "",
    "format": "",
    "params": {
        "parameter1": {
            "aliases": ["",""]
            "label": "",
            "description": "",
            "type": ""
        }
    },
    "paramOrder": [
    	""
    ]
}
</templatedata>

Ujistěte se, že parametry, například v objektu "params", zůstávají uvnitř tohoto objektu. Jinak při pokusu o uložení spustíte chybu "Neočekávaná vlastnost „správně pojmenovat“.(properlyname)".

Příklad

Zde je několik příkladů TemplateData pro hypotetickou šablonu čištění. Taková šablona by zobrazila upozornění a zařadila stránku do kategorie s datem na základě zadaného měsíce a roku. Oznámení může také obsahovat odkaz na sekci diskusní stránky. TemplateData by vypadala nějak takto:

<templatedata>
{
	"description": "Použijte tuto šablonu k označení, že článek potřebuje vyčistit.",
	"format": "inline",
	"params": {
		"date": {
			"label": "Měsíc a rok",
			"description": "Měsíc a rok, kdy byla šablona přidána",
			"type": "string",
			"autovalue": "{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}",
			"example": "Leden 2013",
			"suggested": true
		},
		"reason": {
			"aliases": ["1"],
			"label": "Důvod",
			"description": "Důvod, proč článek potřebuje vyčistit",
			"type": "string"
		},
		"talk": {
			"aliases": ["sekce diskuse"],
			"label": "Sekce diskusní stránky",
			"description": "Část diskusní stránky obsahující příslušnou diskusi",
			"type": "string"
		}
	},
	"paramOrder": [
		"date",
		"reason",
        "talk"
	]
}
</templatedata>

Odpovídající dokumentace TemplateData by se zobrazila takto:

Použijte tuto šablonu k označení, že článek potřebuje vyčistit.

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Měsíc a rok	datum	Měsíc a rok, kdy byla šablona přidána Example Leden 2013 Auto value {{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}	String	suggested
Důvod	důvod 1	Důvod, proč článek potřebuje vyčistit	String	optional
Sekce diskusní stránky	diskuse sekce diskuse	Část diskusní stránky obsahující příslušnou diskusi	String	optional

Parametry TemplateData

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

• Tyto informace jsou aktuální od listopadu 2021 a mohou se změnit, pokud jsou přidány nové parametry nebo rozhraní pro úpravy šablon získají aktualizace, které podporují stávající parametry nebo zacházejí s určitými parametry odlišně.
• Wiki označení nebude fungovat v popisech ani na štítcích. Jsou to čistě prosté textové řetězce.
• Nové řádky ("\n") v popisech, štítcích, příkladech nebo výchozích nastaveních se nezobrazí v žádném z hlavních editorů (TemplateWizard, VisualEditor nebo editor wikitextu 2017), i když se zobrazují v automaticky generované dokumentaci TemplateData. Ve vstupních formulářích jsou někde nahrazeny prázdným řetězcem a jinde mezerou.

Parametr	Popis	Příklad
description	Parametr "description" popisuje, co šablona dělá. Je volitelný, ale velice doporučený. Výsledky Na stránce dokumentace šablon se popis zobrazí jako prostý text pod podnadpisem "Data šablony pro [název šablony]". Ve všech hlavních editorech (VisualEditor , Editor wikitextu 2017 a Rozšíření:WikiEditor s TemplateWizard) se popis zobrazuje ve dvou hlavních případech: pod názvem šablony v každém návrhu vyhledávání, když uživatel hledá šablonu pod názvem šablony v editoru šablon, zatímco přidává hodnoty do parametrů v šabloně. V editoru wikitextu VisualEditor a 2017 bude popis zkrácen na přibližně 50 znaků pod každým návrhem vyhledávání, za ním následují "...", ale celý popis se zobrazí v hlavním okně editoru šablon. Oba jsou zobrazeny šedým textem. V hlavním okně editoru šablon jsou popisy delší než čtyři řádky (asi 540 znaků) vybaveny samostatným posuvníkem a jsou zobrazeny černým textem. Pokud není uvedeno Pokud parametr popisu neexistuje nebo není zadán, zobrazí se text "Bez popisu." (no description) v dokumentaci TemplateData pod podtitulem "Data šablony pro [název šablony]" (template data for [template name]). Dodatek: V aplikaci VisualEditoru a editoru wikitext 2017 se bude chovat stejně jako šablona, která nemá TemplateData. Místo popisu se zobrazí následující text: „"Šablona:Název šablony" zatím nemá popis, ale na stránce šablony mohou být nějaké informace.“ V editoru wikitext 2010 s TemplateWizard se zobrazí následující text, kde by byl popis (kromě návrhů vyhledávání): „Tato šablona nemá žádný popis.“ To se liší od dvou standardních popisů zástupných symbolů v případech, kdy TemplateData neexistují: „Kvůli chybějícím TemplateData byly parametry pro tuto šablonu vygenerovány automaticky. Uvědomte si prosím, že nemusí být přesné.“ „Pro tuto šablonu nebylo možné určit žádné parametry kvůli absenci dokumentace TemplateData. Šablonu můžete vložit bez parametrů.“	"description": "Šablona pro propojení na kategorii commons",
format	Parametr "format" popisuje, jak by měl být rozložen wikitext šablony. To lze nastavit na standardní formáty "inline" a "block". Uživatel také může zadat sadu wikitextových symbolů pro vytvoření vlastního formátu. Tyto symboly a některé příklady jsou uvedeny v sekci Vlastní formáty. Tento parametr není vyžadován, ale doporučuje se. Výchozí chování, když tento parametr není zadán, je zachování stávajícího formátování pro existující parametry nebo inline formátování pro nově přidané parametry a šablony. Výsledky Inline: ("inline") Když je šablona vložena, rozloží svůj wikitext na jediný řádek bez mezer mezi prvky. Například: {{Foo|bar=baz|qux=quux}} Blok: ("block") Když je šablona vložena, rozdělí své parametry každý na nový řádek s mezerami mezi jednotlivými prvky. Například: {{Foo | bar = baz | qux = quux }} Vlastní formátování: Alternativně, pokud je parametr nastaven na vlastní řetězec wikitextu, podle pravidel uvedených v sekci Vlastní formáty, šablona rozloží svůj wikitext podle daného wikitextu.	"format": "inline"
params	Objekt "params" obsahuje informace pro každý parametr šablony. Je vyžadován a jeho parametry si můžete prohlédnout v sekci Parametry. Měl by obsahovat název každého parametru, za nímž následuje sada sub-parametrů TemplateData uvedených v sekci Název parametru. Pokud existuje více parametrů, umístěte čárku mezi každý parametr objektu, ale žádný nepřidávejte za poslední složenou závorku (viz příklad).	"params": { "parameter1": { ... // informace o parametrech }, // čárka zde "parameter2": { ... // informace o parametrech }, // a zde "parameter3": { ... // informace o parametrech } // ale tady ne }
paramOrder	"paramOrder" je volitelný objekt, který po přidání do editoru šablon způsobí, že se parametry šablony zobrazí v určitém pořadí. Jak jej používat Přidejte parametr "paramOrder", za ním dvojtečku, mezeru a otevřenou hranatou závorku a poté zadejte název každého z parametrů šablony v uvozovkách (") v požadovaném pořadí, oddělený čárkami. Ukončete uzavřenou hranatou závorkou (vytvoření pole). Parametry nemusí být na nových řádcích (mohou být zapsány jako "paramOrder": ["param1","param2","param3"]), ale jejich umístění na nové řádky často pomáhá čitelnosti. Doporučujeme umístit "paramOrder" za "params", jako to dělá editor TemplateData. Nezobrazuje se v dokumentaci TemplateData, ale jednoduše vynucuje pořadí parametrů. Budoucí editor si možná bude přát rychle prohlédnout detaily parametrů a upravit je, spíše než procházet kolem "paramOrder", zvláště pokud existuje mnoho parametrů. Pokud se rozhodnete umístit paramOrder někam vedle konce TemplateData, ukončete jej čárkou. Musíte zahrnout každý parametr uvedený v TemplateData. Jinak se zobrazí chyba "Nenalezena vyžadovaná vlastnost „správně pojmenovat“. (propertyname)". Pokud není specifikováno Bez "paramOrder" se parametry šablony zobrazí v pořadí, v jakém je deklaruje zdrojový kód šablony. Pokud zdrojový kód obsahuje objekty uvnitř objektů, budou na prvním místě parametry ve vnějších objektech, následované vnitřními objekty. S jinými parametry V editoru wikitextu 2010 s TemplateWizard: S "required" (požadované) parametry vždy zobrazí nahoře, bez ohledu na pořadí v "paramOrder". Parametry "suggested" (doporučené) se vždy zobrazí jako druhé, nad těmi "optional". "deprecated" (zastaralé) parametry se v tomto editoru vůbec nezobrazí; viz popis "deprecated" pro více informací. "paramOrder" bude vynucovat své pořadí pouze v těchto kategoriích (tj. všechny "required" parametry budou v pořadí specifikovaném "paramOrder" a všechny "suggested" parametry budou také, ale všechny "suggested" parametry se objeví pod všemi "required" parametry). V aplikaci VisualEditor a editoru wikitext 2017 vynucuje "paramOrder" své pořadí bez ohledu na stav všech parametrů.	"paramOrder": [ "date", "reason", "talk" ]

V rámci parametrů

Parametr	Popis	Příklad
Jméno parametru	Jedinou položkou první úrovně objektu params je název parametru šablony. Například ve zdrojovém kódu šablony {{{date}}} označuje parametr a měl by být přidán pod "params" s názvem "date". Můžete také vidět parametry s názvem {{{1}}} nebo jiné číslo (jehož název TemplateData by měl být například "1"). Tyto parametry se chovají tak, že když uživatel vloží šablonu, může vynechat název parametru a znaménko rovná se (tj. |value| místo |parametername=value|). Pokud existuje více nepojmenovaných parametrů, číslo identifikuje, na který nepojmenovaný parametr se odkazuje. Například v: {{example template|value1|value2}} value1 je hodnota parametru {{{1}}} a value2 je hodnota parametru {{{2}}}. Nezapomeňte odpovídajícím způsobem popsat parametry TemplateData. Poznámka: Uživatel může přesto vynutit použití {{{2}}} bez {{{1}}} jednoduše vložením parametru s názvem "2" do editoru šablony nebo zadáním "|2=" do wikitextu. Nakonec si všimněte, že "aliases" vytváří alternativy k názvu parametru, které lze zaměnit a "label" nahrazuje název parametru v uživatelském rozhraní zadaným štítkem (pro situace, kdy název parametru není čitelný člověkem nebo není snadno pochopitelný). Jak jej používat Každý z těchto objektů "Jméno parametru" (parametr name) by měl obsahovat všechny informace o parametru ve formě více TemplateData parametrů. Jsou uvedeny v následující části O názvu parametrů.	"1": { // název parametru ... // informace o parametru najdete zde }

O názvu parametru

Parametr	Popis	Příklad
aliases	Volitelný parametr "aliases" umožňuje, aby parametr šablony měl více jmen. Můžete jej zkontrolovat tak, že přejdete do zdrojového kódu šablony a hledáte: {{{parameter1|{{{parameter2}}}}}} nebo {{{parameter1|{{{parameter2|}}}}}} To znamená, že pokud uživatel vloží některý z těchto parametrů s hodnotou, provede stejnou funkci. To doslova znamená "Hodnota parameter1. Pokud parametr1 neexistuje nebo nemá hodnotu, hodnota parameter2." V druhém případě to také znamená: "Pokud parameter2 neexistuje nebo nemá hodnotu, tak žádná hodnota". Chcete-li vložit parametr "aliases", přidejte text "aliases" následovaný dvojtečkou, mezerou a otevřenou hranatou závorkou a poté zadejte název každého z aliasů parametru do uvozovek oddělený čárkami. Zakončete uzavřenou hranatou závorkou, čímž vytvoříte pole.	"aliases": ["1", "talk", "talksection"],
inherits	"inherits" je volitelný parametr, kdy by měl parametr zdědit všechna TemplateData jiného parametru. To pak může být potlačeno libovolnými parametry zadanými pro dědičný parametr. Chcete-li použít tento parametr, zadejte "inherits" : následovaný názvem jiného parametru šablony, například "talk" nebo "1". Poté můžete podle potřeby zadat další konkrétní nastavení parametru, například "label" : "A different label". První parametr zdědí všechny vlastnosti druhého parametru s výjimkou tohoto.	"params": { "téma1": { "label": "Téma", "description": "Téma zmíněné na této disambiguační (nejednoznačné) stránce", "type": "string" }, "téma2": { "inherits": "téma1" }, "téma3": { "inherits": "téma1", "label" : "A different label" } }
label	Parametr "label" je pro člověka čitelný název parametru, který se zobrazí v editoru šablon. Štítek se vždy zobrazuje místo nezpracovaného názvu parametru, včetně případů, kdy je ve wikitextu použit alias. Tento parametr je sice volitelný, ale velmi se doporučuje.	"label": "Měsíc a rok",
description	"description" je zde popisem parametru, nikoli šablony jako celku. Tento popis se zobrazí pod názvem parametru (dlouhé popisy budou zkráceny tlačítkem pro případné rozšíření). Je volitelný, ale velice doporučený.	"description": "Měsíc a rok, kdy byla šablona vložena",
type	Viz část Parametr typu.
default	Některé parametry šablony mají výchozí hodnotu. Hodnota se použije, pokud není přepsána uživatelem. Položka "default" je volitelná položka. Je pouze dokumentační. Je určena ke sdělování této výchozí hodnoty uživateli. Hodnota se nemusí shodovat se skutečným výchozím nastavením (pokud existuje) a nemá žádný funkční účinek. (Neplést s "autovalue", což je funkční parametr, který vyplňuje pole pro uživatele.) Výsledky Ve všech hlavních editorech (VisualEditor, 2017 wikitext editor 2017 a 2010 wikitext editor s TemplateWizard) se "default" text zobrazí jako šedý text ve vstupním poli jakéhokoli otevřeného parametru, pokud je prázdný, ve formátu "Default: default text". Kromě toho se zobrazí jako obyčejný černý text v popisu parametru (když uživatel umístí kurzor myši na symbol "i"). V aplikaci VisualEditor a editoru wikitext 2017 to bude pod popisem parametru: "Pole je povinné" nebo "Pole je zastaralé", pokud je uvedeno (editor wikitext 2010 tento text nezobrazuje), a nad "viz příklad", pokud je zadán ("example" se nezobrazí v popisu parametru v editoru wikitext 2010). V editoru wikitext 2010 s TemplateWizard se "default" text zobrazí hned za popisem parametru na stejném řádku za mezerou. Zobrazuje se ve stejném formátu jako ostatní editory ("Default: default text"). S dalšími parametry Ve všech hlavních editorech (VisualEditor, 2017 wikitext editor a 2010 wikitext editor s TemplateWizard), je-li zadáno "default", hodnota "example" se ve vstupním poli nezobrazí.	"default": "Category:CommonsRoot",
autovalue	Parametru lze přiřadit "autovalue". Když uživatel přidá šablonu na stránku, tato hodnota se automaticky objeví ve vstupním poli. Například mnoho šablon čištění vyžaduje přidání data nastavením "autovalue" pro parametr date šablony na {{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}} se automaticky vyplní měsíc a rok, kdy byla šablona přidána. Tuto hodnotu může uživatel přepsat v editoru šablon. S dalšími parametry Ve všech hlavních editorech (VisualEditor, 2017 wikitext editor a 2010 wikitext editor s TemplateWizard), "autovalue" přepíše viditelné efekty "url" ve VisualEditoru a wikitext editoru 2017. Další informace viz popis pro "type".	"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
example	Parametr "example" je volitelný a pouze dokumentační. Jeho hodnota obsahuje příklad, který pomáhá uživateli šablony pochopit správný způsob vyplnění parametru (neplést s "suggested"; další informace naleznete v tomto záznamu). Výsledky Ve všech hlavních editorech (VisualEditor, 2017 wikitext editor a 2010 wikitext editor s TemplateWizard). Tato vlastnost je zobrazena pod popisem parametru (a pod "default" textem, pokud je zadán). S dalšími parametry Ve všech hlavních editorech (VisualEditor, 2017 wikitext editor a 2010 wikitext editor s TemplateWizard) se "example" (příklad) nezobrazí ve vstupním poli, pokud je zadán "default" (výchozí).	"example": "January 2013",
required	Parametr "required" (povinné) lze nastavit na true nebo false. Pokud není specifikováno, je výchozí hodnota false. Určuje, zda je vyplnění daného parametru pro šablonu povinné. Výsledky Tento stav má několik efektů v aplikaci VisualEditor a v Editor wikitextu 2017 : zobrazí parametr automaticky, když uživatel vloží šablonu; ve vstupním poli vpravo je zobrazena černá hvězdička; pod popisem parametru se zobrazí šedý text s kurzívou "Pole je povinné."; pokud uživatel klepne pryč bez zadání hodnoty, způsobí, že vstupní pole svítí červeně; pokud se uživatel pokusí vložit šablonu bez hodnoty do požadovaného parametru, zobrazí výzvu a zeptá se, zda si je jistý. Pokud toto potvrdí, vloží parametr s prázdnou hodnotou. Nezabrání ve vkládání šablony a nebude mít za následek viditelnou chybu samu o sobě (i když šablony nelze naprogramovat tak, aby zobrazovaly chybu, pokud není vyplněn požadovaný parametr). V Rozšíření:WikiEditor na stránce Nápověda:Rozšíření:Šablonový pomocník , stejně jako v ostatních editorech se zobrazuje, při vložení šablony uživatelem, parametr automaticky, ale parametr nelze odstranit pomocí tohoto ani žádného jiného editoru. V popisu parametru také nezobrazuje "Pole je povinné."; spíše uvádí parametr na straně v části "Povinné parametry". Kromě toho se obvykle chová stejně jako v ostatních editorech, kromě toho, že se v řádku zobrazí, že vstup neodpovídá očekávanému formátu. S dalšími parametry V aplikaci VisualEditoru a editoru wikitext 2017 stav "deprecated" nepřepíše funkčnost tohoto parametru, ale ve wikitextovém editoru 2010 s TemplateWizardem ano. Další informace naleznete v popisu ""deprecated"" (zastaralé).	"required": true
suggested	Parametr "suggested" lze nastavit na true nebo false. Pokud není specifikováno, je výchozí hodnota false. Použijte "suggested" pro parametry, které nejsou povinné, ale důrazně doporučujeme uživatelům šablony poskytnout. Při vyplňování tohoto parametru se uživateli zobrazí tento návrh. Výsledky V aplikaci VisualEditor a Editor wikitextu 2017 způsobí, že se parametr automaticky zobrazí, když uživatel vloží šablonu. Pokud má parametr nastavenou automatickou hodnotu, bude tato také automaticky ve vstupním poli parametru. Nemá žádný další účinek a nezobrazuje žádný další text ani varování. V Rozšíření:WikiEditor s TemplateWizard neumisťuje parametr do šablony automaticky, ale místo toho způsobí, že bude uveden na straně v části "Doporučené parametry". Uživatel pak může kliknout na "+" vedle parametru a přidat jej do šablony. S dalšími parametry Stav "required" (požadovaný) přepíše funkčnost tohoto stavu ve všech hlavních editorech (VisualEditor, editor wikitext 2017 a editor wikitext 2010). Také přepíše zobrazený stav "suggested" (doporučený) v dokumentaci TemplateData (zobrazí se "required" (povinný), pokud jsou "required" i "suggested" true).	"suggested": true
deprecated	Nakonec je zde zastaralé "deprecated", které může být nastaveno na true, false nebo řetězec popisující, co by uživatelé měli místo toho dělat. Pokud není specifikováno, je výchozí hodnota false. Toto je stav pro parametry, které by se již neměly používat, ale prozatím existují. Může to být proto, že použití šablony se přesouvá z jedné sady parametrů do druhé. Výsledky Účinek tohoto parametru v aplikaci VisualEditor a editoru wikitext 2017 je, že po vložení parametru se vedle štítku parametru zobrazí šedý vykřičník a pod informačním popisem parametru je šedou kurzívou zobrazen text "Pole je zastaralé. důvod ukončení podpory". Nemá to vliv na funkčnost nebo použitelnost parametru ani nezobrazuje žádná další varování. Přestože může řetězec trvat, od ledna 2020 žádný z hlavních editorů (VisualEditor, editor wikitext 2017 nebo editor wikitext 2010) nezobrazí uživatelům obsah tohoto řetězce. Zadání řetězce má stejný účinek jako true. V editoru wikitext 2010 s TemplateWizard nastavení této hodnoty jako true neumožňuje přidání nebo zobrazení parametru. S dalšími parametry Pokud nastavíte jak toto, tak "suggested" (navrhované) jako true, stav parametru se v dokumentaci TemplateData zobrazí jako "deprecated" (zastaralé), ale v VisualEditor a editoru wikitext 2017 budou obě funkce zachovány. Parametr se automaticky zobrazí, když uživatel vloží šablonu, ale bude mít varování "deprecated" (zastaralá). Pokud nastavíte toto i "required" (povinné) jako true, stav parametru se v dokumentaci TemplateData zobrazí jako "deprecated" (zastaralé), ale ve VisualEditor a editoru wikitext 2017 bude mít stejnou funkcionalitu jako pouze "required" (vyžadováno). Parametr se automaticky zobrazí, když uživatel vloží šablonu a bude mít zobrazeno varování "deprecated" (požadovaná). To samé platí, pokud nastavíte "deprecated" (zastaralé), "suggested" (navrhované) a "required" (povinné) jako true. V editoru wikitext 2010 s TemplateWizard, "deprecated" (zastaralý) přepíše parametry "required" (povinné) a "suggested" (navrhované).	"deprecated": "Místo toho použijte 'publicationDate'."
suggested values	Vlastnost parametru suggestedvalues vám umožňuje definovat seznam hodnot parametrů, které se mají zobrazit uživatelům VisualEditoru v rozevíracím seznamu pro snadný výběr. To lze provést buď přímo v JSON nebo pomocí editoru TemplateData (bez nutnosti kódování). Můžete přidat navrhované hodnoty, které se mají zobrazit ve VisualEditoru pro parametry, jejichž typ je nastaven na jednu z následujících možností (reference): Obsah Řádka Řetězec Číslo Neznámý Nevyvážený wikitext Jiné typy (file, page, template, user, date, boolean, URL) nejsou aktuálně podporovány, protože již mají speciální funkce ve VisualEditoru, jako je automatické dokončování, které by narušovalo rozevírací nabídku pro navrhované hodnoty ve VisualEditoru. Úpravy TemplateData jako JSON ve WikiTextu Chcete-li přidat navrhované hodnoty k libovolnému typu parametru, přidejte do parametru v JSON novou vlastnost "suggestedvalues". Atribut “suggestedvalues” musí být seznam řetězců. Úpravy TemplateData pomocí editoru TemplateData Klikněte na "Upravit strojový popis šablony". Klikněte na název parametru, ke kterému chcete navrhované hodnoty přidat. Pokud to ještě není provedeno, nastavte typ parametru na jeden z následujících: content, line, string, number, unknown, unbalanced wikitext. Objeví se nové vstupní pole "Doporučené hodnoty". Pokud je parametr již nastaven na jeden z těchto typů, vstupní pole by již mělo být viditelné. Zadejte navrhované hodnoty, včetně mezer a speciálních znaků, a stisknutím klávesy Enter přidejte hodnotu (hodnoty) do seznamu. Effects Jakmile budou hodnoty přidány do TemplateData, VisualEditor je zobrazí v rozbalovacím seznamu (rozbalovací seznam, do kterého mohou uživatelé také zadat vlastní hodnotu) pro typy parametrů uvedené výše. Uživatel vybere požadovanou hodnotu kliknutím na ni. Pokud je seznam hodnot dlouhý – například seznam států země – může uživatel do pole začít psát, načež bude seznam filtrován tak, aby zobrazoval pouze hodnoty obsahující zadaný text. Pro změnu zadané hodnoty musí uživatel pole jednoduše vymazat a znovu se zobrazí celý rozevírací seznam. Pokud uživatel potřebuje hodnotu, která není uvedena v seznamu (například "zpráva v láhvi"), může ji zadat ručně.	"suggestedvalues": [ "Časopis", "Kniha", "Noviny", "Magazín" ]

Poznámka: Pokud "required", "suggested" ani "deprecated" nemají parametr nastavený jako true, jejich stav se v dokumentaci TemplateData zobrazí jako "optional".

Až budete hotovi, stiskněte "Uložit". Pokud jste udělali chyby, nedovolí vám to uložit (což je rušivé, ale znamená to, že nemůžete nic pokazit). 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.

Všimněte si, že pokud zneužíváte hackovací šablonu k dynamickému 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 true a false) a je oddělena od další položky čárkou (pokud není poslední).

Zadejte parametr

Parametr "type" má signalizovat editoru šablon 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í vliv na parametr šablony nebo jeho hodnotu. Pouze řídí, jak editor šablony vidí a zachází s parametrem v režimu úprav.

Jak jej používat

Používá se přidáním parametru "type", za kterým následuje dvojtečka a mezera a poté se do uvozovek přidá jakákoli z hodnot uvedených v tabulce níže.

Příklad:

"type": "string",

Výsledky

Od února 2020 má pouze 5 ze 13 hodnot typu viditelné výsledky ve VisualEditoru a editoru wikitextu 2017, zatímco 8 má viditelné výsledky v TemplateWizard.

Účinky určitých hodnot se pravděpodobně změní, protože editory šablon získávají aktualizace, které je podporují. Jedno takové úsilí pro VisualEditor a editor wikitextu 2017 je sledováno v úkolu Phabricator T55613. Podobná snaha přimět TemplateWizard, aby podporoval booleovskou hodnotu, je sledována v T200664.

Aktuálně známé účinky jsou následující.

Hodnota	Popis
unknown	Hodnota "unknown" je výchozí hodnotou typu, pokud není nastaven žádný typ. Lze ji také nastavit ručně zadáním "type": "unknown". Výsledky Ve všech hlavních editorech (VisualEditor, editor wikitextu 2017 a editor wikitextu 2010 s TemplateWizard) nemá "unknown" žádné viditelné účinky ve srovnání se šablonou bez TemplateData.
string	Hodnota "string" je určena pro jakýkoli řetězec základního textu. Výsledky Ve všech hlavních editorech (VisualEditor, editor wikitextu 2017 a editor wikitextu 2010 s TemplateWizard) nemá "string" žádný viditelný efekt ve srovnání s "unknown".
line	Hodnota "line" je určena pro obsah, který má zůstat na jednom řádku. Výsledky V aplikaci VisualEditor a editoru wikitext 2017 "line" brání vstupnímu poli parametru povolit nové řádky, které jsou obvykle v těchto editorech možné. V editoru wikitext 2010 s TemplateWizard nemá "line" žádný viditelný efekt (vstupní pole ve výchozím nastavení neumožňuje v tomto editoru nové řádky).
content	Hodnota "content" je určena pro wikitext obsahu stránky, například pro odkazy, obrázky nebo formátování textu. Výsledky V aplikaci VisualEditoru a editoru wikitext 2017 nemá "content" žádný viditelný efekt. V editoru wikitext 2010 s TemplateWizard, "content" dělá vstupní pole parametrů o jeden řádek vyšší a umožňuje nové řádky, které běžná vstupní pole v editoru wikitext 2010 nedělají.
unbalanced-wikitext	Hodnota "unbalanced-wikitext" je určena pro wikitext, který nemůže stát samostatně, tj. Postrádá otevírací nebo uzavírací značku nebo odkazuje na jiné části wikitextu. Výsledky V aplikaci VisualEditoru a editoru wikitext 2017 nemá "unbalanced-wikitext" žádný viditelný efekt. V editoru wikitext 2010 s TemplateWizard, "unbalanced-wikitext" dělá vstupní pole parametrů o jeden řádek vyšší a umožňuje nové řádky, které běžná vstupní pole v editoru wikitext 2010 nedělají.
wiki-page-name	Hodnota "wiki-page-name" je určena pro název stránky na wiki. Výsledky Ve všech hlavních editorech (VisualEditor, editor wikitextu 2017 a editor wikitextu 2010 s TemplateWizard), "wiki-page-name" způsobí, že vstupní pole parametrů zobrazí rozbalovací nabídku návrhů obsahující seznam stránek na wiki, například články na Wikipedii, které lze vybrat. Při hledání lze také definovat jmenný prostor. V aplikaci VisualEditoru a editoru wikitext 2017 navíc vynutí, aby obsah vstupního pole zůstal na jednom řádku. Nemá žádný další viditelný efekt a nezabraňuje zadávání jiné stránky.
wiki-file-name	Hodnota "wiki-file-name" je určena pro jméno souboru hostované buď lokálně na wiki nebo na Wikimedia Commons. Výsledky V aplikaci VisualEditoru a editoru wikitext 2017 nemá "wiki-file-name" žádný viditelný efekt. V editoru wikitext 2010 s TemplateWizard "wiki-file-name" způsobí, že vstupní pole parametrů zobrazí rozbalovací nabídku návrhů obsahující seznam souborů hostovaných lokálně i na Wikimedia Commons, které lze vybrat. Názvy souborů neobsahují předponu jmenného prostoru "File:". Rozbalovací nabídka také zobrazuje miniatury souborů. Nemá žádný další viditelný efekt a nebrání tomu, aby byl soubor vložen.
wiki-template-name	Hodnota "wiki-template-name" je určena pro název šablony. Výsledky Ve všech hlavních editorech (VisualEditor, 2017 wikitext editor a wikitext editor 2010 s TemplateWizard) "wiki-template-name" způsobí, že vstupní pole parametrů zobrazí rozbalovací nabídku návrhů obsahující seznam šablon, které lze vybrat. V aplikaci VisualEditoru a editoru wikitext 2017 navíc vynutí, aby obsah vstupního pole zůstal na jednom řádku. Nemá žádný jiný viditelný efekt a nebrání vložení nešablony.
wiki-user-name	Hodnota "wiki-user-name" je určena pro uživatelské jméno na wiki. Výsledky Ve všech hlavních editorech (VisualEditor, 2017 wikitext editor a 2010 wikitext editor s TemplateWizard) "wiki-user-name" způsobí, že vstupní pole parametrů zobrazí rozbalovací nabídku návrhů obsahující seznam skutečných uživatelských jmen, která lze vybrat. V aplikaci VisualEditoru a editoru wikitext 2017 navíc vynutí, aby obsah vstupního pole zůstal na jednom řádku. Nemá žádný další viditelný efekt a nezabraňuje zadávání jiného uživatele.
number	Hodnota "number" je určena pro číselné hodnoty, včetně záporných hodnot a desetinných míst. Výsledky V aplikaci VisualEditoru a editoru wikitext 2017 nemá "number" žádný viditelný efekt. V editoru wikitext 2010 s TemplateWizard, "number" způsobí, že se ve vstupním poli na obou stranách zobrazí tlačítko "+" a "-", kterým lze zvýšit nebo snížit číselnou hodnotu ve vstupním poli a uživatel může zadávat čísla pouze do pole. Tlačítka mohou také snížit počet na záporný. S jinými parametry V editoru wikitext 2010 s TemplateWizard, "number" přepíše efekty "autovalue". Hodnota "autovalue" nebude automaticky vložena do vstupního pole, pokud je typ parametru "number".
boolean	Hodnota 1 $ je určena pro hodnotu, která je buď pravdivá, nepravdivá nebo neznámá. To je v příručce zamýšleno tak, aby bylo reprezentováno "1", "0" nebo prázdnou hodnotou. Výsledky Od února 2020 žádný z hlavních editorů Wikimedia (VisualEditor, editor wikitextu 2017 nebo editor wikitextu 2010 s TemplateWizard) tuto hodnotu nevyužívá. Nemá žádné viditelné účinky. Ve VisualEditoru se objeví zaškrtávací políčko autovalue:0, které lze zapnout a vypnout.
date	Hodnota "date" je určena pro datum ve formátu RRRR-MM-DD (ISO 8601). Například 2014-05-22. Příručka TemplateData jej také označuje jako určený pro kombinace data a času ISO 8601, jako je "2014-05-22T16:01:12Z". Ale v praxi jej od února 2020 nepoužívá žádné velké editační rozhraní. Tímto způsobem a téměř všechny hlavní parametry šablony Wikimedie berou data a časy odděleně. Výsledky V aplikaci VisualEditor a editoru wikitext 2017 nemá "date" žádný viditelný efekt. Ve wikitextovém editoru pro rok 2010 s TemplateWizard "date" zkracuje pole pro zadávání parametrů asi o třetinu a přidává rozbalovací kalendář, který umožňuje uživateli vybrat si datum. Zobrazí také šedý vzorový text ve vstupním poli "RRRR-MM-DD". Pokud vstup neodpovídá této normě, pole svítí červeně, ale editor vždy vypíše datum odpovídající normě (pokud jsou zadána čísla) nebo nic (pokud je zadán pouze text nebo nic). S jinými parametry V editoru wikitext 2010 s TemplateWizard, "date" přepíše efekty "autovalue". Hodnota "autovalue" nebude automaticky vložena do vstupního pole, pokud je typ parametru "date".
url	Hodnota "url" je určena pro adresu URL, včetně internetového protokolu (např. "https://" nebo "//"). Výsledky V aplikaci VisualEditoru a editoru wikitext 2017 "url" způsobí, že vstupní pole zobrazí v levé části pole ikonu externího odkazu (čtverec se šipkou směřující ven) a po kliknutí uživatele odešle v červené barvě hodnotu URL, která obsahuje platný internetový protokol (např. "https://", "ftp://" nebo "//"), za kterým následuje nějaký text. Tento druhý efekt je podobný jako u nastavení "required" (požadováno), ale uživatele nevaruje, pokud se pokusí vložit šablonu bez platné adresy URL. Vyskytuje se také s jakémkoli nastavením stavu (například "suggested"" nebo "deprecated"). V editoru wikitext 2010 s TemplateWizard nemá "url" žádný viditelný efekt. S dalšími parametry V aplikaci VisualEditoru a editoru wikitext v roce 2017 přepíše "autovalue" viditelné efekty "url". Pokud jsou oba nastaveny, nebude vstupní pole obsahovat ikonu URL ani červeně zvýrazněnou, pokud uživatel klepne na odchod, aniž by zadal platnou adresu URL.

Vlastní formáty

Při úpravě hodnoty "format" 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 znacích 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 \n pro nové řádky).
• | - potrubí, trubka, svislá čára, svislítko (odděluje parametry)
• = - znaménko rovná se (předchází hodnotě parametru)
• \n nebo stisknutí klávesy Enter - nový řádek (ve vstupním poli se zobrazí jako ↵)
• - mezera (lze použít s \n k odsazení nových řádků)
• }} - konec šablony

Wikitext by měl splňovat minimálně {{_|_=_}}, jinak bude neplatný formátovací řetězec.

Příklady formátů, které můžete použít

Úkol	Formát řetězce	Výstup
Inline formátování	{{_|_=_}} inline	{{Foo|bar=baz|qux=quux}}{{Bar}}
Blokové formátování	{{_\n| _ = _\n}} block	{{Foo | bar = baz | qux = quux }}{{Bar}}
Žádná mezera před názvem parametru, každá šablona na samostatném řádku	\n{{_\n|_ = _\n}}\n	{{Foo |bar = baz |qux = quux }} {{Bar}}
Odsazení každého parametru	{{_\n |_ = _\n}}	{{Foo |bar = baz |qux = quux }}{{Bar}}
Zarovnání všech názvů parametrů s danou délkou	{{_\n|_______________ = _\n}}\n	{{Foo |bar = baz |qux = quux |veryverylongparameter = bat }} {{Bar}}
Znaky svislítka na konci předchozího řádku	{{_|\n _______________ = _}}	{{Foo| bar = baz| qux = quux}}{{Bar}}
Vložený styl s více mezerami musí být na začátku řádku	\n{{_ | _ = _}}	{{Foo | bar = baz | qux = quux}} {{Bar }}
Šablona na začátku řádku, parametry zarovnány podle odsazení, svislítko vpředu	\n{{_ |\n _______________ = _}}	{{Foo | bar = baz | qux = quux}} {{Bar}}

Prázdná předloha

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

<templatedata>
{
    "description": "",
    "params": {
        "1": {
            "label": "",
            "description": "",
            "type": ""
        },
        "2": {
            "label": "",
            "description": "",
            "type": ""
        }
    }
}
</templatedata>

Chyby

Syntaktická chyba v JSON. / Špatný formát 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.

"Syntaktická chyba v JSON." 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).

Tyto chyby může být obtížné odhalit a mají příliš mnoho forem, než aby je bylo možné vyjmenovat. Nejlepší způsob, jak se jim vyhnout, je upravovat data šablony výhradně pomocí editoru TemplateData. Nejlepší způsob, jak je odhalit, jakmile k nim dojde, je použít externí validátor JSON, například JSONLint, který zvýrazní chyby a pomůže je opravit.

Editor wikitextu z roku 2010 nekontroluje neplatný JSON díky staré, neopravené chybě (úkol T128029). Stránky, které obsahují neplatný JSON, mohou vyvolávat alarmující zprávy "Vnitřní chyba". Chcete-li tyto chyby opravit, nejlepším řešením je použít validátor JSON (viz výše).

Nenalezena vyžadovaná vlastnost „paramOrder[číslo]“.

K této chybě dochází, pokud uvedete v "params" parametr, který není uveden v "paramOrder". Číslo v hranatých závorkách odkazuje na chybějící parametr v "paramOrder". Odkazuje na jeho pořadí v sekvenci, ale to je o jednu méně, než je jeho skutečná pozice, protože "paramOrder" je pole. 0 je první, 1 je druhý atd.

"params": {
    "date": { ...
    },
    "reason": { ...
    },
    "talk": { ... // <-- Tento parametr není uveden v "paramOrder", ale měl by být.
    }
},
"paramOrder": [
	"date",
	"reason"
]

// Chyba: Požadovaná vlastnost "paramOrder[2]" nebyla nalezena.

Chcete-li to vyřešit, ujistěte se, že všechny parametry uvedené v "params" jsou uvedeny v "paramOrder". Případně můžete tuto chybu odstranit odebráním objektu "paramOrder".

Chybná hodnota vlastnosti „paramOrder[číslo]“.

K této chybě dochází, pokud uvedete v "paramOrder" parametr, který není uveden v "params". Číslo v hranatých závorkách odkazuje na chybějící parametr v "paramOrder". Odkazuje na jeho pořadí v sekvenci, ale to je o jednu méně, než je jeho skutečná pozice, protože "paramOrder" je pole. 0 je první, 1 je druhý atd.

"params": {
    "date": { ...
    },
    "talk": { ...
    }
},
"paramOrder": [
	"date",
	"reason", // <-- Tento parametr není uveden v "params", ale měl by být.
    "talk"
]

// Chyba: Neplatná hodnota vlastnosti "paramOrder[1]".

Chcete-li to vyřešit, ujistěte se, že všechny parametry uvedené v "paramOrder" jsou uvedeny v "params". Případně můžete tuto chybu odstranit odebráním objektu "paramOrder".

Očekávaný typ vlastnosti „params.název parametru.required“ je „boolean“.

K této chybě dochází, pokud uvozovky umístíte kolem hodnoty buď "required" nebo "suggested".

"suggested": "true" // <-- Tyto uvozovky by zde neměly být.

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

Očekává se, že "format" vlastnosti bude ...

Pokud parametr "format" existuje, ale jeho hodnota není "inline", "block" nebo platný řetězec formátu, zobrazí se chybová zpráva: "U vlastnosti „format“ se očekává hodnota „inline“, „block“ nebo platná hodnota formátu".

"format": "notinline"

// Chyba: Předpokládá se, že vlastnost "format" bude "inline", "block" nebo platný formátovací řetězec.

Chcete-li to vyřešit, ujistěte se, že hodnota po "format": se rovná "inline" nebo "block" 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ů. Případně můžete tuto chybu odstranit odebráním objektu "format".

Neočekávaná vlastnost „název parametru“.

K této chybě dochází, pokud uvedete parametr, který v datech šablony neexistuje. To je pravděpodobně způsobeno pravopisnými chybami.

<templatedata>
{
    "description": "",
    "format": "inline",
    "params": {
        "1": {
            "label": "",
            "descriptino": "", // <-- pravopisná chyba
            "type": ""
        }
    }
}
</templatedata>

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 "label" pod kořenový objekt TemplateData namísto uvnitř "params":

<templatedata>
{
    "description": "",
    "format": "inline",
    "label": "", // <-- špatně umístěný parametr
    "params": {
        "1": { // ↓ it should be in here
            "description": "",
            "type": ""
        }
    }
}
</templatedata>

Alternativně, pokud je neočekávaný parametr pod parametrem šablony uvnitř "params", uvidíte jeho název za "params.parametername." v chybě.

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 umístěny správně. Kromě toho se ujistěte, že neuvádíte žádné parametry, které pro objekt TemplateData neexistují. V sekci Parametry TemplateData můžete zkontrolovat, které parametry pro objekt existují.

Nenalezena vyžadovaná vlastnost „params“.

K této chybě dochází, pokud v TemplateData není žádný objekt "params". 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 "params".

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 [1].
• 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 Wikimedie.

Další nástroje

Nápověda:Rozšíření:Šablonový pomocník

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ý načte zdrojový wikikód šablony, pokusí se najít všechny použité parametry a vytvoří kostru dokumentu 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
• V šabloně dewiki 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/ a Query Helper