Nápověda:Strojový popis šablony

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Help:TemplateData and the translation is 100% complete.
Other languages:
Bahasa Indonesia • ‎Cymraeg • ‎Deutsch • ‎English • ‎Esperanto • ‎Ilokano • ‎Lëtzebuergesch • ‎Nederlands • ‎Oromoo • ‎Scots • ‎Tiếng Việt • ‎Türkçe • ‎Zazaki • ‎asturianu • ‎azərbaycanca • ‎català • ‎dansk • ‎emiliàn e rumagnòl • ‎español • ‎euskara • ‎français • ‎føroyskt • ‎galego • ‎hrvatski • ‎italiano • ‎lietuvių • ‎magyar • ‎occitan • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎slovenčina • ‎slovenščina • ‎suomi • ‎svenska • ‎čeština • ‎Ελληνικά • ‎български • ‎македонски • ‎русский • ‎српски / srpski • ‎українська • ‎հայերեն • ‎ייִדיש • ‎עברית • ‎العربية • ‎تۆرکجه • ‎سنڌي • ‎فارسی • ‎پښتو • ‎अङ्गिका • ‎अवधी • ‎मराठी • ‎हिन्दी • ‎বাংলা • ‎ไทย • ‎ქართული • ‎中文 • ‎日本語 • ‎ꯃꯤꯇꯩ ꯂꯣꯟ • ‎한국어
PD Poznámka: Editací této stránky souhlasíte s uvolněním svého příspěvku pod licencí CC0. Více informací se dočtete na stránce Public Domain Help Pages.
PD

TemplateData je rozšíření používané k ukládání informací o wikitext template a jejích parametrech, takže editační rozhraní může tyto informace načíst a zobrazit v editoru šablon, což uživatelům usnadní přidávání a editaci šablon na stránkách.

Od dubna 2019 je 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í. Používá se také jinde ve skriptech, nástrojích a miniaplikacích. Pokud máte vlastní wiki, budete muset nainstalovat Extension:TemplateData.

Přidání TemplateData do šablony v podstatě spočívá v vložení malého bloku kódu JSON (vysvětleno níže) na stránce dokumentace šablony. Existují dva hlavní způsoby, jak to provést, buď ručně nebo pomocí editoru TemplateData, grafického uživatelského rozhraní umístěného na stránkách "Edit"/"Edit source" (Upravit/Upravit zdroj) šablon na wiki s nainstalovanou příponou TemplateData. JSON obsahuje seznam parametrů s informacemi o každém parametru šablony i šablony jako celku. Ty jsou nastíněny níže.

Jakmile šablona obsahuje data TemplateData, zobrazí se tato informace v uživatelském rozhraní, když uživatel přidá šablonu, někdy místo původních informací nebo někdy jako doplňující informace. V některých případech se může změnit chování editoru při úpravách nebo vkládání šablony. To může uživatelům usnadnit identifikaci toho, co se šablonou potřebují při přidávání.

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 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í.

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

Editor Strojového popisu šablony

Editor TemplateData je nástroj zabudovaný do rozšíření TemplateData pro přidání a úpravy TemplateData pomocí grafického uživatelského rozhraní.

Je dostupný přístupem na jakoukoli stránku šablony (nebo podstránky dokumentace) a kliknutím na "Upravit" (Edit) nebo "Upravit zdroj" (Edit source). Poté, co to uděláte, uvidíte tlačítko nad editační oblastí a nadpis stránky, který říká "Spravovat Strojový popis šablony".

Manage template documentation button for TemplateData 2014.png

Kliknutím na toto tlačítko vstoupíte do editoru TemplateData.

Snímek obrazovky editačního nástroje TemplateData

