Help:TemplateData/ru



Что такое TemplateData?
TemplateData is a way of storing information about a template and its parameters, so that the VisualEditor can retrieve and display it in the template editor, thus making it easier to edit templates.

TemplateData allows users to write small bits of structured data to a template page, or to be transcluded into that template page (such as on a documentation page). Once a template has this structured data, it can be displayed properly in the VisualEditor. While this may sound complex, it's actually very easy.



Структура TemplateData
TemplateData's structure is based around the JSON standard, and is fairly simple. Note that all descriptions in TemplateData must be in plain text (no wikitext, no links, etc.).

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

This tells the software that everything between the two tags is TemplateData, and should be referenced when the template is used.



Пример
The descriptions inside TemplateData follow a standard layout; let's say that you have a template called "Commons" for linking to a Commons category about a topic. It takes one mandatory parameter: the name of the category on Commons. The TemplateData would look something like this:

Это будет показываться в шаблоне таким образом: {       "description": "Шаблон для ссылки на категорию на Викискладе по теме статьи.", "params": { "1": {                       "label": "категория на Викискладе", "description": "Категория на Викискладе, на которую вы хотите указать ссылку.", "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 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).



Синонимы параметра
Some templates allow a same parameter to have different names.

Например,    или.

To add this information to TemplateData, you simply need to add the aliases to the parameter's information:



Несколько параметров
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:



Похожие параметры
When a template has multiple parameters, sometimes some of them can be of the same kind. In this case, you only need to provide full properties for the first one, and the others can "inherit" their properties from it.



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



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

 * Недостающие возможности — TemplateData is very much an example of tool that was made available with few features, in hope that users would help to guide development of features that they desired. If you'd like to request new features for TemplateData, please let us know.
 * Задержки в отображении в шаблонах — After adding TemplateData to a template, the metadata should be visible immediately when the template is opened in VisualEditor. However, it is possible that it takes hours before the metadata show. You can force an update by making a null edit to the template page itself (not the documentation subpage). To perform a null edit, open the template page for editing, and save the page without making any change.
 * Текущие проблемы — список текущих ошибок и запросов возможностей доступен в багзилле.



Инструменты

 * w:fr:Utilisateur:Ltrlg/scripts/TemplateDataEditor.js — пользовательский скрипт, который делает процесс добавления TemplateData проще (в данный момент доступен только на французском).