Справка:TemplateData

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Help:TemplateData and the translation is 22% complete.
Outdated translations are marked like this.
Other languages:
Bahasa Indonesia • ‎Cymraeg • ‎Deutsch • ‎English • ‎Esperanto • ‎Ilokano • ‎Lëtzebuergesch • ‎Nederlands • ‎Oromoo • ‎Scots • ‎Tiếng Việt • ‎Türkçe • ‎Zazaki • ‎asturianu • ‎azərbaycanca • ‎català • ‎dansk • ‎emiliàn e rumagnòl • ‎español • ‎euskara • ‎français • ‎føroyskt • ‎galego • ‎hrvatski • ‎italiano • ‎lietuvių • ‎magyar • ‎occitan • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎slovenčina • ‎slovenščina • ‎suomi • ‎svenska • ‎čeština • ‎Ελληνικά • ‎български • ‎македонски • ‎русский • ‎српски / srpski • ‎українська • ‎հայերեն • ‎ייִדיש • ‎עברית • ‎العربية • ‎تۆرکجه • ‎سنڌي • ‎فارسی • ‎پښتو • ‎अङ्गिका • ‎अवधी • ‎मराठी • ‎हिन्दी • ‎বাংলা • ‎ไทย • ‎ქართული • ‎中文 • ‎日本語 • ‎ꯃꯤꯇꯩ ꯂꯣꯟ • ‎한국어
PD Внимание: Когда вы редактируете эту страницу, вы соглашаетесь на передачу своего вклада по лицензии CC0. Узнать об этом подробнее можно на странице справки.
PD

TemplateData — способ хранения информации о wikitext template и его параметрах, чтобы визуальный редактор мог получить и отобразить его в своём редакторе шаблонов, упрощая, таким образом, редактировать страницы с помощью этого шаблона. Это также используется в других местах в скриптах, инструментах и гаджетах.

Since April 2019, TemplateData is part of the default user experience for all users on all Wikimedia wikis when they add a template, including unregistered users. Both the default source and visual editors incorporate it in some way. It is also used elsewhere in scripts, tools and gadgets. Если у вас есть собственная вики, вам нужно будет установить Extension:TemplateData.

Adding TemplateData to a template essentially consists of inserting a small block of JSON code (explained below) on the template's documentation page. There are two main ways you can do this, either manually or by using the TemplateData editor, a graphical user interface located on the "Edit"/"Edit source" pages of templates on wikis with the TemplateData extension installed. The JSON contains a list of parameters with info about each parameter of the template as well as the template as a whole. These are outlined below.

Once a template has TemplateData, this information will show in the user interface when a user adds the template, sometimes in place of original info or sometimes as additional info. In some cases, it may change how the editor behaves when editing or inserting the template. This can make it much easier for users to identify what they need to do with the template when adding it.

History

TemplateData was originally developed in early 2013 with VisualEditor in mind, which was in MediaWiki testing stages at the time. VisualEditor is the main visual editing interface for Wikimedia wikis, and TemplateData allowed it to have a more useful interface when adding templates. It was officially supported by VisualEditor immediately. As VisualEditor was rolled out to the various major Wikimedia wikis as a default feature from 2013 through 2016, TemplateData became a part of them as well.

In March 2018, Sam Wilson developed TemplateWizard , a GUI template editor extension for the default Wikimedia source editor, WikiEditor (otherwise known as the 2010 wikitext editor), designed to make the process of adding templates easier by using information from TemplateData. In April 2019, TemplateWizard was made a default part of the 2010 wikitext editor on all Wikimedia wikis. This meant that TemplateData was now a default part of both the visual editor and the source editor on Wikimedia wikis.

Редактор TemplateData

Существует встроенный инструмент для редактирования TemplateData более простым способом.

Чтобы использовать редактор TemplateData, перейдите на страницу шаблона (или его подстраницу документации) и нажмите кнопку «Редактировать». Это даст вам кнопку «Управление TemplateData» прямо над открытым окном редактирования:

Manage template documentation button for TemplateData 2014.png