Editor umožňuje přidat parametry šablony a nastavit nejběžnější atributy. Pokud již editovaná stránka obsahuje blok TemplateData, když otevřete správnou stránku v editoru TemplateData, zobrazí se již dokumentované informace. V prvním poli můžete přidat nebo aktualizovat krátký popis šablony jako prostý text. Poté můžete pomocí tlačítek "Přidat navrhované parametry" (Add suggested parameter(s)) a "Přidat parametr" (Add parameter) zdokumentovat názvy a atributy parametrů, které šablona používá.

Můžete uvést název parametru, případné aliasy, štítek a popis, který se zobrazí uživatelům. Můžete také uvést příklad použití parametru. Jediným povinným polem je Název (Name) (první pole v každém řádku), kde se zaznamenává přesný název parametru rozlišující velká a malá písmena. V rozbalovací nabídce "Typ" (Type) můžete vybrat typ obsahu, který by měl parametr obdržet, například řetězec (pro odpovědi prostého textu), stránka (pro odkazy na jiné stránky) nebo data. Pokud šablona způsobí chybu, pokud je tento parametr ponechán prázdný, označte jej jako "Povinné" (Required). Pokud je parametr běžně používán nebo doporučován, označte jej jako "Navrhovaný" (Suggested). Tlačítko "Odstranit informace o parametru" (Remove parameter information) odstraní položku parametru z TemplateData.

Screenshot of the TemplateData editor, showing a second parameter being added

Po dokončení dokumentace všech parametrů klikněte na "Použít" (Apply) a vložte předformátované TemplateData do otevřeného editačního pole. Stránku musíte uložit pomocí běžného tlačítka „Uložit“ (Save) pod editačním oknem.

Upozornění: Editor TemplateData umístí TemplateData na stránku šablony nebo na podstránku dokumentace. Určete, kam budou TemplateData přidána otevřením (úpravou) stránky, na kterou má být TemplateData umístěna. Pokud je však na stejnou šablonu umístěno více bloků TemplateData, bude použit pouze jeden z těchto bloků TemplateData. Pokud již na stránce existují TemplateData, musíte upravit stránku, na které byla TemplateData dříve umístěna, aby nedošlo k náhodnému vytvoření více bloků TemplateData.

Umístění Strojového popisu šablony

TemplateData musí být na stránce, kterou popisuje nebo musí být na ní transcluded. V šabloně se obvykle zabalí do značek <noinclude> . Při normálním vykreslování stránky zobrazuje automaticky generovanou dokumentaci, jak je uvedeno v #Příklad.

Struktura Strojového popisu šablony

Struktura TemplateData je založena na standardu JSON. Všechny popisy v TemplateData musí být v prostém textu (žádný wikitext, žádné odkazy, "atd.").

První věcí, kterou musíte udělat, je napsat pár značek <templatedata>, kdekoli na podstránce dokumentace šablony, takto:

<templatedata>
{
    ...       // Zde se nachází obsah TemplateData
}
</templatedata>

To říká softwaru, že vše mezi těmito dvěma značkami je TemplateData a mělo by se na něj při použití šablony odkazovat.

Příklad

Popisy uvnitř TemplateData se řídí standardním rozvržením. Řekněme, že máte šablonu nazvanou "Commons", která slouží k propojení s kategorií Commons o daném tématu. Vyžaduje jeden povinný parametr: název kategorie v Commons. TemplateData bude vypadat asi takto:

<templatedata>
{
    "description": "Šablona pro propojení na kategorii commons o článku",
    "params": {
        "1": {
            "label": "Commons kategorie",
            "description": "Kategorie commons, se kterou chcete propojit.",
            "default": "Category:CommonsRoot",
            "type": "string",
            "required": true
        }
    }
}
</templatedata>

To by se v šabloně zobrazilo takto:

Šablona pro propojení na kategorii commons o článku

Template parameters

ParameterDescriptionTypeStatus
Commons kategorie1

Kategorie commons, se kterou chcete propojit.

Default
Category:CommonsRoot
Stringrequired

TemplateData parametry

