Help:TemplateData/ru

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

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

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

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

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

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

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

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

You can list the name of the parameter, any aliases for it, the label and the description that will display to users. You can also provide an example how to use the parameter. The only required field is Name (the first field in each row), which is where you record the exact, case-sensitive name of the parameter. In the "Type" dropdown menu, you can choose the type of content that the parameter should receive, such as a string (for plain-text answers), page (for links to other pages), or dates. If the template will produce an error if this parameter is left blank, please mark it as "Required". If the parameter is commonly used or recommended, then mark it as "Suggested". The "Remove parameter information" button will delete the parameter's entry from 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 }   } }

Описание и параметры
Once you're done, hit "save". If you've made errors, it will not let you save (which is disruptive, but means you can't break anything). Should you run into errors, explain on the feedback page what you were trying to do, and we will be happy to help.

Note that if you are abusing a hack template to dynamically generate TemplateData, it cannot be checked for errors before saving.

Note that each bit of information is enclosed in quotation marks (except for  and  ), and separated from the next bit by a comma (unless it's the last one).

Пользовательские форматы
When editing custom format strings in the TemplateData editor you can either type  or press the enter key to represent a newline; in either case it will display as   in the entry field.

{| class="wikitable" ! style="width:25%" | Задача ! Строка формата ! Результат each template on its own line
 * + Примеры форматов, которые вы можете использовать
 * Встроенное форматирование
 * Блок форматирования
 * No space before the parameter name,
 * Блок форматирования
 * No space before the parameter name,
 * Блок форматирования
 * No space before the parameter name,
 * No space before the parameter name,
 * No space before the parameter name,
 * No space before the parameter name,
 * Indent each parameter
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Pipe characters at the end of the previous line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Template at the start of a line, indent-aligned parameters, pipe beforehand
 * could also be written as  or.
 * could also be written as  or.

Чтобы добавить эту информацию в TemplateData, вам просто нужно добавить псевдонимы к информации параметра:

Автоматическое значение
You can specify an "autovalue" for a parameter. When users add the template to a page, this value will be added automatically. For example, many clean-up templates need to have the date added; if you specify an autovalue for the template's date parameter, then the date will be filled in automatically.

Чтобы добавить эту информацию в TemplateData, вам просто нужно добавить псевдонимы к информации параметра: Возможно, вы захотите использовать префикс  со значениями, чтобы они оставались неизменными:

Параметры с списком значений
If you have multiple parameters, just repeat each section (starting from the "1" tag) and fill it out as you see fit. Note that if a template has multiple parameters, you need to separate them with a comma in the templatedata, like so:

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

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

Синтаксическая ошибка в JSON / Плохой формат JSON
Из-за давней ошибки пользователи, использующие старый редактор вики-текста, могут сохранять страницы с определенными недопустимыми типами JSON, такими как дубликаты ключей или запятые (подробности: ). However if you attempt to save this page in a JavaScript based editor, such as VisualEditor or the 2017 Wikitext editor, you will see an error message "Syntax error in JSON," as the JavaScript parser is stricter and doesn't allow invalid JSON. Additionally, if you attempt to open up such invalid JSON with the Template Data GUI editor, you will see the error message, "Bad JSON format." To fix these errors, you can enter the JSON block into an external JSON validator, such as JSONLint, and it will highlight the problematic commas and keys so they can be removed.

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

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