 Статус релиза: стабильно | |
|---|---|
 | |
| Реализация | Тег,API |
| Описание | Позволяет хранить, получать и визуализировать информацию о шаблонах |
| Автор(ы) | Timo Tijhof,Moriel Schottlender,James Forrester,Trevor Parscal,Bartosz Dziewoński, Marielle Volz, ... |
| Последняя версия | 0.2.0 (Постоянные обновления) |
| Политика совместимости | Снэпшоты выходят вместе с MediaWiki. Мастер не имеет обратной совместимости. |
| PHP | 5.4+ |
| Изменения в БД | Нет |
| Лицензия | GNU General Public License 2.0 или позднее |
| Скачать | |
| |
<templatedata> | |
| Переведите расширение TemplateData, если оно доступно на translatewiki.net | |
| Проблемы | Открытые задачи ·Сообщить об ошибке |
РасширениеTemplateData вводит тег<templatedata> и API, которые вместе позволяют редакторам указывать, как следует использовать шаблоны и их параметры.Эта информация доступна в виде красиво отформатированной таблицы для конечных пользователей и в виде API в формате JSON, который позволяет другим системам (например,VisualEditor) создавать интерфейсы для работы с шаблонами.СмотритеHelp:TemplateData для детальной информации.
TemplateData в вашей папкеextensions/.cdextensions/gitclonehttps://gerrit.wikimedia.org/r/mediawiki/extensions/TemplateDatawfLoadExtension('TemplateData');
Готово – Перейдите на страницуSpecial:Version на своей вики, чтобы удостовериться в том, что расширение успешно установлено.Расширение TemplateData работает при помощи тэга<templatedata>, определенного в вики-разметке на странице шаблона (по желанию он также может быть включен из другой страницы).Оно было разработано, чтобы быть совместимым с общим макетом, который есть во многих вики, включая документацию шаблона с отдельной страницы (но не обязательно).Содержимое тега<templatedata> должно быть валидным JSON, использующим описанный ниже формат; обратите внимание, чтовсе описания должны быть простым текстом (в данных шаблонах не должно присутствовать вики-разметки).
Когда<templatedata> помещён на страницу, расширение TemplateData выполняет следующие проверки при сохранении:
type), значение в объекте JSON должно соответствовать одному из этих значений.В случае нарушения этих условий сервер не позволит сохранить изменения, и над страницей редактирования появится сообщение об ошибке.
Для элементов савтоматическим значениемT4700 предотвращает работуsubst: в любом шаблоне, добавленном внутри тега, включая теги<ref> и<gallery>.Блок TemplateData будет сохранен правильно, но полученная вики-разметка не будет правильно проанализирована при использовании шаблона.
Пожалуйста, избегайте использования{{#tag:templatedata}}, поскольку это делает невозможным использованиередактора данных шаблона.
Ниже представлена визуализированная версия данных JSON, как определена на странице шаблона, сопровождаемой тегами<templatedata></templatedata>.Формальная спецификация доступна в репозитории TemplateData.См.Specification.md для последней версии.
Объект TemplateData представляет собой «корневой элемент JSON», заключённый в элемент<templatedata> на странице шаблона.
| Ключ | Тип | Описание |
|---|---|---|
description | InterfaceText илиnull | Краткое описание шаблона.Это должно быть в виде обычного текста После заполнения, он может отображаться в качестве надписи при редактировании одного шаблона и, возможно, в результатах поиска, когда пользователи выбирают один из многих других вариантов. По умолчаниюnull.→ For more details see:description |
params | Объект, содержащийпараметры объекта | Объект, который сопоставляет каждое имя параметра шаблона с соответствующимпараметром объекта, описывающим свойства этого параметра. → For more details see:params |
paramOrder | Массив, содержащий строки имен параметров | Логический порядок, в котором параметры должны отображаться. Массив содержит каждый параметрный ключ точно один раз. Каждая строка должна быть действительным ключом в объектеparams.→ For more details see:paramOrder |
sets | Array containing Set objects | An array containing set specifications.A set is a group of parameters that should be used together. Значение по умолчанию: []. Заметьте, что функциональностьsets всё ещё в разработке. |
format | строка,inline либоblock | How the template's wikitext representation SHOULD be laid out. Значение по умолчанию:inline.See#Custom_formats for other custom formats. |
maps | Object containingMap objects | An object that links a simplified name of a third party consumer of the template data (i.e.Citoid,Special:MyLanguage/Wikidata, etc.) to a map object that in turn links a name of a consumer parameter to one or more corresponding names of template parameters. |
| Ключ | Тип | По умолчанию | Описание | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
label | InterfaceText | null | (Очень) короткое имя параметра. Старайтесь не превышать длину в более чем 20 символов. → For more details see:label | ||||||||||||||||||||||||||||
description | InterfaceText | null | Короткое описание параметра, чтобы пользователи знали, что выбирать из списка. → For more details see:description | ||||||||||||||||||||||||||||
required | булево значение | false | Обозначает, необходим ли параметр для работы шаблона (true, если параметрдолжен быть указан). → For more details see:required | ||||||||||||||||||||||||||||
suggested | булево значение | false | Whether the parameter is suggested for the template to be useful (true if this parametershould be specified). → For more details see:suggested | ||||||||||||||||||||||||||||
deprecated | булево значение либо строка | false | Whether the parameter is deprecated.The value can be a string of instructions giving the user guidance what instead can be done, or be simplytrue.→ For more details see:deprecated | ||||||||||||||||||||||||||||
aliases | Массив из строк | [] | Список псевдонимов. Псевдоним — это альтернативное имя для параметра, которое может быть использовано вместо (не в дополнение) основного.Aliases are not documented in a separate Parameter object.If they need more information, they should be in their own property marked "deprecated". → For more details see:aliases | ||||||||||||||||||||||||||||
default | InterfaceText | null | A fixed default value used by the template if no value is assigned to the parameter, or a description thereof. → For more details see:default | ||||||||||||||||||||||||||||
autovalue | строка | null | A dynamically-generated default value in wikitext, such as today's date or the editing user's name; this will often involve wikitext substitution, such as{{subst:CURRENTYEAR}}.→ For more details see:autovalue | ||||||||||||||||||||||||||||
example | InterfaceText | null | An example text for the parameter, to help users fill in the proper value. → For more details see:example | ||||||||||||||||||||||||||||
type | строка | "unknown" | The type of the parameter, for (soft) type hinting. One of:
→ For more details see:type | ||||||||||||||||||||||||||||
inherits | строка | нет substituted | The name key of another parameter (must be a valid key in theparams object).The currentParameter Object will inherit properties from the specifiedParameter Object, with local properties overriding the inherited ones.→ For more details see:inherits | ||||||||||||||||||||||||||||
suggestedvalues | Array containing strings | [] | An optional parameter property.Creates a list of parameter values to help users select the desired value.For the suggested values to be displayed as a combo box in VisualEditor, the parameter’s type must be set to one of the following: content, line, string, number, unknown or unbalanced wikitext. → For more details see:suggestedvalues |
Key | Object or primitive type | Description |
|---|---|---|
label | InterfaceText | A (very) brief name for the parameter set.Try to keep under 20-ish characters. |
params | Array of strings | One or more names of parameters to include in the set (each must be a valid key in theparams object).A parameter may be in multiple sets.Not every parameter must be in a set. |
Maps is a single data structure that goes multiple levels deep.It became common to call the second level a“map object”.
| Key | Type | Default | Description |
|---|---|---|---|
| name of consumer | object | {} | An object that links aname of a consumer to amap object that in turn links aname of a consumer parameter to one or more correspondingnames of template parameters. Thenames of the template parameters can be specified either as a string (one name), an array of strings (several names), or an array of arrays of strings (several sets of names); each of these strings must be a valid key in the A specific template parameter may be in multiple maps, and it may be used in the values of multiple keys in a given map, but not every template parametermust be in a map. A shortened example from English Wikipedia'sTemplate:Cite_news#TemplateData illustrates the structure of map objects. {"proveit": {"main": "title","textarea": ["quote"]},"citoid": {"title": "title","url": "url","publisher": "publisher","publicationTitle": "work","date": "date","ISSN": ["issn"],"ISBN": ["isbn"],"contributor": "others","author": [["first","last"],["first2","last2"],["first9","last9"]],"editor": [["editor-first","editor-last"]]}} |
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 isnull.
If it is a string, it must contain a non-localized string in the content language of the local wiki.
If it is an object, the object must have this mapping:
| Key | Type | Description |
|---|---|---|
| Wikipedia language code | string | Localized string for users of that interface language. |
Example of object mapping:
| Key | Value |
|---|---|
| "en" | "Welcome to Wikipedia" |
| "de" | "Willkommen bei Wikipedia" |
| "fr" | "Bienvenue sur Wikipédia" |
| "nl" | "Welkom op Wikipedia" |
| "it" | "Benvenuti su Wikipedia" |
| "es" | "Bienvenidos a Wikipedia" |
| "ru" | "Добро пожаловать в Википедию" |
An example TemplateData structure as specified within wikitext on a template page.
<templatedata>{"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":"{{subst:#time:Y-m-d}}"},"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"]}}}</templatedata>
Below is how the above example would be displayed on the template page:
Label unsigned comments in a conversation.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| User's name | user1 | User name of person who forgot to sign their comment. | User | required |
| Date | date2 | Timestamp of when the comment was posted, in YYYY-MM-DD format.
| Unknown | suggested |
| Year | year | no description | Number | optional |
| Month | month | no description | Number | optional |
| Day | day | no description | Number | optional |
| comment | comment | no description | Unknown | optional |
See the generated help atSpecial:ApiHelp/templatedata.A sample invocation (formatted for human readability) is:
This returns the template data forTemplate:Cite web.The<templatedata>...</templatedata> block for this template is on its transcluded template documentation page,en:Template:Cite web/doc.
The JSON structure provided in response to an API HTTP get request is significantly different than that which is defined in the<templatedata>...</templatedata> block.In response to the API request, extension TemplateData makes the following changes to the JSON object:
title key with the name of the page from which the data was requested (e.g. "Template:Cite web").sets keyinherits keys.
| ||||||
|
| Key | Type | Description |
|---|---|---|
title | string | The page name of the template (e.g. "Template:Cite web"). This key isnot contained in the JSON structure on the template page.It is added to the structure by the MediaWiki software in route to delivery via the API. |
sets | Array containingSet Objects | An array containing set specifications.A set is a group of parameters that should be used together. If this does not exist on the template page it is added as an empty array to the structure provided by the API. |
| Key | Type | Description |
|---|---|---|
label | InterfaceText | translated toInterfaceText object, if not already in that format. |
required | boolean | If not defined, default value offalse added. |
description | InterfaceTextornull | If defined as a string, converted to aInterfaceText object.If not defined, key is added with anull value. |
deprecated | boolean or string | If not defined, default value offalse added. |
aliases | Array of strings | If not defined, a default empty array is assigned (i.e. [] ). |
default | string | If not defined, default of "" is assigned. |
type | string | If not defined, default of "unknown" is assigned. |
inherits | (удалено) | This key is removed and all inherited keys are added.Keys defined for the current parameter take precedence and any keys not defined on either the current param, or the one from which it inherits are given the default value. |
| Key | Object or primitive type | Description |
|---|---|---|
| Object (containing localized strings byWikipedia language code) If a TemplateData field on the template page contains a string, not an object with localized strings, MediaWiki translates it into an InterfaceText Object with a string assigned to the key name of the source WikipediaWikipedia language code.The default for all InterfaceText fields is null. | ||
| (Wiki language code) | string | Localized string for users of that interface language. |
The response to an API request for the TemplateData structure in theExample section (above) can be seen:
| Переменная | По умолчанию | Описание |
|---|---|---|
$wgTemplateDataUseGUI | true | Экспериментальный диалоговый интерфейс для TemplateData JSON |
$wgTemplateDataEditorNamespaces | [ 10 ] | The namespaces in which the template data editor appears when creating or editing a page. (T189989) |
$wgTemplateDataMaxFavorites | 50 | The maximum number of favorite templates that can be stored. (T377460) |
 | Это расширение используется в одном или несколькихпроектах Викимедиа. Вероятно, это означает, что расширение стабильно и работает достаточно хорошо, чтобы использоваться такими сайтами с высоким трафиком. Найдите название этого расширения в файлах конфигурации ВикимедиаCommonSettings.php иInitialiseSettings.php, чтобы узнать, где оно установлено. Полный список расширений, установленных на конкретной вики, можно увидеть на страницеSpecial:Version wiki. |
 | Это расширение включено в следующие вики-фермы/хостинги и/или пакеты:Это не исчерпывающий список. Некоторые вики-фермы/хостинги и/или пакеты могут содержать это расширение, даже если они не перечислены здесь. Всегда сверяйтесь со своими вики-фермами/хостингами или комплектами/бандлами для подтверждения. |