Нажмите эту кнопку, чтобы войти в графический инструмент для редактирования TemplateData.

Снимок экрана инструмента редактирования TemplateData

Редактор позволяет добавлять параметры шаблона и устанавливать наиболее распространенные атрибуты. Если отредактированная страница уже содержит блок TemplateData, то уже документированная информация будет автоматически отображаться при открытии правильной страницы в редакторе TemplateData. В первом поле вы можете добавить или обновить краткое описание шаблона в виде обычного текста. После этого, вы можете использовать «Добавить предложенный параметр(ы)» и кнопки «Добавить параметр» документировать имена и атрибуты параметров, занимаемый шаблона.

Вы можете перечислить имя параметра, любые псевдонимы для него, метку и описание, которое будет отображаться для пользователей. Вы также можете привести пример использования параметра. Единственное обязательное поле - это, Имя, (первое поле в каждой строке), где вы записываете точное, чувствительное к регистру имя параметра. В раскрывающемся меню «Тип», можно выбрать тип содержимого, которое должен получать параметр, например строку (для простых текстовых ответов), страницу (для ссылок на другие страницы) или даты. Если шаблон выдаст ошибку, если этот параметр оставить пустым, отметьте его как «Обязательный». Если параметр обычно используется или рекомендуется, пометьте его как «Предлагаемый». С помощью кнопки «Удалить информацию о параметре», удаляется запись параметра из TemplateData.

Снимок экрана редактора TemplateData, показывающий добавляемый второй параметр

Когда вы закончите документировать каждый из параметров, нажмите «Применить», чтобы вставить предварительно отформатированные TemplateData в открытое поле редактирования. Вы все равно должны сохранить страницу, используя обычную кнопку «Сохранить» под окном редактирования.

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

Происхождение TemplateData

TemplateData должен быть на странице, которую он описывает, или быть включен в нее. В шаблоне, это обычно должен быть заключен в теги <noinclude> . При обычном отображении страницы отображается автоматически сгенерированная документация, как показано в #Пример.

Структура TemplateData

Структура TemplateData основана на стандарте JSON. Обратите внимание, что все описания в TemplateData должны быть в простом текста, нет вики-текста, никаких ссылок, «и т.д.».

The first thing to do is to type out a pair of <templatedata> tags, anywhere on the template's documentation subpage, like so:

<templatedata>
{
    ...       // Содержимое TemplateData отправляется сюда
}
</templatedata>

Это сообщает программному обеспечению, что все между двумя тегами в данных шаблона, и должно использоваться при использовании шаблона.

Пример

Описания внутри TemplateData следуют стандартной компоновке; допустим, у вас есть шаблон «Commons» для ссылки на категорию Commons по теме. Требуется один обязательный параметр: название категории на Commons. TemplateData будет выглядеть примерно так:

<templatedata>
{
    "description": "Шаблон для ссылки на категорию Commons статьи",
    "params": {
        "1": {
            "label": "Категория Commons",
            "description": "Категория Commons достояния, на которую вы хотите сослаться.",
            "default": "Category:CommonsRoot",
            "type": "string",
            "required": true
        }
    }
}
</templatedata>

Это будет отображаться в шаблоне примерно так:

Шаблон для ссылки на категорию Commons статьи

Template parameters

ParameterDescriptionTypeStatus
Категория Commons1

Категория Commons достояния, на которую вы хотите сослаться.

Default
Category:CommonsRoot
Stringrequired

Описание и параметры

Each parameter for TemplateData is listed below with a description and example. They are also listed at Extension:TemplateData#Format.

The order of the parameters does not affect functionality, as long as those within, for example, the "params" object are kept within the object.

This information is current as of February 2020 and may change if new parameters are added or the template editing interfaces get updates to treat certain parameters differently or fix certain behaviours.
Parameter Description Example
description

The "description" parameter describes what the template does. It is optional but highly recommended.

Wiki markup will not work in the description. It is strictly a plain text string.

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 2010 wikitext editor with TemplateWizard), the description shows in two main instances:

  • below the template name in each search suggestion when the user is searching for a template
  • below the template name in the template editor, while they are adding values to parameters in the template.