Každý parametr pro TemplateData je uveden níže s popisem a příkladem. Jsou také uvedeny na Extension:TemplateData # Format.

Pořadí parametrů neovlivňuje funkčnost, pokud jsou uvnitř objektu zachovány například parametry "params".

Tyto informace jsou aktuální od února 2020 a mohou se změnit, pokud jsou přidány nové parametry nebo rozhraní pro úpravy šablon získají aktualizace, aby mohly s určitými parametry zacházet odlišně nebo opravit určitá chování.
Parametr Popis Příklad
description

Parametr "description" popisuje, co šablona dělá. Je volitelný, ale velice doporučený.

Wiki označení nebude v popisu fungovat. Je to striktně textový řetězec.

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 2010 wikitext editor 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ávají hodnoty do parametrů v šabloně.

V editoru wikitextu VisualEditor a 2017 se přibližně 50 znaků popisu zobrazí pod každým návrhem vyhledávání, za ním následuje "...", ale celý popis se zobrazí v hlavním okně editoru šablon. Oba jsou zobrazeny šedým textem.

V editoru wikitext 2010 s TemplateWizard se celý popis zobrazuje pod každým návrhem hledání š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]). Dodatečně:

  • v aplikaci VisualEditor a editoru wikitext 2017 se bude chovat stejně jako šablona, která nemá TemplateData. Místo popisu se zobrazí následující text:
"The "Template:Cleanup/sandbox" template doesn't yet have a description, but there might be some information on the template's page."
  • V editoru wikitext 2010 s TemplateWizard se zobrazí následující text, kde by byl popis (i když ne v návrzích vyhledávání):
"No description exists for this template."
To se liší od dvou standardních popisů zástupných symbolů, když TemplateData neexistuje:
  • "Due to missing TemplateData, parameters for this template have been auto-generated. Please be aware that they may not be accurate."
  • "No parameters could be determined for this template due to absence of TemplateData documentation. You may insert the template without parameters."
"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 neexistuje, je inline formátování a v dokumentaci TemplateData pod nadpisem tabulky se nezobrazí žádné odpovídající upozornění.

Výsledky

Inline:

Pokud je parametr nastaven na "inline", zobrazí šablona odpovídající upozornění o preferenci v dokumentaci TemplateData pod nadpisem tabulky "Parametry šablony" (Template parameters):

"[circles and pipes icon] This template prefers inline formatting of parameters."

Když je šablona vložena, rozloží svůj wikitext na jediný řádek bez mezer mezi prvky. Například:

{{Foo|bar=baz|qux=quux}}

Blok:

Pokud je parametr nastaven na "block", šablona zobrazí v dokumentaci TemplateData následující upřednostňující oznámení:

"[stacked blocks and pipes icon] This template prefers block formatting of parameters."

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 zobrazí následující upozornění na předvolby v dokumentaci TemplateData:

"[cogwheel icon] This template has custom formatting."

Po vložení š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ů, oddělte každý objekt parametru čárkou za každou uzavírací závorkou (mimo poslední).

"params": {
    "parameter1": {
        ...    //  informace o parametrech
    },      // čárka zde
    "parameter2": {
        ...    //  informace o parametrech
    },      // a zde
    "parameter3": {
        ...    //  informace o parametrech
    }       //  ale tady ne
}
paramOrder

Objekt "paramOrder" ve volitelném objektu, který může při přidání do editoru šablon vynutit zobrazení parametrů v určitém pořadí.

Používá se přidáním parametru "paramOrder", následovaného dvojtečkou a mezerou a následným zahrnutím názvu každého z parametrů šablony v uvozovkách v požadovaném pořadí, oddělených čárkami mezi dvěma hranatými závorkami (pole). Parametry nemusí být na nových řádcích (mohou být "paramOrder": ["param1","param2","param3"]), ale jejich umístění na nových řádcích přispěje k čitelnosti. Musí být zahrnuty všechny parametry uvedené v TemplateData, jinak se zobrazí chyba.

