Extension:TemplateData/ru

Расширение TemplateData вводит тег и API, которые позволяют редакторам определять использование шаблона. Эта информация доступна в виде красиво отформатированной таблицы для конечных пользователей и в виде API в формате JSON, который позволяет другим системам (например, VisualEditor) создавать интерфейсы для работы с шаблонами и их параметрами. См. для детальной информации.

Редактирование данных
Расширение TemplateData работает через определение тэга, определенного в вики-разметке страницы шаблона (по желанию его также можно перенести с другой страницы). Оно было разработано, чтобы быть совместимым с общим макетом, который есть во многих вики, включая документацию шаблона с отдельной страницы (но не обязательно). Содержимое тега должно быть валидным JSON, использующим описанный ниже формат; обратите внимание, что все описания должны быть простым текстом (в данных шаблонах не должно присутствовать вики-разметки).

Когда помещён на страницу, расширение TemplateData выполняет следующие проверки при сохранении:


 * 1) Содержание должно быть валидным JSON;
 * 2) Каждый элемент JSON должен соответствовать указанному ниже типу (т. е. объект, массив или примитивный тип); и
 * 3) Для элементов, имеющих список возможных значений (например,  ), значение в объекте JSON должно соответствовать одному из этих значений.

В случае нарушения этих условий сервер не позволит сохранить изменения, и над страницей редактирования появится сообщение об ошибке.

Для элементов с автоматическим значением bug 2700 не позволяет  работать с любым шаблоном, добавленным в, включая теги  и. Блок TemplateData будет сохранен правильно, но полученная вики-разметка не будет правильно проанализирована при использовании шаблона.

Обратите внимание, что Вы не можете использовать  вместо.

Формат
The below is a visualised version of the JSON data as defined on the template page enclosed by   tags. The formal specification is available in the TemplateData repository. Refer to Specification.md for the latest version.

Объект TemplateData
The TemplateData object is a JSON root element enclosed in a  element on the template page.

InterfaceText (string or object)
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

См. также

 * – user interface for selecting and inserting templates' wikitext, based on their TemplateData.
 * GitHub: jeblad/TemplateData – alternate version with some Lua functionality.