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 }   } }

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

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

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

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

{| class="wikitable" ! style="width:25%" | Задача ! Строка формата ! Результат каждый шаблон в отдельной строке
 * + Примеры форматов, которые вы можете использовать
 * Встроенное форматирование
 * Блок форматирования
 * Нет пробела перед именем параметра,
 * Блок форматирования
 * Нет пробела перед именем параметра,
 * Блок форматирования
 * Нет пробела перед именем параметра,
 * Нет пробела перед именем параметра,
 * Нет пробела перед именем параметра,
 * Нет пробела перед именем параметра,
 * Отступ каждый параметра
 * Выровнять все имена параметров по заданной длине
 * Выровнять все имена параметров по заданной длине
 * Выровнять все имена параметров по заданной длине
 * Выровнять все имена параметров по заданной длине
 * Выровнять все имена параметров по заданной длине
 * Символы в конце предыдущей строки
 * Встроенный стиль с большим количеством пробелов, должен быть в начале строки
 * Встроенный стиль с большим количеством пробелов, должен быть в начале строки
 * Встроенный стиль с большим количеством пробелов, должен быть в начале строки
 * Встроенный стиль с большим количеством пробелов, должен быть в начале строки
 * Встроенный стиль с большим количеством пробелов, должен быть в начале строки
 * Шаблон в начале строки, параметры с выравниванием по отступу, труба заранее
 * could also be written as  or.
 * could also be written as  or.

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

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

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

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

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

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

Синтаксическая ошибка в JSON / Плохой формат JSON
Из-за давней ошибки пользователи, использующие старый редактор вики-текста, могут сохранять страницы с определенными недопустимыми типами JSON, такими как дубликаты ключей или запятые (подробности: ). Однако, если вы попытаетесь сохранить эту страницу в редакторе на основе JavaScript, таком как VisualEditor или редактор Wikitext 2017 года, вы увидите сообщение об ошибке «Синтаксическая ошибка в JSON», поскольку синтаксический анализатор JavaScript более строгий и не допускает недопустимый JSON. Кроме того, если вы попытаетесь открыть такой недопустимый JSON с помощью редактора GUI «Шаблон данных», вы увидите сообщение об ошибке «Неверный формат JSON». Чтобы исправить эти ошибки, вы можете ввести блок JSON во внешний валидатора JSON, такой как JSONLint, и он выделит проблемные запятые и ключи, чтобы их можно было удалить.

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

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