Справка:TemplateData
 |
Примечание: Редактируя эту страницу, вы соглашаетесь на передачу своего вклада по лицензии CC0. Подробнее — в проекте Помощь с общественным достоянием. |
|
TemplateData — расширение, которое хранит информацию и параметры, ассоциированные с викитекстовыми шаблонами, и делает всё перечисленное доступным в интерфейсе редактирования, который, в свою очередь, может извлекать и представлять всё то же самое в редакторе шаблонов — всё это помогает пользователям добавлять и редактировать шаблоны на страницах.
С апреля 2019 года функционал TemplateData является частью пользовательского интерфейса по умолчанию для всех пользователей на всех вики-сайтах Викимедиа, когда они добавляют шаблон, даже для незарегистрированных пользователей. И исходный код по умолчанию, и визуальные редакторы внедряют его тем или иным образом, как и многие скрипты, инструменты и гаджеты. Если вы хотите иметь этот функционал в вашей собственной вики, вам нужно установить Расширение:TemplateData.
Добавление TemplateData в шаблон для использования этого расширения включает в себя вставку небольшого, простого блока JSON (объяснение ниже) на страницу документации шаблона. Вы можете сделать это вручную или с помощью редактора TemplateData - графического интерфейса пользователя, доступ к которому можно получить на странице шаблона "Править"/"Править код" в вики-проектах с установленным расширением TemplateData. JSON содержит список параметров шаблона и информацию об этих параметрах и о шаблоне в целом (подробнее см. ниже).
Шаблоны, содержащие TemplateData, будут отображать эту информацию в пользовательском интерфейсе, когда пользователь добавляет шаблон. В некоторых случаях это изменит поведение редактора, когда вы используете его для редактирования или вставки данного шаблона, что значительно упростит пользователям выполнение шагов, необходимых для добавления данного шаблона.
История
TemplateData был первоначально разработан в начале 2013 года с расчетом на VisualEditor, который в то время находился на стадии тестирования MediaWiki. VisualEditor является основным интерфейсом визуального редактирования для википроектов Викимедиа, а TemplateData позволил ему иметь более удобный интерфейс при добавлении шаблонов. Он был официально поддержан VisualEditor immediately. Когда визуальный редактор стал стандартной функциональностью различных главных вики-проектов Викимедиа в 2013–2016 годы, данные шаблонов также стали частью этих проектов.
В декабре 2016 года интерфейс VisualEditor стал доступен для редактирования исходного кода в качестве бета-функции. Она называлась Редактор вики-текста 2017. Это впервые добавило функциональность данных шаблонов при редактировании вики-кода.
В марте 2018 года Сэм Уилсон (Sam Wilson) разработал Расширение:TemplateWizard, расширение графического редактора шаблонов для стандартного редактора кода в проектах Викимедиа, WikiEditor (также известного как редактор вики-текста 2010), созданного для упрощения добавления шаблонов с использованием информации из данных шаблонов. В апреле 2019 года TemplateWizard стал частью стандартного интерфейса редактора кода 2010 во всех вики-проектах Викимедиа. Это сделало данные шаблонов стандартной частью обоих редакторов (визуального и вики-кода) в вики-проектах Викимедиа.
Добавление или редактирование TemplateData
Чтобы добавить или изменить TemplateData, сначала перейдите на страницу шаблона, расположенную по адресу "/Шаблон:Имя шаблона".
Проверка текущего состояния
Перед добавлением или редактированием данных шаблонов проверьте, имеет ли шаблон страницу документации. Затем проверьте, есть ли у шаблона уже данные шаблона и, если они есть, где они находятся — на самой странице шаблона или странице документации.
Подстраницы документации
Существует два главных способа, которыми в проектах Викимедиа редакторы хранят документацию шаблонов и другие данные, которые не должны включаться в сам шаблон, такие как категории шаблона:
- Большинство шаблонов хранят документацию и другие данные, неуместные на странице самого шаблона, на странице документации: «Template:Templatename/doc». На таких страницах шаблон {{Documentation}} включает всё содержимое страницы /doc на страницу шаблона, что делает код самого шаблона намного проще.
- На страницах с подстраницами документации заголовок «
Документация» будет иметь ссылки, такие как [просмотр] [править] [история] и [очистить].
- На страницах с подстраницами документации заголовок «
Некоторые страницы шаблонов сохраняют документацию на самой странице шаблона. You can spot it on these pages by looking for an occurrence of {{Documentation|content= between <noinclude> tags.
Different wikis may present all this differently.
Rarely, main template pages may still contain documentation even when you've checked all of the foregoing;
here, a user will have added a custom /doc page title between "{{Documentation|" and "|content=" and then added content after "|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 template data to the documentation subpage.
Creating the subpage and moving the documentation
To create the documentation subpage, click "Править"/"Править код" on the main template page; look for the <noinclude> tags and their contents (usually at the bottom).
Это должно выглядеть примерно так:
<noinclude>
{{Documentation|content=
== Использование ==
Информация об использовании.
== Пример дополнительного заголовка ==
Пример дополнительного содержимого
[[Категория:Для примера]]
[[Категория:Для примера 2]]
}}
</noinclude>
Вы также можете увидеть, что шаблон уже содержит данные шаблона. В таком случае это должно выглядеть примерно так:
<noinclude>
{{Documentation|content=
...
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "Пример параметра",
"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>
Сохраните страницу шаблона.
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>
Многие вики-проекты имеют шаблон {{Sandbox other}}.
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>
В завершение, опубликуйте страницу.
You can now add and edit the template data on the documentation subpage using the instructions described in #Methods.
Adding and editing template data on the main template page
If you can't create the /doc page, you can add and edit template data 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 template data (the <templatedata> tag followed by an array inside curly brackets: {}).
Alternatively, the TemplateData extension can perform this check for you. Click "Править" or "Править код" on either page. If the template already has template data on either page, you will see a yellow notice at the top of the page saying either:
- Обратите внимание: уже имеется блок данных шаблона на связанной странице «[[Шаблон:Имяшаблона/doc]]».
или
- Обратите внимание: уже имеется блок данных шаблона на связанной странице «[[Шаблон:Имяшаблона]]».
If the template has template data on its documentation subpage
If the template has template data on its documentation subpage, this is the page you should edit.
You can do this by clicking the "[edit]" located after the heading ".svg){kind=icon}
Template documentation" (or similar), or, if you are already on the /doc page, by clicking "Править" or "Править код" at the top.
Follow the guidance at #Methods to add or edit the template data.
If the template has template data on its main page
If the template has template data 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 template data to the documentation subpage
To do this, click "Править"/"Править код" 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": "Пример параметра",
"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 " Template documentation" (or similar).
Type a heading, like "Template data", then beneath it paste the template data.
You can now edit the template data based on the guidance at #Methods.
Editing template data on the main template page
If you do not wish to move the template data to the /doc page, you can edit it on the main template page. See #Methods for how to edit template data.
If the template does not yet have template data but has a doc subpage
If the template does not yet have template data, you should add it to the documentation subpage.
Do this by clicking the "[edit]" located after the heading " Template documentation" (or similar), or, if you are already on the /doc page, by clicking "Править" or "Править код" at the top.
Type a heading, like "Template data", then add it beneath this heading.
The section #Methods explains how to add template data.
Методы
Метод редактора TemplateData
This is a simple way to add or edit template data, recommended for less experienced users.
TemplateData редактор - это графический интерфейс пользователя для добавления и редактирования TemplateData Это часть расширения TemplateData, доступного на любой странице шаблона (или подстранице документации) через нажатие на «Править» или «Править код».
После нажатия на «Править» или «Править код» вы увидите кнопку над полем редактирования и в заголовке странице будет написано «Править данные шаблона».
Нажатие на эту кнопку приведёт вас в Редактор TemplateData. Если страница, на которой вы находитесь, уже содержит расширение TemplateData, то это автоматически появится здесь.
Функциональность в окне выше:
- 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 template data exists, the interface will only offer users the wiki's own language, but users can click "Добавить язык" 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 "Применить", 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 "Настраиваемый", they can enter wikitext under "Нестандартный формат" according to rules outlined here, in order to create a custom layout for the template when the user clicks "Применить".
- The fourth item configures a template's parameters.
If parameters have already been defined in template data, this area displays them in a list. If the template's source code specifies parameters for which no template data exists, you may see a button labeled "Добавить 2 предложенных параметра". The editor extracts these suggestions from the template's source code by looking for {{{parametername}}} or {{{parametername|}}}. Clicking "Добавить 2 предложенных параметра" will add these parameters using their names as defined in the source code. A green notice will also appear at the top, for example, "2 новых параметров импортировано: names of parameters".
- At the bottom of the window you see an "Добавить параметр" 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.
All of these features and their effects are outlined in the section #Within a parameter's name.
- The template data editor will not allow you to change a parameter to a blank "Имя".
- Clicking "Удалить информацию о параметре" will delete the parameter and all its information from the template data. You can't retrieve or undo this in the template data unless you click "X" afterwards. You can undo any changes made after clicking "Применить" by hitting Ctrl+Z.
- Exiting the template data editor after making changes prompts you to confirm that you want to discard your changes.
When finished, click "Применить".
This will automatically insert the template data 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 template data text will also be selected when you click "Применить".
The template data editor creates a "paramOrder" parameter at the bottom of the template data (or updates it if it already exists).
"paramOrder" contains the current template data parameters in the order in which they were displayed by the template data editor.
You can change the "paramOrder" by dragging the parameters up and down in the template data editor using the three horizontal bars on the left.
"paramOrder" and its effects are described here.
After this, click "Сохранить" to save your revision of the page.
Метод «вручную»
Вы также можете добавить или изменить данные шаблона вручную.
TemplateData написано на JSON, но вам не нужно учить JSON, чтобы узнать, как создавать TemplateData.
Template data follows a few very simple rules and accepts only a few dozen possible predefined parameters and values, typically following a "parameter": "value" format.
Добавление данных шаблона вручную
Considerations:
- If you're adding template data 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, template data is typically near the bottom of the documentation page; on the German Wikipedia, it is typically at the top.
- If you're adding template data on a template's main page (not recommended; see #Prior checks), you must make sure to place it inside the
<noinclude>...</noinclude>tags.
Click "Править" or "Править код" on the respective page, then move to the place in the page where you intend to add template data and write a heading: "Template data".
Many wikis have a {{TemplateData header}} template that adds a short notice regarding template data. If your wiki does, add it after the heading.
To start adding template data, 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 #Template data parameters. Most are optional; some are highly recommended.
Parameters can be in any order, but what follows is the order that best conforms to template data documentation and makes the content easiest to use for editors:
<templatedata>
{
"description": "",
"format": "",
"params": {
"parameter1": {
"aliases": ["",""]
"label": "",
"description": "",
"type": ""
}
},
"paramOrder": [
""
]
}
</templatedata>
Make sure the parameters, for example, in the "params" object, remain inside that object; otherwise you will trigger an "Неожиданное свойство «propertyname»." error when you try to save.
Пример
Here is some example template data 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 template data 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": "Месяц и год",
"description": "Месяц и год, в которые шаблон был добавлен",
"type": "string",
"autovalue": "{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}",
"example": "Январь 2013 года",
"suggested": true
},
"reason": {
"aliases": ["1"],
"label": "Причина",
"description": "Причина, по которой статья нуждается в чистке",
"type": "string"
},
"talk": {
"aliases": ["разделобсуждения"],
"label": "Раздел страницы обсуждения",
"description": "The section of the talk page containing relevant discussion",
"type": "string"
}
},
"paramOrder": [
"date",
"reason",
"talk"
]
}
</templatedata>
The corresponding template data documentation would display as follows:
Use this template to indicate that an article is in need of cleanup.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Месяц и год | дата | Месяц и год, в которые шаблон был добавлен
| String | suggested |
| Причина | причина 1 | Причина, по которой статья нуждается в чистке | String | optional |
| Раздел страницы обсуждения | обс. разделобсуждения | The section of the talk page containing relevant discussion | String | optional |
Параметры TemplateData
All available template data parameters are listed below with a description and example. They are also listed in more technical detail at Extension:TemplateData#Format.
- This information is current as of November 2021 and may change if new parameters are added or the template editing interfaces get updates to support existing parameters or treat certain parameters differently.
- Wiki markup will not work in descriptions or labels. They are strictly plain text strings.
- New lines ("
\n") in descriptions, labels, examples or defaults will not show in any of the main editors (TemplateWizard, the visual editor or the 2017 wikitext editor), even though they show in the auto-generated template data documentation. They are replaced by a null string in input forms and by a space elsewhere.
| Параметр | Описание | Пример |
|---|---|---|
| description |
The Effects On the template documentation page, the description will show in plain text below the "Template data for [template name]" subheading. In all main editors (VisualEditor, the Редактор вики-текста 2017 and the Расширение:WikiEditor with TemplateWizard), the description shows in two main instances:
In the visual editor and 2017 wikitext editor, the description gets truncated to about 50 characters under each search suggestion, followed by a "...", but the whole description shows in the main template editor window. Both are shown in grey text. In the main template editor window, descriptions longer than four lines (about 540 characters) are provided a separate scrollbar, and they are shown in black text. If not specified If the description parameter does not exist or is not specified, the text "Нет описания." will be displayed in the template data documentation below the "Template data for [template name]" subheading. Additionally:
|
"description": "Шаблон для ссылки на категорию в Викискладе",
|
| format |
The This parameter is not required, but it is recommended. The default behavior when this parameter is not provided is preserving the existing formatting for existing parameters, or inline formatting for newly added parameters and templates. Effects Inline: ( When inserted, the template will lay its wikitext out on a single line with no white space between elements, like so:
Block: ( When inserted, the template will distribute its parameters each on a new line, with single spaces between each element, like so: {{Foo
| bar = baz
| qux = quux
}}
Custom formatting: Alternatively, if the parameter is set to a custom string of wikitext, as per the rules listed at #Custom formats, the template will lay its wikitext out as per the given wikitext. |
"format": "inline"
|
| params |
The It should contain the name of each parameter followed by a set of template data sub-parameters listed in #Within a parameter's name. Если существует несколько параметров, поместите запятую между каждым объектом параметра, но не добавляйте запятой после последней фигурной скобки (смотрите пример). |
"params": {
"parameter1": {
... // parameter info
}, // запятая здесь
"parameter2": {
... // parameter info
}, // и здесь
"parameter3": {
... // parameter info
} // но не здесь
}
|
| paramOrder |
The Как использовать Add the parameter The parameters need not be on new lines (they may be written as We recommend you place You must include every parameter mentioned in the template data; otherwise a "Обязательное свойство «propertyname» не найдено." error will show. Если не указано Without С другими параметрами In the 2010 wikitext editor with TemplateWizard:
In the visual editor and the 2017 wikitext editor, |
"paramOrder": [
"date",
"reason",
"talk"
]
|
Within params
| Параметр | Описание | Пример |
|---|---|---|
| Имя параметра |
Только элемент первого уровня объекта For example, in a template's source code, You may also see parameters named
Note: a user can still force the use of Как использовать Each of these "Имя параметра" objects should contain all of the information about the parameter, in the form of more template data parameters. These are listed in the following section, Within a parameter's name. |
"1": { // название параметра
... // информация о параметре идёт здесь
}
|
Within a parameter's name
| Параметр | Описание | Пример |
|---|---|---|
| aliases |
The optional
или
This means that if the user inserts either of these parameters with a value, they will perform the same function. Literally, it translates to, "Value of parameter1. If parameter1 doesn't exist or have a value: value of parameter2." In the second case, it also means, "If parameter2 doesn't exist or have a value: no value." To insert the |
"aliases": ["1", "talk", "talksection"],
|
| inherits |
To use this parameter, type |
"params": {
"topic1": {
"label": "Тема",
"description": "Тема, упомянутая на этой странице неоднозначности",
"type": "string"
},
"topic2": {
"inherits": "topic1"
},
"topic3": {
"inherits": "topic1",
"label" : "A different label"
}
}
|
| label |
The |
"label": "Month and year",
|
| description |
Here, |
"description": "The month and year that the template was inserted",
|
| type |
See the #Type parameter section. |
|
| default |
Some template parameters have a default value; the value is used unless overridden by the user.
The Effects In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), the With other parameters In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), if |
"default": "Category:CommonsRoot",
|
| autovalue |
A parameter can be assigned an This value can be overwritten by the user in the template editor. With other parameters In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), |
"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
|
| example |
The Effects In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), this property is displayed below the parameter description (and below the With other parameters In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), |
"example": "January 2013",
|
| required |
The It determines whether filling in the given parameter is mandatory for the template. Effects This status has several effects in the visual editor and the Редактор вики-текста 2017:
In the Расширение:WikiEditor with Extension:TemplateWizard, as in the other editors, it displays the parameter automatically when a user inserts the template, but the parameter cannot be removed using this or any editor. It also does not display "Это обязательное поле." in the parameter description; rather, it lists the parameter on the side under "Обязательные параметры". Other than this, it generally behaves the same as in the other editors, except that the prompt says that the input doesn't "match the expected format". With other parameters In the visual editor and the 2017 wikitext editor, the |
"required": true
|
| suggested |
The Use Effects In the visual editor and the Редактор вики-текста 2017, it causes the parameter to automatically show up when a user inserts a template. If the parameter has an autovalue set, this will also automatically be in the parameter's input box. It has no other effect and doesn't show any additional text or warnings. In the Расширение:WikiEditor with TemplateWizard, it does not place the parameter in the template automatically but instead causes it to be listed on the side under "Предложенные параметры". The user can then click a "+" next to the parameter to add it to the template. With other parameters The |
"suggested": true
|
| deprecated |
Finally, there is Это статус для параметров, которые не должны больше использоваться, но всё ещё существуют в настоящее время. Это может быть потому, что использование шаблона перемещается из одного набора параметров в другой. Effects The effect of this parameter in the visual editor and the 2017 wikitext editor is that a grey exclamation mark shows next to the parameter's label when it is inserted, and in the parameter's information tooltip, the grey, italic text "Устаревшее поле. deprecation reason" is shown below the parameter description. It does not affect the functionality or usability of the parameter or show any additional warnings. Despite the fact that it can take a string, as of January 2020 none of the main editors (the visual editor, the 2017 wikitext editor or the 2010 wikitext editor) display the contents of the string anywhere to users.
Inputting a string has the same effect as In the 2010 wikitext editor with TemplateWizard, setting this value as With other parameters If you set both this and If you set both this and In the 2010 wikitext editor with TemplateWizard, |
"deprecated": "Пожалуйста, вместо этого используйте 'publicationDate'."
|
| suggested values |
The parameter property
Other types (file, page, template, user, date, boolean, URL) are not currently supported because they have special functionalities in the visual editor already, such as autocomplete, which would interfere with the drop-down menu for suggested values in the visual editor. Editing template data 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 template data with the template data editor
Effects Once the values have been added to template data, the visual editor 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": [
"Журнал",
"Книга",
"Газета",
"Журнал"
]
|
Note: if neither "required", "suggested" nor "deprecated" are set as true for a parameter, its status will show as "optional" in the template data documentation.
Как только вы закончите, нажмите «Сохранить». Если вы допустили ошибки, система не позволит вам сохранить изменения (это неприятно, но это значит, что вы ничего не сможете сломать). Если вы столкнётесь с ошибками, распишите на странице обратной связи, что вы пытались сделать, и мы будем рады помочь.
Обратите внимание, что если вы используете шаблон взлома для динамической генерации TemplateData, это нельзя проверить на наличие ошибок перед сохранением.
Обратите внимание, что каждый элемент информации заключен в кавычки (кроме true и false) и отделен от следующего элемента запятой (если он не последний).
Type parameter
The "type" parameter is meant to signal to a template editor the nature of a parameter's value.
In some cases, template editors have been programmed to modify the user interface for a certain parameter according to this template data value, such as to only allow the user to enter valid values that match the specified type.
This parameter does not have any functional effect on the template parameter or its value; it merely controls how template editors see and treat the parameter in editing mode.
Как использовать
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.
Пример:
"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.
The currently known effects are listed as follows.
| Значение | Описание | |
|---|---|---|
| unknown |
The Effects In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| string |
The Effects In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| line |
The Effects
| |
| content |
The Effects
| |
| unbalanced-wikitext |
The Effects
| |
| wiki-page-name |
The Effects In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| wiki-file-name |
The Effects
It has no other visible effect and doesn't prevent a non-file from being inputted. | |
| wiki-template-name |
The Effects In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| wiki-user-name |
The Effects In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| number |
The Effects
С другими параметрами
| |
| boolean |
The Effects As of February 2020, none of the main Wikimedia editors (the visual editor, the 2017 wikitext editor or the 2010 wikitext editor with TemplateWizard) make use of this value. It has no visible effects. With the | |
| date |
The Effects
С другими параметрами
| |
| url |
The Effects
required" setting, but it does not warn the user if they attempt to insert the template without a valid URL. It also occurs with any status setting (such as "suggested"" or "deprecated").
С другими параметрами
| |
Пользовательские форматы
When editing the "format" value, you create custom formats by inputting a set of wikitext symbols using some predefined rules.
{{- start of the template_- content (e.g., string, integer or parameter). This underscore serves to indicate the minimum length of a value in characters and can be repeated, like_______. If this length is not reached, it fills the remaining characters with spaces. This can be used to align all equals signs to a specific position after a parameter (if used with\nfor new lines).|- pipe (separates parameters)=- equals sign (precedes the value of a parameter)\nor pressing the enter key - new line (this will display as↵in the entry field)\nto indent new lines)}}- end of the template
The wikitext should at least meet the minimum of {{_|_=_}}, otherwise there will be an invalid format string error.
| Задача | Строка формата | Результат |
|---|---|---|
| Встроенное форматирование | {{_|_=_}} inline
|
{{Foo|bar=baz|qux=quux}}{{Bar}}
|
| Блок форматирования | {{_\n| _ = _\n}} block
|
{{Foo
| bar = baz
| qux = quux
}}{{Bar}}
|
| Нет пробела перед именем параметра,
каждый шаблон в отдельной строке |
\n{{_\n|_ = _\n}}\n
|
{{Foo
|bar = baz
|qux = quux
}}
{{Bar}}
|
| Отступ каждый параметра | {{_\n |_ = _\n}}
|
{{Foo
|bar = baz
|qux = quux
}}{{Bar}}
|
| Выровнять все имена параметров по заданной длине | {{_\n|_______________ = _\n}}\n |
{{Foo
|bar = baz
|qux = quux
|veryverylongparameter = bat
}}
{{Bar}}
|
| Символы в конце предыдущей строки | {{_|\n _______________ = _}}
|
{{Foo|
bar = baz|
qux = quux}}{{Bar}}
|
| Встроенный стиль с большим количеством пробелов, должен быть в начале строки | \n{{_ | _ = _}}
|
{{Foo | bar = baz | qux = quux}}
{{Bar }}
|
| Шаблон в начале строки, параметры с выравниванием по отступу, труба заранее | \n{{_ |\n _______________ = _}}
|
{{Foo |
bar = baz |
qux = quux}}
{{Bar}}
|
Пустой шаблон
Вы можете скопировать пустой шаблон ниже, чтобы добавить новые TemplateData в шаблон. Только самые распространенные теги включены.
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "",
"description": "",
"type": ""
},
"2": {
"label": "",
"description": "",
"type": ""
}
}
}
</templatedata>
Ошибки
Синтаксическая ошибка в JSON. / Плохой формат JSON
Эти ошибки возникают при сохранении TemplateData, обычно редактируемого вручную, с недопустимым кодом JSON (повторяющиеся ключи/параметры, завершающие или отсутствующие запятые и т. д.) в VisualEditor или редакторе викитекста 2017 года.
"Синтаксическая ошибка в JSON." появляется в VisualEditor и редакторе викитекста 2017; "Неверный формат JSON" появляется при редактировании в графическом редакторе TemplateData.
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 template data 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 (задача T128029). Pages that contain invalid JSON may throw alarming "Внутренняя ошибка" messages. To fix these errors, your best bet is to use a JSON validator (see above).
Обязательное свойство «paramOrder[number]» не найдено.
This error occurs if you state a parameter in "params" that is not stated in "paramOrder".
The number in the square brackets refers to the parameter in "paramOrder" that is missing. It refers to its order in the sequence, but it is one less than its actual position, since "paramOrder" is an array; 0 is the first one, 1 is the second, etc.
"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.
To fix this, make sure all parameters stated in "params" are listed in "paramOrder".
Alternatively, you can remove the "paramOrder" object to remove this error.
Недопустимое значение для свойства «paramOrder[number]».
This error occurs if you state a parameter in "paramOrder" that is not stated in "params".
The number in the square brackets refers to the parameter in "paramOrder" that shouldn't be there. It refers to its order in the sequence, but it is one less than its actual position, since "paramOrder" is an array; 0 is the first one, 1 is the second, etc.
"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]".
To fix this, make sure all parameters stated in "paramOrder" are listed in "params".
Alternatively, you can remove the "paramOrder" object to remove this error.
Для свойства «params.parametername.required» ожидается тип «boolean».
"suggested": "true" // <-- These quotation marks shouldn't be here.
These are boolean values, not strings, therefore they require no quotation marks.
To fix this, remove any quotation marks around the values true or false for these parameters.
Property "format" is expected to be ...
If the "format" parameter exists but its value is not "inline", "block" or a valid format string, you will see the error message "Предполагается, что значением свойства "format" должно быть "inline", "block" или строка корректного формата.".
"format": "notinline"
// Error : Property "format" is expected to be "inline", "block", or a valid format string.
To fix this, make sure the value after "format": equals "inline" or "block" and that there no spelling mistakes. Alternatively, if it's wikitext, make sure it contains a minimum of {{_|_=_}} and that there are no mistakes in the syntax that would normally cause a template to fail, such as duplicate equals signs or missing/duplicate curly brackets; see the section #Custom formats for the syntax for custom formats.
Alternatively, you can remove the "format" parameter to remove this error.
Неожиданное свойство «parametername».
This error occurs if you state a parameter that does not exist in template data. This is probably due to spelling mistakes.
<templatedata>
{
"description": "",
"format": "inline",
"params": {
"1": {
"label": "",
"descriptino": "", // <-- spelling mistake
"type": ""
}
}
}
</templatedata>
It also occurs if you state a parameter in any template data object that is not a parameter of that object. This may be due to spelling mistakes, or you may have written the parameter of one template data object under another object that it doesn't belong to.
For example, you might have written the parameter "label" under the root template data object instead of inside "params":
<templatedata>
{
"description": "",
"format": "inline",
"label": "", // <-- incorrectly placed parameter
"params": {
"1": { // ↓ it should be in here
"description": "",
"type": ""
}
}
}
</templatedata>
Alternatively, if the unexpected parameter is under a template parameter inside "params", you'll see its name after "params.parametername." in the error.
To fix this, make sure there aren't any spelling mistakes in the parameter names, and make sure your parameters are in their correct location. Additionally, make sure you don't state any parameters that don't exist for a template data object. You can check which parameters exist for an object in the section #Template data parameters.
Обязательное свойство «params» не найдено.
This error occurs if there is no "params" object in the template data.
This is a necessary object, as it contains all the details of each parameter, so to fix this error, make sure it's added and that there are no spelling mistakes.
See the section above on how to add the "params" parameter.
Ограничения и обратная связь
- Недостающие функции – TemplateData - пример инструмента, который был доступен с небольшим количеством функций, в надежде, что пользователи помогут направить разработку функций, которые они желают. Если вы хотите запросить новые функции для TemplateData, пожалуйста, сообщите нам об этом.
- Задержки в показе в шаблонах – После добавления TemplateData в шаблон метаданные должны быть видны сразу после открытия шаблона в визуальном редакторе. Однако возможно, что метаданные будут показаны через несколько часов. Вы можете принудительно обновить обновление, выполнив нулевое редактирование самой страницы шаблона (не подстраницы документации). Чтобы выполнить нулевое редактирование, откройте страницу шаблона для редактирования и сохраните страницу «без внесения каких-либо изменений и без добавления сводки по редактированию».
- Существующие проблемы – Список текущих ошибок и запросов функций доступен в трекере ошибок Викимедиа.
Другие инструменты
- Help:Extension:TemplateWizard
- Диалоговое окно панели инструментов для ввода шаблона вики-текста через форму, созданную из TemplateData.
- TemplateData Wizard
- Инструмент, который генерирует TemplateData через интерактивный интерфейс.
- Skeleton TemplateData generator
- Инструмент, который читает исходный вики-код шаблона, пытается найти все используемые параметры и выводит скелетный документ с перечисленными параметрами.
- JSONLint
- Инструмент, который позволяет вам проверять написанный вручную JSON, чтобы помочь найти ошибки в синтаксисе.
- Список всех шаблонов с TemplateData в этой вики
- При dewiki данные шаблона TemplateData шаблона отображаются в поле, а шаблон добавляется в категорию шаблонов с данными шаблона.
- https://query.wikidata.org/ и Помощник с запросами Query