Výsledky

V aplikaci VisualEditor a editoru wikitext 2017 vynucuje "paramOrder" své pořadí bez ohledu na stav každého parametru.

V editoru wikitext 2010 s TemplateWizard se "požadované" parametry budou vždy zobrazovat nahoře, zatímco "doporučené" parametry se budou vždy objevovat na druhém místě, nad "volitelnými" parametry ("zastaralé" parametry se vůbec nezobrazí; viz popis "zastaralé" pro více informací). "paramOrder" bude vynucovat své pořadí pouze v těchto kategoriích (tj. Všechny "požadované" parametry budou v pořadí specifikovaném "paramOrder" a všechny "doporučené" parametry budou také, ale všechny "doporučené" parametry se objeví pod všemi "požadovanými" parametry).

"paramOrder": [
	"date",
	"reason",
	"talk"
]

Parametry

Parametr Popis Příklad
parameter name

Jedinou položkou první úrovně objektu params je název parametru šablony.

Například ve zdrojovém kódu šablony, pokud vidíte {{{date}}}, je to parametr, který by měl 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 své jméno a znaménko se rovná (tj. |value| místo |parametername=value|). Jejich číslo označuje, jaký prázdný parametr jsou, když se použije více prázdných parametrů. Například, očekávejte, že v roce