In the VisualEditor and 2017 wikitext editor, approximately 50 characters of the description show 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 2010 wikitext editor with TemplateWizard, the whole description shows under each search suggestion, 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 "No description." will be displayed in the TemplateData documentation below the "Template data for [template name]" subheading. Additionally:

  • in VisualEditor and the 2017 wikitext editor, it will behave the same as a template that does not have TemplateData; instead of a description, the following text will display:
"The "Template:Cleanup/sandbox" template doesn't yet have a description, but there might be some information on the template's page."
  • in the 2010 wikitext editor with TemplateWizard, the following text will display where the description would be (though not in search suggestions):
"No description exists for this template."
This is different to the two standard placeholder descriptions when TemplateData doesn't exist:
  • "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": "Шаблон для ссылки на категорию Commons",
format

The "format" parameter describes how the template's wikitext should be laid out. This can be set to the standard formats of "inline" and "block", or the user can input a set of wikitext symbols to create a custom format; these symbols and some examples are listed in the section #Custom formats.

This parameter is not required, but it is recommended. The default behaviour when this parameter does not exist is inline formatting, and no corresponding notice is displayed in the TemplateData documentation below the table heading.

Effects

Inline:

If the parameter is set to "inline", the template will display a corresponding notice about the preference in its TemplateData documentation, below the table heading, "Template parameters":

"[circles and pipes icon] This template prefers inline formatting of parameters."

When inserted, the template will lay its wikitext out on a single line with no white space between elements, like so:

{{Foo|bar=baz|qux=quux}}

Block:

If the parameter is set to "block", the template will display the following preference notice in its TemplateData documentation:

"[stacked blocks and pipes icon] This template prefers block formatting of parameters."

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 display the following preference notice in its TemplateData documentation:

"[cogwheel icon] This template has custom formatting."

When inserted, the template will lay its wikitext out as per the given wikitext.

"format": "inline"
params

The "params" object contains the information for each parameter of the template. It is required, and its parameters can be viewed in the #Within params section.

It should contain the name of each parameter followed by a set of TemplateData sub-parameters listed in #Within the parameter's name.

Если у вас есть несколько параметров, просто повторите каждый раздел (начиная с тега «1») и заполните его по своему усмотрению. Обратите внимание, что если шаблон имеет несколько параметров, вам нужно разделить их запятой в шаблоне, например так:

"params": {
    "parameter1": {
        ...    //  parameter info
    },      // обратите внимание на запятую здесь
    "parameter2": {
        ...    //  parameter info
    },      // и здесь
    "parameter3": {
        ...    //  parameter info
    }       //  but not here
}
paramOrder

The "paramOrder" object in an optional object that can force the parameters of a template to show in a specific order when added in the template editor.

It is used by adding the parameter "paramOrder", followed by a colon and space, then including the name of each of the template's parameters in speech marks in a desired order, separated by commas, between two square brackets (an array). The parameters do not have to be on new lines (they can be "paramOrder": ["param1","param2","param3"]), but placing them on new lines may aid in legibility. Every parameter mentioned in the TemplateData must be included, or an error will show.

Effects

In VisualEditor and the 2017 wikitext editor, paramOrder forces its order regardless of the status of each parameter.

