Help:TemplateData/ru

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

С апреля 2019 года функционал TemplateData является частью пользовательского интерфейса по умолчанию для всех пользователей на всех вики-сайтах Викимедиа, когда они добавляют шаблон, даже для незарегистрированных пользователей. И исходный код по умолчанию, и визуальные редакторы внедряют его тем или иным образом, как и многие скрипты, инструменты и гаджеты. Если вы хотите иметь этот функционал в вашей собственной вики, вам нужно установить.

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

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

История
TemplateData был первоначально разработан в начале 2013 года с расчетом на, который в то время находился на стадии тестирования MediaWiki. VisualEditor является основным интерфейсом визуального редактирования для википроектов Викимедиа, а TemplateData позволил ему иметь более удобный интерфейс при добавлении шаблонов. Он был официально поддержан 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 December 2016, the VisualEditor interface was made available for editing source code as a beta feature. This was termed the. This brought the features of TemplateData to source editing for the first time.

In March 2018, Sam Wilson developed, a GUI template editor extension for the default Wikimedia source editor, (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.

Adding or editing TemplateData
To add or edit TemplateData, first navigate to a template's page, located at "/Template:Templatename".

Checking the current state
Before adding or editing TemplateData, check whether the template has a documentation subpage. Then check whether the template already contains TemplateData and, if so, whether it's located on the template page or the documentation subpage.

Documentation subpages
There are two main ways templates on most Wikimedia wikis store their usage notes and other data that shouldn't be included in the actual template itself, like categories the template should be contained in:

On pages like this, the Documentation template transcludes all the /doc page's content onto the template page, keeping the template's source code much cleaner.
 * The vast majority of templates keep usage notes and other data that doesn't belong on the template page itself on a documentation subpage: "/Template:Templatename/doc".
 * On templates with documentation subpages, the "Test Template Info-Icon - Version (2).svg Template documentation" heading will be followed by links such as [view], [edit], [history] and [purge].

You can spot it on these pages by looking for an occurrence of  between  tags.
 * A few template pages have retained that information on the template's main page.

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 " " and " " and then added content after " ".

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 TemplateData 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 tags and their contents (usually at the bottom).

It should look something like this:

You may also find that it already contains TemplateData. If so, it will look something like this:

Select everything after " " and before "" and cut it into your clipboard or save it in a temporary document. Delete " ", leaving only the following:

Save the template page.

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 tags so that they apply only to the template's main page:

Many wikis have a  template. 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:

Finally, publish the page.

You can now add and edit the TemplateData on the documentation subpage using the instructions described in #Methods.

Adding and editing TemplateData on the main template page
If you can't create the /doc page, you can add and edit TemplateData 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 TemplateData (the 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 TemplateData on either page, you will see a yellow notice at the top of the page saying either:



или

If the template has TemplateData on its documentation subpage

If the template has TemplateData on its documentation subpage, this is the page you should edit. You can 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. Follow the guidance at #Methods to add or edit the TemplateData.

If the template has TemplateData on its main page

If the template has TemplateData 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 TemplateData to the documentation subpage

To do this, click ""/"" on the main template page, and look for the tags, enclosed within  tags. It should look something like this:

Cut only the 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 "TemplateData", then beneath it paste the TemplateData.

You can now edit the TemplateData based on the guidance at #Methods.

Editing TemplateData on the main template page

If you do not wish to move the TemplateData to the /doc page, you can edit it on the main template page. See #Methods for how to edit TemplateData.

If the template does not yet have TemplateData but has a doc subpage

If the template does not yet have TemplateData, 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 "TemplateData", then add it beneath this heading. The section #Methods explains how to add TemplateData.

Редактор TemplateData
This is a simple way to add or edit TemplateData, 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 TemplateData 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  (on one line) and   (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 TemplateData, this area displays them in a list. If the template's source code specifies parameters for which no TemplateData exists, you may see a button labeled "". The editor extracts these suggestions from the template's source code by looking for  or  . Clicking "" will add these parameters using their names as defined in the source code. A green notice will also appear at the top, for example, "".
 * 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.

When finished, click "". This will automatically insert the TemplateData at the bottom of the page before the tag; or, if already present, it will be updated with the new information without changing its position. The TemplateData text will also be selected when you click "".

The TemplateData editor creates a  parameter at the bottom of the TemplateData (or updates it if it already exists). contains the current TemplateData parameters in the order in which they were displayed by the TemplateData editor. You can change the  by dragging the parameters up and down in the TemplateData editor using the three horizontal bars on the left. and its effects are described here.

After this, click "" to save your revision of the page.

Manual method
You can also add or edit TemplateData manually. TemplateData написано на JSON, но вам не нужно учить JSON, чтобы узнать, как создавать TemplateData. TemplateData follows a few very simple rules and accepts only a few dozen possible predefined parameters and values, typically following a  format.

Adding TemplateData manually

Considerations:


 * If you're adding TemplateData 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, TemplateData is typically near the bottom of the documentation page; on the German Wikipedia, it is typically at the top.
 * If you're adding TemplateData on a template's main page (not recommended; see #Prior checks), you must make sure to place it inside the  tags.

Click "" or "" on the respective page, then move to the place in the page where you intend to add TemplateData and write a heading: "TemplateData".

Many wikis have a TemplateData header template that adds a short notice regarding TemplateData. If your wiki does, add it after the heading.

To start adding TemplateData, type an opening and closing tag and a pair of curly brackets on new lines, with an empty line between them:

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 #TemplateData parameters. Most are optional; some are highly recommended.

Parameters can be in any order, but what follows is the order that best conforms to TemplateData documentation and makes the content easiest to use for editors:

Make sure the parameters, for example, in the  object, remain inside that object; otherwise you will trigger an "" error when you try to save.

Пример

Here is some example TemplateData 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 TemplateData would look something like this:

The corresponding TemplateData documentation would display as follows:

{	"description": "Use this template to indicate that an article is in need of cleanup.", "format": "inline", "params": { "дата": { "label": "Месяц и год", "description": "Месяц и год, в которые шаблон был добавлен", "type": "string", "autovalue": " ", "example": "Январь 2013 года", "suggested": true },		"причина": { "aliases": ["1"], "label": "Причина", "description": "Причина, по которой статья нуждается в чистке", "type": "string" },		"обс.": { "aliases": ["разделобсуждения"], "label": "Раздел страницы обсуждения", "description": "The section of the talk page containing relevant discussion", "type": "string" }	},	"paramOrder": [ "дата", "причина", "обс." ] }

Параметры TemplateData
All available TemplateData parameters are listed below with a description and example. They are also listed in more technical detail at Extension:TemplateData#Format.

Within a parameter's name
Note: if neither,   nor   are set as   for a parameter, its status will show as   in the TemplateData documentation.

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

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

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

Type parameter
The  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 TemplateData 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.

How to use

It is used by adding the  parameter, followed by a colon and a space, then adding any of the values listed in the table below in quotation marks.

Пример:

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.

Пользовательские форматы
When editing the  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   for new lines).
 * - pipe (separates parameters)
 * - equals sign (precedes the value of a parameter)
 * or pressing the enter key - new line (this will display as  in the entry field)
 * - space (can be used with  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.

Пустой шаблон
Вы можете скопировать пустой шаблон ниже, чтобы добавить новые TemplateData в шаблон. Только самые распространенные теги включены.

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

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

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 TemplateData 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. Pages that contain invalid JSON may throw alarming "" messages. To fix these errors, your best bet is to use a JSON validator (see above).

Required property "paramOrder(number)" not found.
This error occurs if you state a parameter in  that is not stated in. The number in the square brackets refers to the parameter in  that is missing. It refers to its order in the sequence, but it is one less than its actual position, since  is an array; 0 is the first one, 1 is the second, etc.

To fix this, make sure all parameters stated in  are listed in. Alternatively, you can remove the  object to remove this error.

Invalid value for property "paramOrder(number)".
This error occurs if you state a parameter in  that is not stated in. The number in the square brackets refers to the parameter in  that shouldn't be there. It refers to its order in the sequence, but it is one less than its actual position, since  is an array; 0 is the first one, 1 is the second, etc.

To fix this, make sure all parameters stated in  are listed in. Alternatively, you can remove the  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  or.

These are boolean values, not strings, therefore they require no quotation marks. To fix this, remove any quotation marks around the values  or   for these parameters.

Property "format" is expected to be ...
If the  parameter exists but its value is not ,   or a valid format string, you will see the error message "".

To fix this, make sure the value after  equals   or   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  parameter to remove this error.

Unexpected property "parametername".
This error occurs if you state a parameter that does not exist in TemplateData. This is probably due to spelling mistakes.

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

For example, you might have written the parameter  under the root TemplateData object instead of inside  :

Alternatively, if the unexpected parameter is under a template parameter inside, 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 TemplateData object. You can check which parameters exist for an object in the section #TemplateData parameters.

Required property "params" not found.
This error occurs if there is no  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  parameter.

Ограничения и вопросы

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

Другие инструменты

 * : Диалоговое окно панели инструментов для ввода шаблона вики-текста через форму, созданную из TemplateData.
 * TemplateData Wizard: Инструмент, который генерирует TemplateData через интерактивный интерфейс.
 * Skeleton TemplateData generator: Инструмент, который читает исходный вики-код шаблона, пытается найти все используемые параметры и выводит скелетный документ с перечисленными параметрами.
 * JSONLint: Инструмент, который позволяет вам проверять написанный вручную JSON, чтобы помочь найти ошибки в синтаксисе.
 * Список всех шаблонов с TemplateData на этой вики
 * При dewiki данные шаблона TemplateData шаблона отображаются в поле, а шаблон добавляется в категорию шаблонов с данными шаблона.
 * https://query.wikidata.org/ and Query Helper