{{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.

Každý z těchto objektů "název parametru" (parameter name) by měl obsahovat všechny informace o parametru ve formě více parametrů. Jsou uvedeny v následující části O názvu parametru.

"1": {     // název parametru
    ...    // informace o parametru najdete zde
}

O názvu parametru

Parametr Popis Příklad
aliases

Parametr "aliases" je volitelná položka, pokud má parametr šablony více jmen. Můžete to zkontrolovat tak, že přejdete do zdrojového kódu šablony a hledáte:

{{{parameter1|{{{parameter2}}}}}}, or {{{parameter1|{{{parameter2|}}}}}}

To doslova znamená "Hodnota parametru1. Pokud parametr1 neexistuje nebo nemá hodnotu, hodnota parametru2." V druhém případě to také znamená: "Pokud parametr2 neexistuje nebo nemá hodnotu, žádná hodnota". To znamená, že pokud uživatel vloží některý z těchto parametrů hodnotou, provede stejnou funkci.

Chcete-li vložit parametr "aliases", přidejte text "aliases" následovaný dvojtečkou a mezerou a potom vložte jméno každého alias parametru do uvozovek oddělených čárkami mezi dvěma hranatými závorkami (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 lidsky čitelný název parametru, který se zobrazí v editoru šablon. Zobrazí to namísto nezpracovaného názvu parametru. Tento parametr je sice volitelný, ale velmi se doporučuje.

"label": "Měsíc a rok",
description

V každém objektu pojmenovaném po parametru "description" je popis parametru, nikoli šablony jako celku. Tento popis je zobrazen v nápovědě, když se uživatel pohybuje nad symbolem "i" vedle parametru v editoru šablon. Je volitelný, ale velice doporučený.

"description": "Měsíc a rok, kdy byla šablona vložena.",
type

Parametr "type" je určen k tomu, aby editoru šablon signalizoval povahu hodnoty parametru. V některých případech jsou editory šablon naprogramovány tak, aby upravovaly uživatelské rozhraní pro určitý parametr podle typu jeho hodnoty, aby uživatel mohl pouze zadávat platné hodnoty, které odpovídají danému typu. Tento parametr nemá žádný funkční účinek na parametr nebo jeho hodnotu. Řídí pouze to, jak editoři šablon vidí a zpracovávají parametr v režimu úprav. Nejběžnější typy jsou:

  • "string" - soubor znaků, jako je tato věta;
  • "number" - sada číslic;
  • "boolean" - '0' za false, '1' za true, '' pro neznámé;
  • "wiki-user-name" - množina znaků, která představuje jméno uživatele;
  • "wiki-page-name" - sada znaků, která představuje název stránky.
  • "wiki-file-name" - název souboru.

Mezi další typy patří: "unknown", "date", "url", "wiki-template-name", "content", "unbalanced-wikitext", "line"

Efekty parametru type zobrazíte v sekci #Účinky parametru type.

"type": "string",
default

Někdy je parametr šablony naprogramován tak, aby měl výchozí hodnotu, která se použije, pokud jej nezměníte. Položka "default" je volitelná položka, která má uživateli sdělit, co je tato hodnota. Hodnota nemusí odpovídat skutečné výchozí hodnotě a nemá funkční účinek. Pokud není nastaven žádný výchozí parametr, můžete tento parametr ignorovat.

Výsledky

Ve všech hlavních editorech (VisualEditor, 2017 wikitext editor 2017 a 2010 wikitext editor s TemplateWizard) se "výchozí" 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 popis parametru (když uživatel umístí kurzor myši na symbol "i"). V aplikaci VisualEditor a editoru wikitext 2017 to bude pod popisem parametru, níže: "Pole je povinné" / "Pole je zastaralé", pokud je uvedeno (editor wikitext 2010 tento text nezobrazuje) a nad "příklad", pokud je zadán ("příklad" se nezobrazí v popisu parametru v editoru wikitext 2010). V editoru wikitext 2010 s TemplateWizard se "výchozí" 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" (prodlení), hodnota "example" (příkladu) se ve vstupním poli nezobrazí.

"default": "Category:CommonsRoot",
autovalue

Pro parametr můžete určit "autovalue". Když uživatel přidá šablonu na stránku, tato hodnota se automaticky objeví ve vstupním poli. Například mnoho šablon pro vyčištění má mít přidané datum. Pokud nastavíte automatické odstranění parametru data šablony na {{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}, měsíc a rok, kdy byla šablona přidána, bude vyplněno automaticky.

Tento parametr nevnucuje použití této hodnoty. Uživatel může volně měnit hodnotu, která je automaticky vložena do parametru 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" v VisualEditor a 2017 wikitext editor. Další informace viz popis pro "type".

"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
example

Hodnota "example" je volitelná hodnota určená k zobrazení vzorového vstupu, který ukazuje, jak se parametr používá.

Výsledky

Ve všech hlavních editorech (VisualEditor, 2017 wikitext editor a 2010 wikitext editor s TemplateWizard) zobrazuje šedý text ve vstupním poli libovolného otevřeného parametru, když je prázdný, ve formátu "e.g. example text". V aplikaci VisualEditor a editoru wikitext 2017 navíc zobrazuje stejný text černým písmem bez kurzívy pod popisem parametru (a pod "výchozím" 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

Pak máme "required" (povinné), které lze nastavit na true nebo false. Pokud nic nezadáte, bude to považováno za false.

To určuje, zda je vyplnění parametru pro tuto šablonu povinné.

Výsledky

Tento stav má několik efektů v aplikaci VisualEditor a Editor wikitextu 2017 :

  • způsobí, že se parametr automaticky zobrazí, když uživatel vloží šablonu;
  • zobrazuje vedle hvězdičky šedou hvězdičku;
  • v pravém poli je černá hvězdička;
  • pod popisem parametru je zobrazeno šedou kurzívou "Pole je vyžadováno";
  • způsobí, že vstupní pole svítí červeně, pokud uživatel klepne pryč bez zadání hodnoty;
  • 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 2010 wikitext editor s TemplateWizard, stejně jako v jiných editorech, způsobí, že se parametr automaticky zobrazí, když uživatel vloží šablonu, ale v tomto editoru nelze parametr odstranit. V popisu parametru také nezobrazuje "Pole je vyžadováno"; spíše uvádí parametr na straně v části "Požadované 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 VisualEditor a editoru wikitext 2017 stav "zastaralý" nepřepíše funkčnost tohoto parametru, ale ve wikitextovém editoru 2010 s TemplateWizard ano. Další informace naleznete v popisu "zastaralé".

"required": true
suggested

K dispozici je "suggested", které lze nastavit na true nebo false. Pokud neurčíte, nastaví se na false.

Toto je stav pro parametry, které nejsou "povinné", ale doporučuje se, aby byly pro uživatele šablony vysokou prioritou (ale nejsou povinné).

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í.

Ve <tvar|1>2010 wikitext editor s TemplateWizard neumisťuje parametr do šablony automaticky, ale místo toho způsobí, že bude uveden na straně v části "Navrhované 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" (požadovaný) 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 nic nezadáte, bude to považováno za 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 "Field is deprecated" (pole je ukončeno). popis parametru. 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í "required" (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'."

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 true a false) a je oddělena od dalšího bitu čárkou (pokud není poslední).

Účinky parametru type

Parametr "type" může mít několik různých efektů nebo žádný efekt v závislosti na hodnotě a v závislosti na editoru šablon. Jeho účinky jsou uvedeny následovně.

"number":

Hodnota "number" je určena pro číselné hodnoty, včetně záporných hodnot a desetinných míst.

  • V aplikaci VisualEditor a editoru wikitext 2017 nemá "number" žádný viditelný efekt.
  • V editoru wikitext 2010 s TemplateWizard, "number", způsobí, že se ve vstupním poli zobrazí tlačítko "+" a "-" na obou stranách, které zvýší nebo sníží číselnou hodnotu ve vstupním poli, a uživatel může pouze psát čísla do pole. Tlačítka mohou také snížit počet na záporný.

"string":

Hodnota "string" je určena pro jakýkoli řetězec prostého textu.

  • Ve všech hlavních editorech (VisualEditor, 2017 wikitext editor a 2010 wikitext editor s TemplateWizard) nemá "string" ve srovnání s "unknown" žádný viditelný efekt.

"line":

Hodnota "line" je určena pro obsah, který má zůstat na jednom řádku.

  • 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).

"url":

Hodnota https:// je určena pro adresu URL, včetně internetového protokolu (např. https://).

  • V aplikaci VisualEditor 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" (navrženo) nebo "deprecated" (zastaralé)).
  • V editoru wikitext 2010 s TemplateWizard nemá "url" žádný viditelný efekt.

"wiki-page-name":

Hodnota "wiki-page-name" je určena pro název stránky na wiki.

  • Ve všech hlavních editorech (VisualEditor, 2017 wikitext editor a 2010 wikitext editor 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 VisualEditor 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 aplikaci VisualEditor 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. Ukazuje také miniaturu 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.

  • 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 VisualEditor 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é než šablony.

"wiki-user-name":

Hodnota "wiki-user-name" je určena pro uživatelské jméno na wiki.

  • 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 VisualEditor 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.

"content":

Hodnota "content" je určena pro wikitext obsahu stránky, například pro odkazy, obrázky nebo formátování textu.

  • V aplikaci VisualEditor 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 aplikaci VisualEditor 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í.

S dalšími parametry

  • V aplikaci VisualEditor 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, když uživatel klepne odchod, aniž by zadal platnou adresu URL.
  • 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".

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 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 \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 dojde k neplatnosti řetězce formátového řetězce.

Příklady formátů, které můžete použít
Úkol Formátování řetězce Výstup
Vložené formátování {{_|_=_}}
inline
{{Foo|bar=baz|qux=quux}}{{Bar}}
Blokové formátování {{_\n| _ = _\n}}
block
{{Foo
| bar = baz
| qux = quux
}}{{Bar
}}
Před názvem parametru není mezera,

každá šablona na vlastní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 svislitka 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í, potrubí vpředu \n{{_ |\n _______________ = _}}
{{Foo |
  bar             = baz |
  qux             = quux}}
{{Bar}}

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.

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


Chyby

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.

Tato chyba se může objevit poměrně často při úpravách TemplateData šablony. Mezi nejčastější chyby, které způsobují tuto chybu, patří nadbytečné čárky (například koncové čárky), chybějící čárky a chybějící uvozovky.

Příklady koncové čárky:
<templatedata>
{
    "description": "",
    "format": "inline",
    "params": {
        "1": {
            "label": "",
            "description": "",
            "type": "", // <-- This comma shouldn't be here.
        }, // <-- This comma shouldn't be here.
    }, // <-- This comma shouldn't be here.
}
</templatedata>
Příklady chybějících čárek:
<templatedata>
{
    "description": "",
    "format": "inline" // <-- A comma should be here.
    "params": {
        "1": {
            "label": "",
            "description": "" // <-- A comma should be here.
            "type": ""
        }
    }
}
</templatedata>
Příklad chybějících uvozovek:
"description": An example description // <-- This text should have quotation marks.

Chcete-li tyto chyby opravit, můžete buď hledat chyby v kódu sami, nebo můžete zadat blok JSON do externího validátoru JSON, například JSONLint. Ten zvýrazní problematické čárky a klíče, které by měly být odstraněny.

Díky dlouhodobé chybě mohou uživatelé používající editor wikitext 2010 ukládat stránky, které mají takový neplatný JSON (podrobnosti: task T128029), protože analyzátor JavaScript je méně přísný a umožňuje neplatný JSON.

Požadovaná vlastnost "paramOrder(number)" nebyla nalezena.

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

"params": {
    "date": { ...
    },
    "reason": { ...
    },
    "talk": { ... // <-- This parameter is not stated in "paramOrder", but it should be.
    }
},
"paramOrder": [
	"date",
	"reason"
]

// Error: Required property "paramOrder[2]" not found.

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

Neplatná hodnota pro vlastnost "paramOrder(number)".

K této chybě dochází, pokud uvedete parametr v "paramOrder", který není uveden v "params".Číslo v hranatých závorkách odkazuje na parametr v "paramOrder", 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 "paramOrder" je pole; 0 je první, 1 je druhý atd.

"params": {
    "date": { ...
    },
    "talk": { ...
    }
},
"paramOrder": [
	"date",
	"reason", // <-- This parameter is not stated in "params", but it should be.
    "talk"
]

// Error: Invalid value for property "paramOrder[1]".

Chcete-li to vyřešit, ujistěte se, že všechny parametry uvedené v "paramOrder" jsou uvedeny v "params".Alternativně můžete odebrat objekt "paramOrder" 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ď "povinné"(required) nebo "doporučeno"(suggested).

"suggested": "true" // <-- These quotation marks shouldn't be here.

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 "formát" vlastnosti bude ...

Pokud parametr "format" existuje, ale jeho hodnota není "inline", "block" 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."

"format": "notinline"

// Error : Property "format" is expected to be "inline", "block", or a valid format string.

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ů. Alternativně můžete odstranit tuto chybu pomocí parametru "format".

Neočekávaná vlastnost "parametername".

K této chybě dochází, pokud uvedete parametr v libovolném objektu, který není parametrem tohoto objektu. Může to být způsobeno pravopisnými chybami nebo jste mohli napsat parametr jednoho objektu 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": "", // <-- incorrectly placed parameter
    "params": {
        "1": { // ↓ it should be in here
            "description": "",
            "type": ""
        }
    }
}
</templatedata>

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

Chcete-li to vyřešit, ujistěte se, že jsou vaše parametry na správném místě a že v názvech parametrů nejsou žádné pravopisné chyby. Dále se ujistěte, že neuvádíte žádné parametry, které pro objekt neexistují. Na této stránce můžete zkontrolovat, které parametry objektu existují, v sekci #TemplateData parameters.

Požadovaná vlastnost "params" nebyla nalezena.

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 Wikimedia.

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ý č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.