In the 2010 wikitext editor with TemplateWizard, "required" parameters will always appear at the top, while "suggested" parameters will always appear second, above "optional" ones ("deprecated" parameters won't appear at all; see the description of "deprecated" for more info). paramOrder will only enforce its order within these categories (i.e., all "required" parameters will be in the order specified by "paramOrder", and all "suggested" parameters will be too, but all "suggested" parameters will appear below all "required" parameters).

"paramOrder": [
	"date",
	"reason",
	"talk"
]

Within params

Parameter Description Example
parameter name

В подразделе каждого параметраm первый тег находится внутри имени параметра шаблона «внутри шаблона».

For example, in a template's source code, if you see {{{date}}}, this is a parameter, and this should be added under "params" with the name "date".

You may also see parameters named {{{1}}} or another number (whose TemplateData name should be, for example, "1"). These parameters behave in such a way that, when a user inserts a template, they can omit their name and the equals sign (i.e., |value| instead of |parametername=value|). Their number indicates which empty parameter they are when multiple empty parameters are used. For example, expect that in

{{example template|value1|value2}}

value1 is the value of parameter {{{1}}}, and value2 is the value of parameter {{{2}}}. Make sure to describe your TemplateData parameters accordingly. Note: a user can still force the use of {{{2}}} without {{{1}}} by simply inserting a parameter named "2" in the template editor or typing "|2=" in wikitext.

Each of these "parameter name" objects should contain all of the information about the parameter, in the form of more parameters. These are listed in the following section, Within the parameter's name.

"1": {     // название параметра
    ...    // информация о параметре идёт здесь
}

Within the parameter's name

Parameter Description Example
aliases

The "aliases" parameter is a optional item for when a template parameter has multiple names. You can check this by going into the template's source code and looking for:

{{{parameter1|{{{parameter2}}}}}}, or {{{parameter1|{{{parameter2|}}}}}}

This literally 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." This means that if the user inserts either of these parameters with a value, they will perform the same function.

To insert the "aliases" parameter, add the text "aliases" followed by a colon and space, then include the name of each of the parameter's aliases in speech marks, separated by commas, between two square brackets (an array).

"aliases": ["1", "talk", "talksection"]
inherits

"inherits" is an optional parameter for when a parameter should inherit all of the TemplateData of another parameter. This can then be overridden by any parameters specified for the inheriting parameter.

To use this parameter, type "inherits" : followed by another template parameter's name, such as "talk" or "1". You can then type another specific setting for the parameter underneath if you wish, like "label" : "A different label". The first parameter will inherit all of the second parameter's properties except this one.

    "params": {
        "topic1": {
            "label": "Тема",
            "description": "Тема, упомянутая на этой странице неоднозначности",
            "type": "string"
        },
        "topic2": {
            "inherits": "topic1"
        },
        "topic3": {
            "inherits": "topic1",
            "label" : "A different label"
        }
    }
label

The "label" parameter is a human-readable title for the parameter that will be displayed within the template editor. It displays this in place of the parameter's raw name. This parameter is optional but highly recommended.

"label": "Month and year",
description

Within each object named after a parameter, "description" is a description of the parameter, not the template as a whole. This description is shown in a tooltip when the user hovers over the "i" symbol next to the parameter in the template editor. It is optional but highly recommended.

"description": "The month and year that the template was inserted.",
type

The "type" parameter is meant to signal to a template editor the nature of a parameter's value. In some cases, template editors are programmed to modify the user interface for a certain parameter according to its value type, such as to only allow the user to enter valid values that match that type. This parameter does not have any functional effect on the parameter or its value; it merely controls how template editors see and treat the parameter in editing mode. The most common types are:

  • "string" - набор символов, как это предложение;
  • "number" - набор цифр;
  • "boolean" - '0' for false, '1' for true, '' for unknown;
  • "wiki-user-name" - набор символов, который представляет имя пользователя;
  • "wiki-page-name" - набор символов, который представляет заголовок страницы.
  • "wiki-file-name" - имя файла.

Другие типы включают: "unknown", "date", "url", "wiki-template-name", "content", "unbalanced-wikitext", "line"

To see the effects of the type parameter, see the section #Effects of the type parameter.

"type": "string",
default

Occasionally, a template parameter is programmed to have a default value that is used unless you change it. The "default" item is an optional item intended to tell the user what this value is. The value does not have to match the actual default and has no functional effect. Вы можете игнорировать этот параметр, если по умолчанию нет.

Effects

In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), the "default" text will show as grey text in the input box of any open parameter when it is empty, in the format "Default: default text". Additionally, it will show in plain black text in the parameter description (when the user hovers over the "i" symbol). In VisualEditor and the 2017 wikitext editor, this will be below the parameter description, below "Field is required"/"Field is deprecated", if specified (the 2010 wikitext editor doesn't show this text), and above "example", if specified ("example" does not show in the parameter description in the 2010 wikitext editor). In the 2010 wikitext editor with TemplateWizard, the "default" text shows directly after the parameter description, on the same line, following a space. It shows in the same format as the other editors ("Default: default text").

With other parameters

In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), if "default" is specified, the "example" value will not show in the input box.

