Nápověda:Strojový popis šablony

From mediawiki.org
This page is a translated version of the page Help:TemplateData and the translation is 61% complete.
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í, 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 Extension: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 "Test Template Info-Icon - Version (2).svg Dokumentace šablony" následovat odkazy jako [zobrazit], [upravit], [historie] a [vyčistit].
  • Několik stránek šablony si zachovalo tyto informace na hlavní stránce šablony. Na těchto stránkách to můžete najít tak, že mezi značkami ‎<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=".

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

Templates without documentation subpages

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

Creating the subpage and moving the documentation
On many Wikimedia wikis, you can only create a page if you have been a registered user there for a number of days and have made a minimum number of edits.

To create the documentation subpage, click "Editovat"/"Editovat zdroj" on the main template page; look for the ‎<noinclude> tags and their contents (usually at the bottom).

It should look something like this:

<noinclude>
{{Documentation|content=
== Usage ==

Information about usage.

== More example headings ==

More example contents

[[Category:Example category]]
[[Category:Example category 2]]
}}
</noinclude>

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

<noinclude>
{{Documentation|content=
...
<templatedata>
{
    "description": "",
    "params": {
        "1": {
            "label": "Example parameter",
            "description": "Example parameter description",
            "type": "string"
        }
    }
}
</templatedata>
</noinclude>

Select everything after "|content=" and before "‎</noinclude>" and cut it into your clipboard or save it in a temporary document. Delete "|content=", leaving only the following:

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

Save the template page.

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

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

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

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

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

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

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

Finally, publish the page.

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

Adding and editing TemplateData on the main template page

If you can't create the /doc page, you can add and edit TemplateData on the template's main page by following the instructions in #Methods.

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

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

Upozornění: Blok Strojového popisu šablony je již uveden na související stránce „[[Template:Templatename/doc]]“.

or

Upozornění: Blok Strojového popisu šablony je již uveden na související stránce „[[Template:Templatename]]“.

If the template has TemplateData on its documentation subpage

If the template has TemplateData on its documentation subpage, this is the page you should edit. You can do this by clicking the "[edit]" located after the heading "Test Template Info-Icon - Version (2).svg Template documentation" (or similar), or, if you are already on the /doc page, by clicking "Editovat" or "Editovat zdroj" at the top. Follow the guidance at #Methods to add or edit the TemplateData.

If the template has TemplateData on its main page

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

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

Moving TemplateData to the documentation subpage

To do this, click "Editovat"/"Editovat zdroj" on the main template page, and look for the ‎<templatedata> tags, enclosed within ‎<noinclude> tags. It should look something like this:

<noinclude>
{{Documentation}}
<templatedata>
{
    "description": "",
    "params": {
        "1": {
            "label": "Example parameter",
            "description": "Example parameter description",
            "type": "string"
        }
    }
}
</templatedata>
</noinclude>

Cut only the ‎<templatedata> tags and their contents out of the code, then save the page.

Next, edit the documentation subpage by clicking the "[edit]" located after the heading "Test Template Info-Icon - Version (2).svg Template documentation" (or similar).

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

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

Editing TemplateData on the main template page

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

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

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

Do this by clicking the "[edit]" located after the heading "Test Template Info-Icon - Version (2).svg Template documentation" (or similar), or, if you are already on the /doc page, by clicking "Editovat" or "Editovat zdroj" at the top. Type a heading, like "TemplateData", then add it beneath this heading. The section #Methods explains how to add TemplateData.

Methods

Metoda editoru TemplateData

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

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

After clicking "Editovat" or "Editovat zdroj", you will see a button above the editing area and page title that says "Spravovat Strojový popis šablony".

Manage template documentation button for TemplateData 2014.png

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

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

Features in the above window:

  • The top item chooses the language of the interface text. It allows you to enter text content in multiple languages, displayed to users based on their settings in Preferences, not based on the wiki's language; different wikis have entirely different template databases. If no language TemplateData exists, the interface will only offer users the wiki's own language, but users can click "Přidat jazyk" to add more inputs. The language code is displayed in brackets next to the parameters to which it can be applied, such as descriptions and labels.
  • The next item is the template description. This is the description of the template as a whole; it's shown to users in numerous places in the template editors while adding a template. This parameter and its effects are outlined here.
  • The third item controls the wikitext formatting of the template. This parameter determines how the wikitext will be laid out when the user clicks "Použít", the two main types being "inline" (on one line) and "block" (on new lines). This parameter and its effects are outlined here.
If the user chooses "Vlastní", they can enter wikitext under "Vlastní formátovací řetězec" according to rules outlined here, in order to create a custom layout for the template when the user clicks "Použít".
  • The fourth item configures a template's parameters. If parameters have already been defined in TemplateData, this area displays them in a list. If the template's source code specifies parameters for which no TemplateData exists, you may see a button labeled "Přidat 2 navržené parametry". The editor extracts these suggestions from the template's source code by looking for {{{parametername}}} or {{{parametername|}}}. Clicking "Přidat 2 navržené parametry" will add these parameters using their names as defined in the source code. A green notice will also appear at the top, for example, "Byly naimportovány 2 nové parametry: names of parameters".
  • At the bottom of the window you see an "Přidat parametr" button. This allows you to add a parameter manually with a custom name.

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

Snímek obrazovky editoru TemplateData zobrazující přidávaný druhý parametr

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

  • The TemplateData editor will not allow you to change a parameter to a blank "Název". Parameters in TemplateData that somehow acquire blank strings as names will not cause issues in the 2010 wikitext editor with TemplateWizard, but neither VisualEditor nor the 2017 wikitext editor will display them at all. This is the only mandatory field in the TemplateData editor.
  • Clicking "Odstranit informace o parametru" will delete the parameter and all its information from the TemplateData. You can't retrieve or undo this in the TemplateData unless you click "X" afterwards. You can undo any changes made after clicking "Použít" by hitting Ctrl+Z.
  • Exiting the TemplateData editor after making changes prompts you to confirm that you want to discard your changes.

When finished, click "Odstranit informace o parametru". This will automatically insert the TemplateData at the bottom of the page before the ‎</noinclude> tag; or, if already present, it will be updated with the new information without changing its position. The TemplateData text will also be selected when you click "Odstranit informace o parametru".

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

After this, click "Uložit" to save your revision of the page.

Manual method

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

Adding TemplateData manually

Considerations:

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

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

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

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

<templatedata>
{

}
</templatedata>

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

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

<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

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

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

The corresponding TemplateData documentation would display as follows:

Use this template to indicate that an article is in need of cleanup.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Month and yeardate

The month and year that the template was added

Example
January 2013
Auto value
{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}
Stringsuggested
Reasonreason 1

The reason the article is in need of cleanup

Stringoptional
Talk page sectiontalk talksection

The section of the talk page containing relevant discussion

Stringoptional

TemplateData parametry

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

  • 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. Je to striktně textový řetězec.
  • New lines ("\n") in descriptions, labels, examples or defaults will not show in any of the main editors (TemplateWizard, VisualEditor or the 2017 wikitext editor), even though they show in the auto-generated TemplateData documentation. They are replaced by a null string in input forms and by a space elsewhere.
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 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ávají 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ásleduje "...", 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]). 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:Templatename" 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í):
„Tato šablona nemá žádný popis.“
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):

