Help:TemplateData/uk

 – це розширення для збереження інформації про шаблон вікітексту і його параметри так, аби інтерфейс редагування міг отримувати та відображати цю інформацію у своєму редакторі шаблонів, тим самим полегшуючи користувачам додавання та редагування шаблонів на сторінках.

Since April 2019, TemplateData is part of the default user experience for all users on all Wikimedia wikis when they add a template, including unregistered users. Both the default source and visual editors incorporate it in some way. It is also used elsewhere in scripts, tools and gadgets. Якщо ви маєте власну Вікіпедію, тоді вам необхідно встановити Extension:TemplateData.

Adding TemplateData to a template essentially consists of inserting a small block of JSON code (explained below) on the template's documentation page. There are two main ways you can do this, either manually or by using the TemplateData editor, a graphical user interface located on the "Edit"/"Edit source" pages of templates on wikis with the TemplateData extension installed. The JSON contains a list of parameters with info about each parameter of the template as well as the template as a whole. These are outlined below.

Once a template has TemplateData, this information will show in the user interface when a user adds the template, sometimes in place of original info or sometimes as additional info. In some cases, it may change how the editor behaves when editing or inserting the template. This can make it much easier for users to identify what they need to do with the template when adding it.

History
TemplateData was originally developed in early 2013 with in mind, which was in MediaWiki testing stages at the time. VisualEditor is the main visual editing interface for Wikimedia wikis, and TemplateData allowed it to have a more useful interface when adding templates. It was officially supported by 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 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.

Редактор TemplateData
Редактор TemplateData - це інструмент, вбудований у розширення TemplateData для додавання та редагування TemplateData за допомогою графічного інтерфейсу користувача.

Він доступний після переходу на сторінку будь-якого шаблону (або підсторінку документації) та натиснення «Редагувати» або «Редагувати джерело». Після цього ви побачите кнопку з написом "" над областю редагування та заголовок сторінки.



Натисніть цю кнопку для входу в редактор TemplateData.

Редактор дозволяє вам додавати параметри шаблону та встановлювати найпоширеніші атрибути. Якщо сторінка, яку ви редагуєте, вже містить блок TemplateData, то вже документована інформація автоматично показуватиметься, коли ви відкриєте коректну сторінку в редакторі TemplateData. У першому полі ви можете додати чи оновити короткий опис шаблону простим текстом. Після цього ви можете використати кнопки «Додати пропонований(і) параметр(и)» для документування імен і атрибутів параметрів, які використовує шаблон.

Ви можете вказати назву параметра, перерахувати будь-які його псевдоніми чи альтернативні написання, а також задати його назву та опис, які будуть показані користувачам. Ви також можете надати приклад використання параметру. Єдиним обов'язковим для заповнення полем є Назва (перше поле кожного рядка), в якому треба вказати точну назву параметру, із врахуванням регістру. У спадному меню «Тип» Ви можете вибрати тип вмісту, яким має бути заповнений параметр, наприклад, «рядок» (для заповнення звичайним текстом), «сторінка» (для посилань на інші сторінки), чи «дата». Коли Вам відомо, що якщо залишити певний параметр незаповненим, то шаблон відображатиметься з помилками — будь ласка, позначте такий параметр як «обов'язковий». Якщо ж параметр використовується часто, або є рекомендованим — позначте його як «пропонований». Кнопка «Вилучити інформацію про параметр» вилучить запис для цього параметра із TemplateData.



Після завершення документування усіх параметрів, натисніть кнопку «Застосувати», щоб вставити попередньо відформатований код TemplateData у відкрите вікно редагування. Після цього все одно ще треба зберегти сторінку, натиснувши вже звичну кнопку «Зберегти сторінку» під вікном редагування.

Увага: Редактор TemplateData розмістить TemplateData на сторінці шаблону або на підсторінці документації. Ви визначаєте, де TemplateData буде додано, відкривши (відредагувавши) сторінку, на яку Ви хочете додати TemplateData. Однак, якщо багато блоків TemplateData додаються в той самий шаблон, лише один з блоків TemplateData буде використано. Якщо на сторінці уже є TemplateData, то Вам треба відредагувати сторінку, де TemplateData було додано перед тим, щоб уникнути випадкового створення кількох блоків TemplateData.

Розташування TemplateData
TemplateData повинні бути на сторінці, яку вони описують, або бути transcluded у неї. У шаблоні вони зазвичай обгортатимуться у теги. На рендерингу звичайної сторінки вони показують автозгенеровану документацію, як показано на #Прикладі.

Структура TemplateData
Структура TemplateData базується на стандартах JSON. Зауважте, що всі описи у TemplateData мають бути подані простим текстом (без вікірозмітки, без посилань тощо).

Перше, що треба зробити — це додати пару тегів  будь-де на підсторінці документації, ось так:

Цим Ви повідомите програмі, що все, що розташоване між цими двома тегами, є документацією TemplateData, і саме звідти треба брати інформацію при використанні шаблону.

Приклад
Описи всередині TemplateData даються за стандартним форматом; скажімо, Ви маєте шаблон під назвою «Commons», що веде на категорію Вікісховища на певну тематику. Він містить лише один обов'язковий параметр: назва категорії на Вікісховищі. У такому випадку блок TemplateData виглядатиме якось так:

На сторінці шаблону це виглядатиме так:

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

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, він не може перевірятися на помилки перед збереженням.

Зверніть увагу, що кожна порція інформації береться у лапки (за винятком  та  ), і відокремлюється від наступної порції комою (за винятком останньої).

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".

Спеціальні формати
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 до шаблону. У цей макет включені лише найчастіше вживані теги.

Syntax error in JSON / Bad JSON format
This error occurs if you attempt to save TemplateData that has certain types of invalid JSON code, such as duplicate keys (parameters) or trailing/missing commas, in VisualEditor or the 2017 wikitext editor (JavaScript-based editors).

"Syntax error in JSON" shows if you attempt to save such code in VisualEditor or the 2017 wikitext editor, while "Bad JSON format" shows if you attempt to open up such code in the TemplateData GUI editor, on template pages.

This error can come up quite frequently while editing a template's TemplateData. The most common mistakes that cause this error include excess commas (such as trailing commas), missing commas and missing quotation marks.


 * Examples of trailing commas:


 * Examples of missing commas:


 * Example of missing quotation marks:

To fix these errors, you can either look for the errors in the code yourself, or you can enter the JSON block into an external JSON validator, such as JSONLint, and it will highlight the problematic commas and keys that should be removed.

Due to a longstanding bug, users using the 2010 wikitext editor are able to save pages that have such invalid JSON (details: ), as the JavaScript parser is less strict and allows invalid JSON.

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

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 in any 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 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 your parameters are in their correct location, and make sure there aren't any spelling mistakes in the parameter names. Additionally, make sure you don't state any parameters that don't exist for an object. You can check which parameters exist for an object on this page, in the section.

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: Інструмент, що зчитує вихідний код шаблона, намагається відшукати усі параметри, що в ньому використовуються, та продукує макет TemplateData із вже занесеними до нього параметрами.
 * JSONLint: Інструмент, що дозволяє перевірити написаний вручну код JSON, відшукуючи помилки у синтаксисі.
 * Список усіх шаблонів із TemplateData у цій вікі
 * При використанні шаблону TemplateData у німецькій Вікіпедії, дані шаблону відображаються в окремому, графічно оформленому розділі, а сам шаблон додається до категорії шаблонів із TemplateData