"default": "Category:CommonsRoot",
autovalue

Вы можете указать «автозначение» для параметра. Когда пользователи добавляют шаблон на страницу, это значение будет добавлено автоматически. Например, многие шаблоны очистки должны иметь добавленную дату; если вы укажете автоматическое значение для параметра даты шаблона, тогда дата будет заполнена автоматически.

This parameter does not force the value to always be this value. The user can freely change the value that is automatically inputted into the parameter in the template editor.

With other parameters

In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "autovalue" overrides the visible effects of "url" in VisualEditor and the 2017 wikitext editor. See the description for "type" for more info.

"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
example

The "example" value is an optional value intended to display an example input to show how the parameter is used.

Effects

In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), it shows a grey text in the input box of any open parameter when it is empty, in the format "e.g. example text". Additionally, in VisualEditor and the 2017 wikitext editor, it shows the same text in black, non-italic font below the parameter description (and below the "default" text, if specified).

With other parameters

In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "example" will not show in the input box if "default" is specified.

"example": "January 2013",
required

We then have "required", which can be set to either true or false. If you don't specify, it will be assumed to be false.

This specifies whether filling out the parameter is mandatory for that template.

Effects

This status has several effects in VisualEditor and the Редактор вики-текста 2017 :

  • it makes the parameter automatically show up when a user inserts a template;
  • it shows a grey asterisk next to the parameter label;
  • it shows a black asterisk within the input box, on the right;
  • it shows the grey, italic text "Field is required" below the parameter description;
  • it makes the input box glow red if the user clicks away without entering a value;
  • if a user attempts to insert the template without a value in the required parameter, it will show them a prompt, asking if they are sure. If they confirm, it will insert the parameter with a blank value. It will not stop them from inserting the template, though, and it does not result in a visible error by itself (though templates can be programmed to display an error when a required parameter is not filled in).

In the 2010 wikitext editor with TemplateWizard, like in the other editors, it causes the parameter to automatically show up when a user inserts a template, but in this editor the parameter cannot be removed. It also does not display "Field is required" in the parameter description; rather, it lists the parameter on the side under "Required parameters". 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 VisualEditor and the 2017 wikitext editor, the "deprecated" status does not override the functionality of this parameter, but in the 2010 wikitext editor with TemplateWizard it does. See the description of "deprecated" for more info.

"required": true
suggested

There is "suggested", which can be set to either true or false. If you don't specify, it will be assumed to be false.

This is a status for parameters that are not "required" but are recommended to be high value (but not mandatory) for template users.

Effects

In VisualEditor 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 <tvar|1>2010 wikitext editor with TemplateWizard, it does not place the parameter in the template automatically but instead causes it to be listed on the side under "Suggested parameters". The user can then click a "+" next to the parameter to add it to the template.

With other parameters

The "required" status overrides the functionality of this status in all main editors (VisualEditor, the 2017 wikitext editor and the 2010 wikitext editor). It also overrides the displayed "suggested" status in TemplateData documentation (it will display "required" if both "required" and "suggested" are set to true).

"suggested": true
deprecated

Finally, there is "deprecated", which can be set to true, false, or a string describing what users should instead do. Если вы не укажете, это предполагается, что это false.

Это состояние для параметров, которые больше не должны использоваться, но все ещё существуют в настоящее время.

Это может быть потому, что использование шаблона перемещается из одного набора параметров в другой.

Effects