{{int|quotation-marks|[<translate>circles and pipes icon</translate>] {{int|templatedata-doc-format-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:

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

{{int|quotation-marks|[<translate>stacked blocks and pipes icon</translate>] [[int|templatedata-doc-format-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 zobrazí následující upozornění na předvolby v dokumentaci TemplateData:

"[<translate>cogwheel icon</translate>] {{int|templatedata-doc-format-custom}}"

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ů, 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ý může při přidání do editoru šablon vynutit zobrazení parametrů v určitém pořadí.

How to use

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. End with a closed square bracket (creating an array).

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.

We recommend you place "paramOrder" after "params", as the TemplateData editor does; it isn't displayed in the TemplateData documentation but simply forces the order of the parameters. A future editor may wish to quickly look through the parameter details and edit them rather than scrolling past the "paramOrder", especially if there are a lot of parameters. If you do choose to place paramOrder somewhere besides the end of the TemplateData, end it with a comma.

Musíte zahrnout každý parametr uvedený v TemplateData. Jinak se zobrazí chyba "Nenalezena vyžadovaná vlastnost „správně pojmenovat“. (properlyname)".

If not specified

Without "paramOrder", the template's parameters will display in the order in which the template's source code declares them. If the source code contains objects inside objects, the parameters in outer objects will come first, followed by inner objects.

With other parameters

V editoru wikitextu 2010 s TemplateWizard:

  • Se "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"
]

Parametry

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, 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 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. Finally, note that "aliases" creates alternatives to the parameter name which can be used interchangeably, and "label" replaces the parameter name in the user interface with the specified label (for situations in which the parameter name is not human readable or easily understood).

How to use

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 to zkontrolovat tak, že přejdete do zdrojového kódu šablony a hledáte:

{{{parameter1|{{{parameter2}}}}}}

or

{{{parameter1|{{{parameter2|}}}}}}

To znamená, že pokud uživatel vloží některý z těchto parametrů 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. End with a closed square bracket, creating an array.

"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

Zde je "description" popis parametru, nikoli šablony jako celku. This description appears below the parameter name (a long descriptions will be shortened with a button to optionally expand it). Je volitelný, ale velice doporučený.

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

See the [[<tvar name=1>#Type parameter</tvar>|#Type parameter]] section.

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 dokumentární. 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. (Not to be confused with "autovalue", which is a functional parameter that fills in a field for the user.)

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 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 ("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

A parameter can be assigned an "autovalue". When a user adds the template to a page, this value will automatically appear in the input box. For example, many cleanup templates need the date added; setting the "autovalue" for the template's date parameter to be {{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}, the month and year that the template was added will be filled in automatically.

This value can be overwritten by the user in the template editor.

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

Parametr "example" je volitelný a pouze dokumentární. 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

Pak máme "required" (povinné), které 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 Editor wikitextu 2017 :

  • způsobí, že se parametr automaticky zobrazí, když uživatel vloží šablonu;
  • v pravém poli je černá hvězdička;
  • pod popisem parametru je zobrazeno šedou kurzívou "Pole je povinné.";
  • 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 WikiEditor na stránce Nápověda:Rozšíření:Šablonový pomocník , stejně jako v ostatních editorech se zobrazuje parametr automaticky, při vložení šablony uživatelem, 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 VisualEditor a editoru wikitext 2017 stav "deprecated" nepřepíše funkčnost tohoto parametru, ale ve wikitextovém editoru 2010 s TemplateWizard ano. Další informace naleznete v popisu ""deprecated"" (zastaralé).

"required": true
suggested

K dispozici je "suggested", které lze nastavit na true nebo false. Pokud není specifikováno, je výchozí hodnota false.

Use "suggested" for parameters that are not mandatory but strongly recommended for template users to provide. When filling in this parameter, a user will see this suggestion.

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

The parameter property suggestedvalues lets you define a list of parameter values to be shown to VisualEditor users in a dropdown for easy selection. This can be done either directly in JSON or using the TemplateData editor (no coding required). You can add suggested values to be displayed in the VisualEditor for parameters which have their type set to one of the following options (reference):

  • content
  • line
  • string
  • number
  • unknown
  • unbalanced wikitext

Other types (file, page, template, user, date, boolean, URL) are not currently supported because they have special functionalities in the VisualEditor already, such as autocomplete, which would interfere with the drop-down menu for suggested values in the VisualEditor.

Editing TemplateData as JSON in wikitext

To add suggested values to any parameter type, add the new property "suggestedvalues" to the parameter in JSON. The “suggestedvalues” attribute must be a list of strings.

Editing TemplateData with the TemplateData Editor

  1. Click on "Spravovat Strojový popis šablony".
  2. Click on the name of the parameter you want to add suggested values to.
  3. If it’s not already done, set parameter type to one of the following: content, line, string, number, unknown, unbalanced wikitext. A new input field "Doporučené hodnoty" will appear. If the parameter is already set to one of these types, the input field should already be visible.
  4. Type in the suggested value(s), including any spaces and special characters, and press enter to add the value(s) to the list.

Effects

Once the values have been added to TemplateData, the VisualEditor will display them in a combo box (a dropdown into which users can also enter a custom value) for the parameter types listed above. The user selects the desired value by clicking on it. If the list of values is long -- for example, a list of a country’s states -- the user can begin typing in the field, whereupon the list will be filtered to show only values containing the typed text. To change an entered value, the user must simply clear the field, and the full dropdown list will appear again. If the user needs a value not included in the list (for example, "message in a bottle") they can type it in manually.

	"suggestedvalues": [
		"Journal",
		"Book",
		"Newspaper",
		"Magazine"
	]

Poznámka: Pokud ani "required", "suggested" ani "deprecated" nejsou pro parametr nastaveny jako true, jeho stav se v dokumentaci TemplateData zobrazí jako "optional".

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

Zadejte parametr

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

How to use

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

Example:

"type": "string",

Effects

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

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

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

Value Description
unknown

The "unknown" value is the default type value if no type is set. It can also be set manually by typing "type": "unknown".

Effects

In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "unknown" has no visible effects compared to a template without TemplateData.

number

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

Effects

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

With other parameters

  • 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".
string

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

Effects

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.

Effects

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

The "boolean" value is intended for a value that is either true, false or unknown. This is intended by the manual to be represented by a "1", "0" or blank value.

Effects

As of February 2020, none of the main Wikimedia editors (VisualEditor, 2017 wikitext editor or the 2010 wikitext editor with TemplateWizard) make use of this value. It has no visible effects.

With the autovalue:0 checkbox appears in the VisualEditor, which can be switched on and off.

date

The "date" value is intended for a date in the YYYY-MM-DD (ISO 8601) format; for example, 2014-05-22. The TemplateData manual also designates it as being intended for ISO 8601 date–time combinations, such as 2014-05-22T16:01:12Z", but in practice no major editing interface as of February 2020 uses it in this fashion, and almost all major Wikimedia template parameters take dates and times separately.

Effects

  • In VisualEditor and the 2017 wikitext editor, "date" has no visible effect.
  • In the 2010 wikitext editor with TemplateWizard, "date" makes the parameter input box about a third shorter and adds a dropdown calendar, allowing the user to choose a date input. It also displays the grey example text in the input box "YYYY-MM-DD". If an input does not conform to this standard, the box glows red, however the editor will always output a date conforming to the standard (if numbers are entered) or nothing (if only text or nothing is entered).

With other parameters

  • In the 2010 wikitext editor with TemplateWizard, "date" overrides the effects of "autovalue"; the value of "autovalue" will not be automatically placed in the input box if the parameter type is "date".
url

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

Effects

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

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.
wiki-page-name

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

Effects

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

Effects

  • 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. The file names do not contain the "File:" namespace prefix. 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.

Effects

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.

Effects

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.

Effects

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

Effects

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

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

Syntaktická chyba v JSON. / Bad JSON

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

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

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

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

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

K této chybě dochází, pokud uvedete parametr v "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ď "required" nebo "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 "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"

// 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".

This error occurs if you state a parameter that does not exist in TemplateData. This is probably due to spelling mistakes.

<templatedata>
{
    "description": "",
    "format": "inline",
    "params": {
        "1": {
            "label": "",
            "descriptino": "", // <-- spelling mistake
            "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": "", // <-- 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 provést opravu, ujistěte se, že v názvech parametrů nejsou žádné pravopisné chyby a ujistěte se, že vaše parametry jsou správně umístěny. Additionally, make sure you don't state any parameters that don't exist for a TemplateData object. You can check which parameters exist for an object in the section #TemplateData parameters.

Požadovaná vlastnost "params" nebyla nalezena.

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