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. | |
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 dat šablony součástí výchozího uživatelského prostředí pro všechny uživatele na všech wikin 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í dat šablony 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 dat šablony, 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í data šablony, zobrazí tyto informace v uživatelském rozhraní, pokud uživatel přidá šablonu. V některých případech se chování editoru změní, pokud 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
Data šablony byla původně vyvinuta na začátku roku 2013 s ohledem na VisualEditor, což bylo v té době ve fázi testování MediaWiki. Vizuální editor je hlavní vizuální editační rozhraní pro wikiny Wikimedie a data šablony mu umožnila mít užitečnější rozhraní při přidávání šablon. To bylo okamžitě oficiálně podporováno vizuálním editorem. Vzhledem k tomu, že vizuální editor byl rozšířen na různé hlavní wikiny Wikimedie jako výchozí funkce od roku 2013 do roku 2016. Data šablony se také stala jejich součástí.
V prosinci 2016 bylo rozhraní vizuálního editoru zpřístupněno pro úpravy zdrojového kódu jako funkce beta. Bylo nazýváno Editor wikitextu 2017. To poprvé přineslo funkci dat šablony do úpravy zdroje.
V březnu 2018 společnost Sam Wilson vyvinula rozšíření TemplateWizard, rozšíření editoru GUI pro výchozí zdrojový editor Wikimedie, WikiEditor (jinak známý jako Editor wikitextu 2010), jehož cílem je usnadnit proces přidávání šablon pomocí informací z dat šablony. V dubnu 2019 byl TemplateWizard nastaven jako výchozí součást Editoru wikitextu 2010 na všech wikinách Wikimedie. To znamenalo, že data šablony se stala výchozí součástí vizuálního editoru i zdrojového editoru na wikinách Wikimedie.
Přidání nebo úprava dat šablony
Chcete-li přidat nebo upravit data šablony, 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 dat šablony zkontrolujte, zda má šablona podstránku dokumentace. Poté zkontrolujte, zda šablona již obsahuje data šablony a pokud ano, zda se nachází na stránce šablony nebo na podstránce dokumentace.
Dokumentace podstránek
Existují dva hlavní způsoby, jak šablony na většině wikin 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].
- Na šablonách s podstránkami dokumentace budou za nadpisem "
- 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é wikiny mohou toto vše prezentovat různě.
Zřídka 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 data šablony na podstránku dokumentace.
Vytvoření podstránky a přesun dokumentace
Chcete-li vytvořit podstránku dokumentace, klikněte na "Editovat"/"Editovat zdroj" na hlavní stránce šablony; v. 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 data šablony. 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}}.
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 wikin 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 data šablony na podstránce dokumentace pomocí pokynů popsaných v odstavci Metody.
Přidání a úprava dat šablony na hlavní stránce šablony
Pokud nemůžete vytvořit stránku /doc, můžete přidat a upravit data šablony 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 dat šablony (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 data šablony 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 „Template:Templatename/doc“.
nebo
- Upozornění: Blok strojového popisu šablony je již uveden na související stránce „Template:Templatename“.
Pokud šablona obsahuje data šablony na své podstránce dokumentace
Pokud má šablona na své podstránce dokumentace data šablony, je to stránka, kterou byste měli upravit.
Můžete to udělat kliknutím na "[edit]" umístěným za nadpisem ".svg){kind=icon}
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 data šablony, postupujte podle pokynů v Metodách.
Pokud má šablona na hlavní stránce data šablony
Pokud má šablona na hlavní stránce data šablony, máte opět dvě možnosti:
- Můžete se buď přesunout na jeho podstránku dokumentace. Toto je preferovaná možnost.
- Nebo je můžete upravit na hlavní stránce šablony.
Přesun dat šablony 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": "Popis příkladu 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ěném za nadpisem " Dokumentace šablony" (nebo podobně).
Zadejte nadpis, například "Data šablony", a pod něj vložte data šablony.
Nyní můžete upravovat data šablony na základě pokynů v Metodách.
Úprava dat šablony na hlavní stránce šablony
Pokud si nepřejete přesunout data šablony na stránku /doc, můžete je upravit na hlavní stránce šablony. Viz Metody, jak upravit data šablony.
Pokud šablona ještě nemá data šablony, ale má podstránku dokumentu
Pokud šablona ještě nemá data šablony, 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 "Data šablony", a poté je přidejte pod tento nadpis.
Sekce Metody vysvětluje, jak přidat data šablony.
Metody
Metoda editoru dat šablony
Toto je jednoduchý způsob, jak přidat nebo upravit data šablony, doporučený pro méně zkušené uživatele.
Editor dat šablony je grafické uživatelské rozhraní pro přidávání a úpravy dat šablony. 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 dat šablony (TemplateData editor). Pokud stránka, na které jste, již obsahuje data šablony, 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é wikiny 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" (add language) 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 (template description). 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 zdokumentovány níže.
- Třetí položka řídí formátování wikitextu šablony (suggested wikitext formatting). 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 zdokumentovány níže.
- Pokud uživatel zvolí "Vlastní", může zadat wikitext pod "Vlastní formátovací řetězec" podle Pravidel vlastních formátů zdokumentovaných níže, aby vytvořil vlastní rozvržení pro šablonu, když uživatel klikne na "Použít".
- Čtvrtá položka konfiguruje parametry šablony (template parameters). Pokud již byly parametry v datech šablony definovány, tato oblast se zobrazí v seznamu. Pokud zdrojový kód šablony specifikuje parametry, pro které neexistují data šablony, 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.
- 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ží data šablony na konec stránky před značku </noinclude>. Nebo, pokud již existuje, budou aktualizována o nové informace, aniž by se změnila jejich poloha.
Text dat šablony bude také vybrán, když kliknete na "Použít".
Editor dat šablony vytvoří parametr "paramOrder" ve spodní části dat šablony (nebo jej, pokud již existuje, aktualizuje).
"paramOrder" obsahuje aktuální parametry dat šablony v pořadí, v jakém byly zobrazeny editorem dat šablony.
"paramOrder" můžete změnit přetažením parametrů nahoru a dolů v editoru dat šablony pomocí tří vodorovných pruhů vlevo.
"paramOrder" a jeho účinky jsou zdokumentovány níže.
Poté klikněte na "Uložit" pro uložení revize stránky.
Ruční metoda
Data šablony můžete také přidat nebo upravit ručně.
Struktura dat šablony je založena na standardu JSON, ale nemusíte se učit JSON, abyste zjistili, jak umístit data šablony.
Data šablony se řídí několika velmi jednoduchými pravidly a přijímají 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í dat šablony
Vezměte na zřetel:
- Pokud přidáváte data šablony 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 data šablony obvykle v dolní části stránky s dokumentací. Na německé Wikipedii jsou obvykle nahoře.
- Pokud přidáváte data šablony 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 data šablony, a napište nadpis: "Data šablony".
Mnoho wikin má šablonu {{TemplateData header}}, která přidává krátká upozornění týkající se dat šablony. Pokud je má i vaše wiki, přidejte je za nadpis.
Chcete-li začít přidávat data šablony, 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 dat šablony. Většinou jsou 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 dat šablony 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 „propertyname“.".
Příklad
Zde je několik příkladů dat šablony 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. Data šablony 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 dat šablony by se zobrazila takto:
Použijte tuto šablonu k označení, že článek potřebuje vyčistit.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Měsíc a rok | datum | Měsíc a rok, kdy byla šablona přidána
| 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 dat šablony
Všechny dostupné parametry dat šablony 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, vizuálním editor nebo Editor wikitextu 2017), i když se zobrazují v automaticky generované dokumentaci dat šablony. Ve vstupních formulářích jsou někde nahrazeny prázdným řetězcem a jinde mezerou.
| Parametr | Popis | Příklad |
|---|---|---|
| description |
Parametr 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 WikiEditor s TemplateWizardem) se popis zobrazuje ve dvou hlavních případech:
Ve vizuálním editoru a Editoru wikitextu 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 dat šablony pod podtitulem "Data šablony pro [název šablony]" (template data for [template name]). Dodatek:
|
"description": "Šablona pro propojení na kategorii commons",
|
| format |
Parametr 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: ( Když je šablona vložena, rozloží svůj wikitext na jediný řádek bez mezer mezi prvky. Například:
Blok: ( 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
| longparameter = 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 Měl by obsahovat název každého parametru, za nímž následuje sada sub-parametrů dat šablony 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": {
... // popis parametru
}, // a zde
"parameter3": {
... // popis parametru
} // ale tady ne
}
|
| paramOrder |
Jak jej používat Přidejte parametr Parametry nemusí být na nových řádcích (mohou být zapsány jako Doporučujeme umístit Musíte zahrnout každý parametr uvedený v datech šablony. Jinak se zobrazí chyba "Nenalezena vyžadovaná vlastnost „správně pojmenovat“. (propertyname)". Pokud není specifikováno Bez S jinými parametry V Editoru wikitextu 2010 s TemplateWizardem:
V aplikaci vizuálního editoru a v Editoru wikitextu 2017 vynucuje |
"paramOrder": [
"date",
"reason",
"talk"
]
|
V rámci parametrů
| Parametr | Popis | Příklad |
|---|---|---|
| Jméno parametru |
Jedinou položkou první úrovně objektu Například ve zdrojovém kódu šablony Můžete také vidět parametry s názvem
Poznámka: Uživatel může přesto vynutit použití 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 vzorových datových 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
nebo
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": ["1", "talk", "talksection"],
|
| inherits |
Chcete-li použít tento parametr, zadejte |
"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": "Měsíc a rok",
|
| description |
|
"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 Výsledky Ve všech hlavních editorech (visualní editor, Editor wikitextu 2017 a Editor wikitextu 2010 s TemplateWizardem) se S dalšími parametry Ve všech hlavních editorech (vizuální editor, Editor wikitextu 2017 a Editor wikitextu 2010 s TemplateWizardem), je-li zadáno |
"default": "Category:CommonsRoot",
|
| autovalue |
Parametru lze přiřadit Tuto hodnotu může uživatel přepsat v editoru šablon. S dalšími parametry Ve všech hlavních editorech (vizuální editor, Editor wikitextu 2017 a Editor wikitextu 2010 s TemplateWizardem), |
"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
|
| example |
Parametr Výsledky Ve všech hlavních editorech (vizuální editor, Editor wikitextu 2017 a Editor wikitextu 2010 s TemplateWizardem). Tato vlastnost je zobrazena pod popisem parametru (a pod S dalšími parametry Ve všech hlavních editorech (vizuální editor, Editor wikitextu 2017 a Editor wikitextu 2010 s TemplateWizardem) se |
"example": "January 2013",
|
| suggested values |
Vlastnost parametru
Jiné typy (file, page, template, user, date, boolean, URL) nejsou aktuálně podporovány, protože již mají speciální funkce ve vizuálním editoru, jako je automatické dokončování, které by narušovalo rozevírací nabídku pro navrhované hodnoty ve vizuálním editoru. Úpravy dat šablony 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 dat šablony pomocí editoru dat šablony
Výsledky Jakmile budou hodnoty přidány do dat šablony, vizuální editor 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"
]
|
| Status option | Description | Example |
|---|---|---|
| required |
Parametr Určuje, zda je vyplnění daného parametru pro šablonu povinné. Výsledky Tento stav má několik efektů v aplikaci vizuálního editoru a v Editor wikitextu 2017:
V WikiEditor na stránce Rozšíření:TemplateWizard, 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 vizuálního editoru a Editoru wikitextu 2017 stav |
"required": true
|
| suggested |
Parametr Použijte Výsledky V aplikaci vizuálního editoru 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 WikiEditor s TemplateWizardem 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 |
"suggested": true
|
| deprecated |
Nakonec je zde zastaralé 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 vizuálního editoru a Editoru wikitextu 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ů (vizuální editor, Editor wikitextu 2017 nebo Editor wikitextu 2010) nezobrazí uživatelům obsah tohoto řetězce.
Zadání řetězce má stejný účinek jako V Editoru wikitextu 2010 s TemplateWizardem nastavení této hodnoty jako S dalšími parametry Pokud nastavíte jak toto, tak Pokud nastavíte toto i V Editoru wikitextu 2010 s TemplateWizardem, |
"deprecated": "Místo toho použijte 'publicationDate'."
|
Poznámka: Pokud "required", "suggested" ani "deprecated" nemají parametr nastavený jako true, jejich stav se v dokumentaci dat šablony 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í dat šablony, 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í).
Zadání parametru
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 dat šablony, 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 vizuálním editoru a Editoru wikitextu 2017, zatímco 8 má viditelné výsledky v TemplateWizardu.
Úč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 Výsledky Ve všech hlavních editorech (VisualEditor, Editor wikitextu 2017 a Editor wikitextu 2010 s TemplateWizardem) nemá | |
| string |
Hodnota Výsledky Ve všech hlavních editorech (vizuální editor, Editor wikitextu 2017 a Editor wikitextu 2010 s TemplateWizardem) nemá | |
| line |
Hodnota Výsledky
| |
| content |
Hodnota Výsledky
| |
| unbalanced-wikitext |
Hodnota Výsledky
| |
| wiki-page-name |
Hodnota Výsledky Ve všech hlavních editorech (vizuální editor, Editor wikitextu 2017 a Editor wikitextu 2010 s TemplateWizardem), | |
| wiki-file-name |
Hodnota Výsledky
| |
| wiki-template-name |
Hodnota Výsledky Ve všech hlavních editorech (vizuální editor, Editor wikitextu 2017 a Editor wikitextu 2010 s TemplateWizardem) | |
| wiki-user-name |
Hodnota Výsledky Ve všech hlavních editorech (vizuální editor, Editor wikitextu 2017 a Editor wikitextu 2010 s TemplateWizardem) | |
| number |
Hodnota Výsledky
S jinými parametry
| |
| boolean |
Hodnota Výsledky Od února 2020 žádný z hlavních editorů Wikimedie (vizualizační editor, Editor wikitextu 2017 nebo Editor wikitextu 2010 s TemplateWizardem) tuto hodnotu nevyužívá. Nemá žádné viditelné účinky. Ve vizuálním editoru se objeví zaškrtávací políčko | |
| date |
Hodnota Výsledky
S jinými parametry
| |
| url |
Hodnota Výsledky
S dalšími parametry
| |
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\npro nové řádky).|- potrubí, trubka, svislá čára, svislítko (odděluje parametry)=- znaménko rovná se (předchází hodnotě parametru)\nnebo stisknutí klávesy Enter - nový řádek (ve vstupním poli se zobrazí jako↵)\nk odsazení nových řádků)}}- konec šablony
Wikitext by měl splňovat minimálně {{_|_=_}}, jinak bude neplatný formátovací řetězec.
| Zadání | Formát řetězce | Výstup |
|---|---|---|
| Inline formátování | {{_|_=_}} inline
|
{{Foo|bar=baz|longparameter=quux}}{{Bar}}
|
| Blokové formátování | {{_\n| _ = _\n}} block
|
{{Foo
| bar = baz
| longparameter = quux
}}{{Bar}}
|
| Žádná mezera před názvem parametru, každá šablona na samostatném řádku | \n{{_\n|_ = _\n}}\n
|
{{Foo
|bar = baz
|longparameter = quux
}}
{{Bar}}
|
| Odsazení každého parametru | {{_\n |_ = _\n}}
|
{{Foo
|bar = baz
|longparameter = quux
}}{{Bar}}
|
| Zarovnání všech názvů parametrů s danou délkou | {{_\n|_______________ = _\n}}\n |
{{Foo
|bar = baz
|longparameter = quux
|veryverylongparameter = bat
}}
{{Bar}}
|
| Znaky svislítka na konci předchozího řádku | {{_|\n _______________ = _}}
|
{{Foo|
bar = baz|
longparameter = quux}}{{Bar}}
|
| Vložený styl s více mezerami musí být na začátku řádku | \n{{_ | _ = _}}
|
{{Foo | bar = baz | longparameter = quux}}
{{Bar }}
|
| Šablona na začátku řádku, parametry zarovnány podle odsazení, svislítko vpředu | \n{{_ |\n _______________ = _}}
|
{{Foo |
bar = baz |
longparameter = quux}}
{{Bar}}
|
Prázdná předloha
Můžete zkopírovat prázdnou boilerplate (předlohu) níže a přidat do šablony nová data šablony. 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í dat šablony, obvykle ručně upravovaných, s neplatným kódem JSON (duplicitní klíče/parametry, koncové nebo chybějící čárky atd.) ve vizuálním editoru nebo v Editoru wikitextu 2017.
"Syntaktická chyba v JSON." se objeví ve vizuálním editoru a v Editoru wikitexu 2017. Při úpravách v editoru GUI dat šablony 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 dat šablony. 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 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ý je v datech šablony neznámý. Je to pravděpodobně způsobeno pravopisnými chybami nebo použitím velkých písmen místo malých.
<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 data šablony, který není parametrem daného objektu. Může to být způsobeno pravopisnými chybami nebo jste možná zapsali parametr jednoho objektu dat šablony pod jiný objekt, ke kterému nepatří.
Například byste mohli napsat parametr "label" pod kořenový objekt dat šablony 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 dat šablony neexistují. V sekci Parametry dat šablony můžete zkontrolovat, které parametry pro objekt existují.
Nenalezena vyžadovaná vlastnost „params“.
K této chybě dochází, pokud v datech šablony 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 – Data šablony jsou 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 data šablony, dejte nám prosím vědět na [1].
- Prodlevy při zobrazování v šablonách – Po přidání dat šablony 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í:TemplateWizard
- Dialogové okno panelu nástrojů pro zadávání wikitextů šablony pomocí formuláře vytvořeného z dat šablony.
- TemplateData Wizard
- Nástroj, který generuje data šablony 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 daty šablony na této wiki
- V šabloně dewiki dat šablony 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