Extension:TemplateData/cs

Rozšíření TemplateData zavádí značku a API, které společně umožňují editorům určit, jak mají být šablony vyvolány. Tato informace je k dispozici jako formátovaná tabulka pro koncové uživatele a jako JSON API, které umožňuje jiným systémům (např. VisualEditor) vytvářet rozhraní pro práci se šablonami a jejich parametry. Podrobnou nápovědu najdete v.

Úpravy dat
Rozšíření TemplateData funguje tak, že ve wikitextu šablony stránky je definována značka (volitelně může být také přenesena z jiné stránky). Toto je navrženo tak, aby bylo kompatibilní s běžným rozvržením, které má mnoho wiki při předávání dokumentace k šablonám ze samostatné stránky (není to však nutné). Tento obsah značky musí být platný JSON ve formátu popsaném níže. Všimněte si, že všechny popisy musí být ve formátu prostého textu (v datech šablony není akceptován žádný wikitext).

Je-li na stránce zahrnut blok, provede rozšíření TemplateData při ukládání stránky následující kontroly:


 * 1) Obsah musí být platný JSON;
 * 2) Každá položka ve struktuře JSON musí být očekávaného typu, jak je uvedeno níže (např. Objekt, pole nebo primitiv); a
 * 3) U položek, které mají specifikovaný seznam možných hodnot (např.  ), musí hodnota v objektu JSON odpovídat jedné z těchto hodnot.

Pokud některá z těchto kontrol selže, server nebude moci ukládat a nad editační stránkou se zobrazí chybová zpráva.

U položek s automatickým přidáním bug 2700 zabraňuje práci  v jakékoli šabloně přidané uvnitř, včetně tagů  a. Blok TemplateData se uloží správně, ale výsledný wikitext nebude při použití šablony správně analyzován.

Všimněte si, že nemůžete použít  místo.

Formát
Níže je vizualizovaná verze dat JSON, jak je definována na stránce šablony uzavřené značkami. Formální specifikace je k dispozici v repozitáři TemplateData. Nejnovější verzi najdete na Specification.md.

Objekt TemplateData
Objekt TemplateData je kořenový prvek JSON uzavřený v prvku  na stránce šablony.

Text rozhraní (řetězec nebo objekt)
A free-form plain-text string (i.e. no wikitext or HTML) in the content-language of the wiki, or an object containing those strings keyed by language code.

The default value for all InterfaceText fields is.

String type
If it is a string, it must contain a non-localized string in the content language of the local wiki.

Object type
If it is an object, the object must have this mapping:

Example
An example TemplateData structure as specified within wikitext on a template page. Below is how the above example would be displayed on the template page: {   "description": "Label unsigned comments in a conversation.", "params": { "user": { "label": "User's name", "type": "wiki-user-name", "required": true, "description": "User name of person who forgot to sign their comment.", "aliases": ["1"] },       "date": { "label": "Date", "suggested": true, "description": { "en": "Timestamp of when the comment was posted, in YYYY-MM-DD format." },           "aliases": ["2"], "autovalue": "" },       "year": { "label": "Year", "type": "number" },       "month": { "label": "Month", "inherits": "year" },       "day": { "label": "Day", "inherits": "year" },       "comment": { "required": false }   },    "sets": [ {           "label": "Date", "params": ["year", "month", "day"] }   ],    "maps": { "ExampleConsumer": { "foo": "user", "bar": ["year", "month", "day"], "quux": [ "date", ["day", "month"], ["month", "year"], "year" ]       }    } }

API
See the generated help at Special:ApiHelp/templatedata. A sample invocation (formatted for human readability) is:

This returns the template data for Template:Cite web. The ... block for this template is on its transcluded template documentation page, en:Template:Cite web/doc.

Additions and changes to JSON as received from the API
The JSON structure provided in response to an API HTTP get request is significantly different than that which is defined in the ... block. In response to the API request, extension TemplateData makes the following changes to the JSON object:
 * Adds two wrapping objects:
 * An overall Pages Object containing one or more Page Objects
 * An object with a numeric key: a Page Object
 * Additions/changes to the actual TemplateData Object
 * Add the  key with the name of the page from which the data was requested (e.g. "Template:Cite web").
 * Add the  key and array using the order in which the parameters occur in the   key within the TemplateData Object on the template page.
 * Add the  key
 * Change all TemplateText occurrences that are just strings to objects with a single key for the current wiki's Wikipedia language code
 * Remove all  keys.
 * Add all properties from parameter from which an inheritance is defined which are not superseded by explicitly defined keys in the inheritor's Parameter Object.
 * Add default values for all keys in each Parameter Object which have not been explicitly defined or inherited.

Example of JSON object provided by API
The response to an API request for the TemplateData structure in the Example section (above) can be seen:
 * In HTML format: https://www.mediawiki.org/w/api.php?action=templatedata&titles=Extension:TemplateData&format=jsonfm
 * As delivered by the API: https://www.mediawiki.org/w/api.php?action=templatedata&titles=Extension:TemplateData