The effect of this parameter in VisualEditor 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 "Field is deprecated" 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 (VisualEditor, 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 true.

In the 2010 wikitext editor with TemplateWizard, setting this value as true does not allow the parameter to be added or seen.

With other parameters

If you set both this and "suggested" as true, the parameter status will show as "deprecated" in the TemplateData documentation, but in VisualEditor and the 2017 wikitext editor both functionalities will be retained; the parameter will automatically show up when a user inserts a template, but it will have the "deprecated" warnings around it.

If you set both this and "required" as true, the parameter status will show as "deprecated" in the TemplateData documentation, but in VisualEditor and the 2017 wikitext editor it will have the same functionality as only "required"; the parameter will automatically show up when a user inserts a template, and it will have the "required" warnings around it. This is the same for if you set "deprecated", "suggested" and "required" as true.

In the 2010 wikitext editor with TemplateWizard, "deprecated" overrides the parameters "required" and "suggested".

"deprecated": "Пожалуйста используйте вместо этого «публикация»."

Note: if neither "required", "suggested" nor "deprecated" are set as true for a parameter, its status will show as "optional" in the TemplateData documentation.

Как только вы закончите, нажмите «сохранить». Если вы допустили ошибки, это не позволит вам сохранить (что разрушительно, но означает, что вы ничего не можете сломать). Если вы столкнетесь с ошибками, объясните на странице обратной связи, что вы пытались сделать, и мы будем рады помочь.

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

Обратите внимание, что каждый бит информации заключен в кавычки (кроме true и false) и отделен от следующего бита запятой, (если это не последний).

Effects of the type parameter

The "type" parameter can have multiple different effects or no effect depending on the value and depending on the template editor. Its effects are listed as follows.

"number":

The "number" value is intended for numerical values, including minus values and decimals.

  • In VisualEditor and the 2017 wikitext editor, "number" has no visible effect.
  • In the 2010 wikitext editor with TemplateWizard, "number", causes the input box to display a "+" and "-" button on either side, which raise or lower a number value in the input box, respectively, and the user can only type numbers into the box. The buttons can also lower the number into negatives.

"string":

The "string" value is intended for any string of plain text.

  • In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "string" has no visible effect compared to "unknown".

"line":

The "line" value is intended for content that should be forced to stay on one line.

  • In VisualEditor and the 2017 wikitext editor, "line" prevents a parameter's input box from allowing new lines, which are usually possible in these editors.
  • In the 2010 wikitext editor with TemplateWizard, "line" has no visible effect (input boxes do not allow new lines by default in this editor).

"url":

The https:// value is intended for a URL, with Internet protocol (e.g., "https://") included.

  • In VisualEditor and the 2017 wikitext editor, "url" makes the input box display an external link icon (a square with arrow pointing out of it) in the left hand side of the box and makes the box glow red when the user clicks away without entering a URL value that includes a valid Internet protocol (e.g., "https://", "ftp://" or "//") followed by some text. This second effect is similar to that of the "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").
  • In the 2010 wikitext editor with TemplateWizard, "url" has no visible effect.

"wiki-page-name":

The "wiki-page-name" value is intended for a page name on a wiki.

  • In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "wiki-page-name" makes the parameter input box show a suggestion dropdown menu containing a list of pages on the wiki, such as Wikipedia articles, which can be selected. Namespaces can also be defined in the search. Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line. It has no other visible effect and doesn't prevent a non-page from being inputted.

"wiki-file-name":

The "wiki-file-name" value is intended for a file name hosted either locally on a wiki or on Wikimedia Commons.

  • In VisualEditor and the 2017 wikitext editor, "wiki-file-name" has no visible effect.
  • In the 2010 wikitext editor with TemplateWizard, "wiki-file-name" makes the parameter input box show a suggestion dropdown menu containing a list of files hosted both locally and on Wikimedia Commons, which can be selected. It also shows the thumbnail of the files. It has no other visible effect and doesn't prevent a non-file from being inputted.

"wiki-template-name":

The "wiki-template-name" value is intended for the name of a template.

  • In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "wiki-template-name" makes the parameter input box show a suggestion dropdown menu containing a list of templates, which can be selected. Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line. It has no other visible effect and doesn't prevent a non-template from being inputted.

"wiki-user-name":

The "wiki-user-name" value is intended for a username on a wiki.

  • In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "wiki-user-name" makes the parameter input box show a suggestion dropdown menu containing a list of actual users' names, which can be selected. Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line. It has no other visible effect and doesn't prevent a non-username from being inputted.

