Help:TemplateData/ru

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

Расширение TemplateData устанавливается на все вики, управляемые Фондом Викимедиа. Если у вас есть собственная вики, вам нужно будет установить Extension:TemplateData.

Синтаксис TemplateData позволяет пользователям записывать небольшие фрагменты структурированных данных на страницу шаблона или быть включенными в эту страницу шаблона (например, на странице документации шаблона). Как только шаблон имеет эти структурированные данные, он может правильно отображаться в визуальном редакторе. Хотя это может показаться сложным, на самом деле это очень просто.

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

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

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

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

Если страница шаблона защищена, вы можете скопировать и вставить код шаблона на вложенной странице, с помощью кнопки «Добавить предложенные параметры» скопировать содержимое TemplateData, отредактировать обратно страницу, чтобы избавиться от кода шаблона, а затем вставьте содержимое TemplateData. Для того, чтобы знать, куда вставить содержимое TemplateData в внутри подстраницы, вы можете редактировать TemplateData, не добавляя ничего; затем вы можете заменить теги и и их содержимое, вставив поверх них.

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



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

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

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

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

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

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

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

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

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

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

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

Описание и параметры
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  object are kept within the object.

Note that this information is current as of February 2020 and may change if new parameters are added or the template editors get updates to treat certain parameters differently or fix certain behaviours.

Within the parameter's name
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, это нельзя проверить на наличие ошибок перед сохранением.

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

Пользовательские форматы
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.

Effects of the type parameter
The  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.



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


 * In VisualEditor and the 2017 wikitext editor,  has no visible effect.
 * In the 2010 wikitext editor with TemplateWizard,,  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.



The  value is intended for any string of plain text.


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



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


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



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


 * In VisualEditor and the 2017 wikitext editor,  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,  has no visible effect.



The  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),  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.



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


 * In VisualEditor and the 2017 wikitext editor,  has no visible effect.
 * In the 2010 wikitext editor with TemplateWizard,  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.



The  value is intended for the name of a template.


 * In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard),  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.



The  value is intended for a username on a wiki.


 * In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard),  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.



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


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



The  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,  has no visible effect.
 * In the 2010 wikitext editor with TemplateWizard,  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,  overrides the visible effects of  : 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,  overrides the effects of  : the value of "autovalue" will not be automatically placed in the input box if the parameter type is "number".

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

Синтаксическая ошибка в JSON / Плохой формат JSON
Однако, если вы попытаетесь сохранить эту страницу в редакторе на основе JavaScript, таком как VisualEditor или редактор Wikitext 2017 года, вы увидите сообщение об ошибке «Синтаксическая ошибка в JSON», поскольку синтаксический анализатор JavaScript более строгий и не допускает недопустимый JSON. These errors can come up quite frequently while heavily editing a template's TemplateData.

Examples of trailing commas:

Examples of missing commas:

Another common cause is missing quotation marks:

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

Чтобы исправить эти ошибки, вы можете ввести блок JSON во внешний валидатора JSON, такой как JSONLint, и он выделит проблемные запятые и ключи, чтобы их можно было удалить. Alternatively, you can look for the errors in the code yourself.

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

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

To fix this, make sure the value in  equals ,   or, if it's wikitext, contains a minimum of. Additionally, if it's wikitext, make sure 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.

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 is the parameter in  that is missing (it is one less, since it 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 is the parameter in the  that is missing (it is one less, since it 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.

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 Wizard: Инструмент, который генерирует TemplateData через интерактивный интерфейс.
 * Skeleton TemplateData generator: Инструмент, который читает исходный вики-код шаблона, пытается найти все используемые параметры и выводит скелетный документ с перечисленными параметрами.
 * JSONLint: Инструмент, который позволяет вам проверять написанный вручную JSON, чтобы помочь найти ошибки в синтаксисе.
 * Список всех шаблонов с TemplateData на этой вики
 * При dewiki данные шаблона TemplateData шаблона отображаются в поле, а шаблон добавляется в категорию шаблонов с данными шаблона.