"content":

The "content" value is intended for wikitext of page content, for example, links, images or text formatting.

  • In VisualEditor and the 2017 wikitext editor, "content" has no visible effect.
  • In the 2010 wikitext editor with TemplateWizard, "content" makes the parameter input box one line taller and allows new lines, which regular input boxes in the 2010 wikitext editor do not.

"unbalanced-wikitext":

The "unbalanced-wikitext" value is intended for wikitext that cannot stand alone, i.e. it lacks an opening or closing tag or refers to other parts of wikitext.

  • In VisualEditor and the 2017 wikitext editor, "unbalanced-wikitext" has no visible effect.
  • In the 2010 wikitext editor with TemplateWizard, "unbalanced-wikitext" makes the parameter input box one line taller and allows new lines, which regular input boxes in the 2010 wikitext editor do not.

With other parameters

  • In VisualEditor and the 2017 wikitext editor, "autovalue" overrides the visible effects of "url" - when both are set, the input box will not contain a URL icon nor glow red when the user clicks away without entering a valid URL.
  • In the 2010 wikitext editor with TemplateWizard, "number" overrides the effects of "autovalue" - the value of "autovalue" will not be automatically placed in the input box if the parameter type is "number".

Пользовательские форматы

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 \n for new lines).
  • | - pipe (separates parameters)
  • = - equals sign (precedes the value of a parameter)
  • \n or pressing the enter key - new line (this will display as in the entry field)
  • - space (can be used with \n to 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

Однако, если вы попытаетесь сохранить эту страницу в редакторе на основе JavaScript, таком как VisualEditor или редактор Wikitext 2017 года, вы увидите сообщение об ошибке «Синтаксическая ошибка в JSON», поскольку синтаксический анализатор JavaScript более строгий и не допускает недопустимый JSON.

Кроме того, если вы попытаетесь открыть такой недопустимый JSON с помощью редактора GUI «Шаблон данных», вы увидите сообщение об ошибке «Неверный формат JSON».

This error can come up quite frequently while editing a template's TemplateData. The most common mistakes that cause this error include excess commas (such as trailing commas), missing commas and missing quotation marks.

Examples of trailing commas:
<templatedata>
{
    "description": "",
    "format": "inline",
    "params": {
        "1": {
            "label": "",
            "description": "",
            "type": "", // <-- This comma shouldn't be here.
        }, // <-- This comma shouldn't be here.
    }, // <-- This comma shouldn't be here.
}
</templatedata>
Examples of missing commas:
<templatedata>
{
    "description": "",
    "format": "inline" // <-- A comma should be here.
    "params": {
        "1": {
            "label": "",
            "description": "" // <-- A comma should be here.
            "type": ""
        }
    }
}
</templatedata>
Example of missing quotation marks:
"description": An example description // <-- This text should have quotation marks.

Чтобы исправить эти ошибки, вы можете ввести блок JSON во внешний валидатора JSON, такой как JSONLint, и он выделит проблемные запятые и ключи, чтобы их можно было удалить.

Из-за давней ошибки пользователи, использующие старый редактор вики-текста, могут сохранять страницы с определенными недопустимыми типами JSON, такими как дубликаты ключей или запятые (подробности: задача T128029).

Required property "paramOrder(number)" not found.

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.

Invalid value for property "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.

Property "params.parametername.required" is expected to be of type "boolean".

This error occurs if you put quotation marks around the value of either "required" or "suggested".

"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 "Property "format" is expected to be "inline", "block", or a valid format string."

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

Unexpected property "parametername".

This error occurs if you state a parameter in any 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 object under another object that it doesn't belong to.

For example, you might have written the parameter "label" under the root TemplateData 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 your parameters are in their correct location, and make sure there aren't any spelling mistakes in the parameter names. Additionally, make sure you don't state any parameters that don't exist for an object. You can check which parameters exist for an object on this page, in the section #TemplateData parameters.

Required property "params" not found.

This error occurs if there is no "params" object in the TemplateData.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, чтобы помочь найти ошибки в синтаксисе.