Довідка:TemplateData

From mediawiki.org
Jump to navigation Jump to search
This page is a translated version of the page Help:TemplateData and the translation is 99% complete.
PD Зверніть увагу! Коли Ви редагуєте цю сторінку, то погоджуєтесь робити свій внесок під ліцензією CC0. Детальніше про умови ліцензії можна дізнатися на сторінці довідки.
PD

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

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

Додавання TemplateData до шаблону по суті є додаванням невеликого блоку коду JSON (як пояснено нижче) до сторінки документації шаблону. Це, хоч і виглядає складно, насправді просто. Є два основних способа зробити це: або вручну, або з допомогою редактора TemplateData - графічного користувацького інтерфейсу, доступного на сторінці "Редагувати"/"Редагувати код" шаблону на тих вікі, де розширення TemplateData встановлене. JSON містить перелік параметрів з інформацією про кожен із них, а також інформацію про шаблон в цілому. Подробиці наведено нижче.

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

Історія

TemplateData було створено на початку 2013 для VisualEditor , який в MediaWiki тоді працював у тестовому режимі. VisualEditor є основним графічним інтерфейсом для редагування вікі Wikimedia, а TemplateData розширює його можливості при додаванні до сторінки шаблонів. Він одразу був офіційно підтриманий у VisualEditor. З розповсюдженням VisualEditor по всіх головних вікі Wikimedia як редактора за замовчуванням протягом 2013-2016 років, TemplateData так само входив до цих вікі.

У грудні 2016 року в бета-тестовому режимі інтерфейс VisualEditor був прилаштований для редагування коду сторінок вікі. Ця функція отримала згодом назву Редактор вікі-тексту 2017. Тоді функції TemplateData були вперше застосовані при редагуванні коду.

В березні 2018 року Sam Wilson розробив TemplateWizard , розширення для вставки шаблонів для роботи у звичайному редакторі коду Wikimedia WikiEditor (знаному як редактор вікі-тексту 2010), з метою спрощення вставки шаблонів із застосуванням інформації з TemplateData. У квітні 2019 року TemplateWizard увійшов до складу редактора вікі-тексту 2010 у всіх вікі Wikimedia. Це значило, що TemplateData стало складовою частиною обох редакторів, візуального та редактора коду, у всіх вікі Wikimedia.

Додавання чи редагування інформації в TemplateData

Аби додати чи змінити інформацію в TemplateData якогось шаблону, перейдіть спочатку на його сторінку - на "/Шаблон:Назва шаблону".

Попередні перевірки

Перш ніж редагувати TemplateData, слід з'ясувати два питання, в такому порядку:

  1. чи має шаблон підсторінку документації
  2. чи містить шаблон якісь дані в TemplateData, що розташована на або сторінці шаблону, або на підсторінці його документації.

Перевірка підсторінки документації

Почати слід зі з'ясування того, чи шаблон має підсторінку документації.

Шаблони у більшості вікі Wikimedia зберігають свої примітки про застосування та іншу інформацію, яка не включається до сторінок разом із шаблоном, як-от категорія, до якої сам шаблон належить, двома способами:

  • Переважна більшість використовує підсторінку документації. Ця сторінка розташована за таким посиланням: повне посилання на шаблон із доданим "/документація". В цьому випадку на основній сторінці шаблону після його коду є лише текст "{{Документація}}" в тегах ‎<noinclude>. Тут шаблон {{Документація}} виконує трансклюзію всього вмісту сторінки /документація на сторінку шаблону. Завдяки такому підходу код власне шаблону виглядає значно коротшим і зрозумілішим.
  • Невелика кількість вікі тримають інформацію про шаблон безпосередньо на сторінці шаблону після його коду. В такому випадку вона знаходиться після "{{Документація|content=", що в свою чергу охоплено тегом ‎<noinclude>.

Ви можете швидку з'ясувати, чи містить шаблон підсторінку /документація, перевіривши, чи "Test Template Info-Icon - Version (2).svg Документація шаблону" містить посилання "[перегляд] [редагувати] [історія] [очистити кеш]" одразу за ним. Це може виглядати дещо по-різному в різних вікі. В рідкісних випадках основна сторінка шаблону може містити текст документації навіть якщо ці посилання відображені та підсторінка /документація існує. Таке трапляється, якщо користувач додав іншу назву підсторінки /документація між "{{Документація|" та "|content=", а потім додав власне вміст за |content=".

Дещо менш надійний спосіб перевірки полягає в відшукуванні підпису "Документація вище включена з Шаблон:Назва шаблону/документація" чи подібного внизу сторінки.

Якщо у шаблону немає підсторінки документації

Якщо шаблон не має сторінки документації, у вас є два варіанти дій:

  • Створити її з відповідним вмістом (перенісши його з іншого місця, якщо вона там) на підсторінці /документація. Після цього можна додавати дані TemplateData до підсторінки документації. Це найкращий спосіб.
  • Додавати чи редагувати дані TemplateData на основній сторінці шаблону.

Створення підсторінки /документація та переніс туди вмісту

На більшості вікі Wikimedia тільки зареєстровані користувачі можуть створювати сторінки. На окремих налаштовано ще додаткове обмеження на вік облікового запису чи внесок користувача.

Щоб зробити це, натисніть "Редагувати"/"Редагувати код" на основній сторінці шаблону й відшукайте теги ‎<noinclude> (зазвичай наприкінці), погляньте на їхній вміст.

Він має виглядати приблизно так:

<noinclude>
{{Documentation|content=
== Usage ==

Information about usage.

== More example headings ==

More example contents

[[Category:Example category]]
[[Category:Example category 2]]
}}
</noinclude>

Він також може вже містити дані TemplateData. В такому разі він виглядатиме приблизно так:

<noinclude>
{{Documentation|content=
...
<templatedata>
{
    "description": "",
    "params": {
        "1": {
            "label": "Example parameter",
            "description": "Example parameter description",
            "type": "string"
        }
    }
}
</templatedata>
</noinclude>

Виділіть усе від "|content=" до "‎</noinclude>", виріжте до буферу обміну, потім видаліть "|content=", аби залишилося щось подібне:

<noinclude>
{{Documentation}}
</noinclude>

Збережіть сторінку.

Допишіть /документація до URL в адресному рядку оглядача після назви шаблону, натисніть Enter. Далі натисніть "Створити код".

В українській вікі є шаблон {{Підсторінка документації}}, тому додайте його на початку створюваної сторінки. Можливо, слід додати й інші шаблони, як-от {{Purge button}} чи посилання {{Purge}}. Див. m:Вікіпедія:Документація_шаблонів за додатковою інформацією.

Під цим вставте вміст буферу обміну.

Охопіть категорії, до яких має належати шаблон, тегом ‎<includeonly>. Тепер вони не стосуватимуться підсторінки документації, а з'являться лише на основній сторінці шаблону.

Це має виглядати приблизно так:

<includeonly>
[[Category:Example category]]
[[Category:Example category 2]]
</includeonly>

Деякі вікі, в тому числі українська, мають шаблон {{Sandbox other}}. Вставте його, якщо поточний шаблон повинен мати власну пісочницю, яка не належить до тих самих категорій, що й шаблон. Цей вставлений шаблон має запобігти присвоюванню категорій шаблону його пісочниці.

Це має виглядати приблизно так:

<includeonly>{{sandbox other||
[[Category:Example category]]
[[Category:Example category 2]]
}}</includeonly>

Після цього натисніть "Опублікувати сторінку".

Тепер можна додавати й редагувати дані TemplateData на підсторінці документації за процедурою, описаною в #Методи.

Додавання чи редагування TemplateData на основній сторінці шаблону

Якщо ви не хочете чи не можете створити підсторінку /документація, можна додати дані TemplateData на основну сторінку шаблону. Інструкція представлена в #Методи.

Якщо шаблон уже має підсторінку документації

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

Перевірте обидві сторінки, основну сторінку шаблону й підсторінку /документація, на наявність даних TemplateData; вони мають виглядати приблизно так:

Template parameters

ParameterDescriptionTypeStatus
Example parameter1

Example parameter description

Stringoptional

Як альтернатива, розширення TemplateData може виконати цю перевірку замість вас. Натисніть "Редагувати" чи "Редагувати код" на відповідній сторінці.

Якщо шаблон уже містить дані TemplateData на тій чи іншій сторінці, ви побачите виділену жовтим примітку нагорі сторінки, де написано таке:

"Зверніть увагу: блок TemplateData уже існує на пов'язаній сторінці "Шаблон:Назва шаблону/документація"", або таке:
"Зверніть увагу: блок TemplateData уже існує на пов'язаній сторінці "Шаблон:Назва шаблону""

Якщо шаблон містить дані TemplateData на своїй підсторінці документації

Якщо шаблон має дані TemplateData на своїй підсторінці документації, саме цю сторінку слід редагувати. Це можна зробити натисканням посилання "[редагувати]" біля заголовку "Test Template Info-Icon - Version (2).svg Документація шаблону" (чи подібного), або, якщо ви вже на підсторінці /документація, натисканням "Редагувати" чи "Редагувати код" нагорі сторінки. Далі слідуйте вказівкам із #Методи для додавання чи редагування даних TemplateData.

Якщо шаблон містить дані TemplateData на своїй основній сторінці

Якщо шаблон містить дані TemplateData на своїй основній сторінці, є два способи дій:

  • Перенести їх до підсторінки документації. Це найкращий спосіб.
  • Редагувати ці дані на основній сторінці шаблону.

Перенесення даних TemplateData до підсторінки документації

Аби зробити це, натисніть "Редагувати"/"Редагувати код" на основній сторінці шаблону і знайдіть тег ‎<templatedata>, охоплений тегами ‎<noinclude>. Це має виглядати приблизно так:

<noinclude>
{{Documentation}}
<templatedata>
{
    "description": "",
    "params": {
        "1": {
            "label": "Example parameter",
            "description": "Example parameter description",
            "type": "string"
        }
    }
}
</templatedata>
</noinclude>

Виріжте до буферу обміну тег ‎<templatedata> з усім вмістом і збережіть сторінку.

Далі відкрийте редагування підсторінки документації натисканням посилання "[редагувати]" після заголовку Test Template Info-Icon - Version (2).svg Документація шаблону" або подібного.

Наберіть заголовок, приміром, "TemplateData", під ним вставте дані з буферу обміну.

Тепер можна редагувати дані TemplateData згідно із вказівками в #Методи.

Редагування даних TemplateData на основній сторінці шаблону

Якщо ви не хочете переносити дані TemplateData до підсторінки /документація, можна редагувати їх просто на основній сторінці шаблону. Див. #Методи щодо редагування даних TemplateData.

Якщо шаблон не має TemplateData, але має підсторінку документації

Якщо шаблон наразі не має TemplateData, цей блок слід додавати до підсторінки документації.

Можна зробити це, натиснувши посилання "[редагувати]" біля заголовку "Test Template Info-Icon - Version (2).svg Документація шаблону" (чи подібного), або, якщо ви вже на сторінці /документація, натиснувши "Редагувати" чи "Редагувати код" нагорі сторінки. Напишіть заголовок, на кшталт "TemplateData", потім додайте блок даних під ним. Розділ #Методи пояснює, як додавати блок TemplateData.

Методи

Метод редактора TemplateData

Це простіший спосіб додавання чи змінювання TemplateData, придатніший для недосвідчених користувачів.

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

Після натискання на «Редагувати» чи «Редагувати код» ви побачите кнопку над полем редагування та заголовком сторінки з назвою «Управління TemplateData». Manage template documentation button for TemplateData 2014.png

Натисніть цю кнопку для входу в редактор TemplateData. Якщо сторінка, яку ви редагуєте, вже містить блок TemplateData, ці дані будуть відображені тут автоматично. Скриншот інструменту редагування TemplateData

Функції, доступні в показаному вікні:

  • Верхнє вікно "Мова". Це стосується опису шаблону, який можна зробити декількома мовами, за замовчуванням буде обрано ту, яку користувач обрав в особистих налаштуваннях. Інформація з іншомовних вікі тут не подається, оскільки різні вікі мають різні бази даних шаблонів. Якщо даних різними мовами в TemplateData немає, у вікні буде відображено лише мову поточної вікі. Користувач кнопкою "Додати мову" може додати інші мови для опису шаблону. Код мови вказується на екрані в дужках поряд із параметром, якого він стосується. Це можуть бути описи й мітки.
  • Наступне поле містить опис шаблону. Це опис шаблону в цілому, він показується користувачеві в різних місцях при додаванні шаблону. Його функції детально описано тут.
  • Далі можна обрати варіант вікітекстового форматування шаблону, що вставляється. Доступні варіанти "Невизначено", "Вбудований" (все на одному рядку), "Блоковий" (розбивка по рядках) і "Нестандартний". Ці параметри детальніше описані тут.
Якщо користувач обирає "Нестандартний", він зможе описати цей формат набором вікітексту в параметрі "Рядок нестандартного формату", згідно з правилами, описаними тут, і саме з такої розбивкою по рядках вставлятиметься шаблон, коли користувач в редакторі натискатиме "Вставити".
  • Далі поле "Параметри шаблону", яке містить перелік параметрів шаблону з їхнім описом. Воно може уже містити інформацію у випадку редагування існуючого блоку TemplateData. Якщо у коді шаблону є параметри, не описані наразі в TemplateData, ви можете побачити кнопку "Додати запропоновані параметри". Розширення знаходить їх в коді шаблону за фрагментами {{{назва_параметру}}} або {{{назва_параметру|}}}. Натискання кнопки додасть опис цих параметрів під їх назвами, визначеними в коді. Також буде відображено зеленим примітку нагорі: "2 нових параметри імпортовано: назви параметрів".
  • Внизу є посилання "Додати параметр". Це дозволяє вручну додати опис параметра з довільною назвою.

Наступним кроком є натискання на один із параметрів у списку. Там можна задати інформацію про параметр.


Скриншот редактора TemplateData, що показує додавання другого параметру

Всі ці функції та їхню дію описано в підрозділі #Всередині назви параметру.

  • Редактор TemplateData не дозволяє змінити назву параметру на порожню "назву". Запис параметра з порожньою назвою не зустріне спротиву з боку редактора вікітексту 2010 року із TemplateWizard, але це неможливо у візуальному редакторі чи редакторі вікітексту 2017 року. Назва параметру - це єдине обов'язкове поле в TemplateData.
  • Натискання посилання "Вилучити інформацію про параметр" видалить опис параметру та всю інформацію про нього із даних TemplateData. Ви не зможете відновити чи відкотити цю зміну в TemplateData, якщо лише не натиснули відмову від запису "X" на закінчення редагування. Будь-які зміни, зроблені після натискання посилання "Застосувати", можна відкотити натисканням Ctrl+Z.
  • Вихід із редактора TemplateData після зроблених змін демонструє запитання, чи ви певні щодо відміни внесених змін.

Після завершення редагування натисніть "Застосувати". Це автоматично вставить блок TemplateData внизу сторінки перед тегом ‎</noinclude>, або, якщо такий блок вже існував, замінить інформацію відповідно до редагування, не змінивши положення блоку. Також блок TemplateData буде виділено після натискання "Застосувати".

Редактор TemplateData створює параметр "paramOrder" наприкінці блоку TemplateData чи оновлює тамтешню інформацію. Він містить поточний перелік опису параметрів шаблону в TemplateData в тому порядку, в якому вони відображувалися в редакторі TemplateData. Можна змінити paramOrder в редакторі TemplateData перетягуванням параметрів за допомогою трьох горизонтальних смужок ліворуч. "paramOrder" та його дію пояснено тут.

Після цього натисніть "Зберегти", аби записати зміни до редагованої сторінки.

Ручний спосіб

Альтернативою використанню візуального редактору TemplateData є додавання цього блоку вручну. В окремих випадках таке може знадобитися. Структура TemplateData базується на стандартах JSON, але вам не треба опановувати JSON, щоб навчитися додавати TemplateData. Це робиться за дуже простими правилами й полягає в записі лише кількох десятків значень, майже завжди у вигляді "parameter": "value".

Додавання блока TemplateData вручну

Попередні міркування:

  • Якщо ви додаєте блок TemplateData на підсторінку документації шаблону, можете додавати його в будь-якому місці сторінки; перевірте рекомендації власної вікі, аби з'ясувати, чи не обумовлене там рекомендоване положення цього блоку. Приміром, в англомовній вікі блок TemplateData зазвичай наприкінці сторінки, а в німецькомовній - зазвичай нагорі.
  • Якщо ви додаєте блок TemplateData на головну сторінку шаблону (що не рекомендовано, див. #Попередні міркування), то маєте пересвідчитися, що він охоплений тегом ‎<noinclude>...‎</noinclude>.

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

Багато які вікі (зокрема, україномовна; але не всі) містять шаблон {{TemplateData header}}, який додає коротку примітку щодо блоку TemplateData. Додайте його після заголовку.

Для початку запису TemplateData вставте тег ‎<templatedata> і пару фігурних дужок на нових рядках, з порожнім рядком поміж ними:

<templatedata>
{

}
</templatedata>

Далі додайте відступ на порожньому рядку між двома круглими дужками і починайте записувати параметри. Подробиці щодо параметрів подано тут. Більшість параметрів необов'язкові, але декілька настійливо рекомендовані.

Параметри можна записувати в будь-якому порядку, але порядок, що найкраще корелює з порядком в документації щодо TemplateData і з відображенням редакторів TemplateData, такий:

<templatedata>
{
    "description": "",
    "format": "",
    "params": {
        "parameter1": {
            "aliases": ["",""]
            "label": "",
            "description": "",
            "type": ""
        }
    },
    "paramOrder": [
    	""
    ]
}
</templatedata>

Також упевніться, що параметри, приміром, об'єкту "params" синтаксично залишаються всередині цього об'єкту, інакше при спробі запису отримаєте помилку "Неочікуваний атрибут".

Приклад

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

<templatedata>
{
	"description": "Use this template to indicate that an article is in need of cleanup.",
	"format": "inline",
	"params": {
		"date": {
			"label": "Month and year",
			"description": "The month and year that the template was added",
			"type": "string",
			"autovalue": "{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}",
			"example": "January 2013",
			"suggested": true
		},
		"reason": {
			"aliases": ["1"],
			"label": "Reason",
			"description": "The reason the article is in need of cleanup",
			"type": "string"
		},
		"talk": {
			"aliases": ["talksection"],
			"label": "Talk page section",
			"description": "The section of the talk page containing relevant discussion",
			"type": "string"
		}
	},
	"paramOrder": [
		"date",
		"reason",
        "talk"
	]
}
</templatedata>

Відповідна документація TemplateData відображуватиметься так:

Use this template to indicate that an article is in need of cleanup.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Month and yeardate

The month and year that the template was added

Example
January 2013
Auto value
{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}
Stringsuggested
Reasonreason 1

The reason the article is in need of cleanup

Stringoptional
Talk page sectiontalk talksection

The section of the talk page containing relevant discussion

Stringoptional

Параметри TemplateData

Кожен параметр TemplateData подано нижче із описом та прикладом застосування. Вони також перелічені в Extension:TemplateData#Format.

  • Поточна інформація справедлива для лютого 2020 і може змінюватися з розвитком розширення, коли додаються нові параметри чи змінюється інтерфейс вставлення шаблону для підтримки наявних параметрів чи внаслідок зміни їхнього трактування.
  • Вікірозмітка не працює в описі та мітках. Вони суто текстові.
  • New lines ("\n") in descriptions, labels, examples or defaults will not show in any of the main editors (TemplateWizard, VisualEditor or the 2017 wikitext editor), even though they show in the auto-generated TemplateData documentation. They are replaced by a null string in input forms and by a space elsewhere.
Параметр Опис Приклад
description

Параметр "description" описує, що робить шаблон. Він необов'язковий, але настійливо рекомендований.

Вплив

На сторінці документації шаблону цей опис буде показано у вигляді звичайного тексту під заголовком "Дані шаблону для Назва шаблону".

Всі поширені редактори (VisualEditor , Редактор вікі-тексту 2017 , 2010 wikitext editor із TemplateWizard тощо) демонструють цей опис у двох основних місцях:

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

У VisualEditor та редакторі вікітексту 2017 цей опис обмежений 50 символами під кожним знайденим результатом, за чим слідує ..., але в основному вікні редактора шаблонів відображується повний опис. В обох випадках відображення робиться сірим кольором.

У редакторі вікітексту 2010 із TemplateWizard повний опис демонструється під кожним знайденим результатом, сірим кольором. В основному вікні редактора шаблонів відображення робиться звичайним (чорним) кольором, а для довгих описів (більших за 540 символів) відображується смужка прокрутки.

Якщо не вказано

Якщо параметр опису не вказаний чи порожній, натомість буде відображено текст "Опис відсутній" в тих самих місцях, зокрема, нижче підзаголовку "Дані шаблону для назва шаблону". Додатково:

  • у візуальному редакторі та в редакторі вікітексту 2017 це виглядатиме так само, як і для шаблону з відсутнім блоком TemplateData. Замість опису, буде відображено такий текст:
"The "Template:Templatename" template doesn't yet have a description, but there might be some information on the template's page."
  • у редакторі вікітексту 2010 із TemplateWizard натомість відображуватиметься такий текст (всюди, крім переліку результатів пошуку):
"No description exists for this template."
Це відрізняється від опису двома стандартними полями ситуації, коли блоку TemplateData не існує:
  • "Due to missing TemplateData, parameters for this template have been auto-generated. Please be aware that they may not be accurate."
  • "No parameters could be determined for this template due to absence of TemplateData documentation. You may insert the template without parameters."
"description": "Шаблон для посилання на категорію на Вікісховищі за темою статті",
format

Наступним є "format", він описує вигляд, в якому вікі-текст шаблону вставляється в код сторінки. Це може бути один із стандартних форматів "inline" та "block", або користувач може ввести набір символів вікітексту, щоб створити спеціальний формат; ці символи та деякі приклади перелічені у розділі нижче.

Параметр необов'язковий, але рекомендований. Якщо цей параметр не вказано, це еквівалентно внутрішньому форматуванню, тобто за замовчуванням шаблон вставляється в текст як є, відповідна примітка в документації TemplateData під заголовком таблиці не відображується.

Вплив

Внутрішній:

Якщо параметр встановлено в "inline", шаблон покаже відповідну примітку про налаштування у його документації TemplateData, під назвою таблиці, «Параметри шаблону»:

"[circles and pipes icon] This template prefers inline formatting of parameters."

При вставленні шаблону його вікітекст буде вміщено в код сторінки на одному рядку без пропусків між елементами, як-от:

{{Foo|bar=baz|qux=quux}}

Блок:

Якщо параметр встановлено у "block", для шаблону в його документації TemplateData буде відображено таку примітку:

"[stacked blocks and pipes icon] This template prefers block formatting of parameters."

При вставленні параметри шаблону розподіляться по рядках, кожен на новому, з одним пропуском між елементами, як-от:

{{Foo
| bar = baz
| qux = quux
}}

Нестандартне форматування:

Якщо параметр встановлено в особливий рядок вікітексту, згідно з правилами, переліченими в #Нестандартні формати, для шаблону буде відображено таку примітку в його документації TemplateData:

"[cogwheel icon] This template has custom formatting."

При вставленні вікітекст шаблону буде викладено відповідно вказаному рядку спеціального форматування.

"format": "inline"
params

Об'єкт "params" містить інформацію про кожен із параметрів шаблону. Він обов'язковий, його параметри описано в розділі нижче.

Для кожного із параметрів він має містити назву та набір підпараметрів TemplateData, описаний тут.

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

"params": {
    "parameter1": {
        ...    // parameter info
    },      // тут кома
    "parameter2": {
        ...    // parameter info
    },      // і тут теж
    "parameter3": {
        ...    // parameter info
    }       // але не тут
}
paramOrder

Об'єкт "paramOrder" є необов'язковим, він може змусити параметри шаблону подаватися в певному специфічному порядку при додаванні в редакторі шаблону.

Як користуватися

Додається параметр "paramOrder" з двокрапкою, пропуском та відкриваючою квадратною дужкою; далі йде перелік назв параметрів шаблону в потрібному порядку, взятих у лапки й розділених комами. Наприкінці стоїть закриваюча квадратна дужка. Так створюється масив значень.

Кожен із параметрів може бути написаний в новому рядку для виразності, але це необов'язково (можна й так: "paramOrder": ["param1","param2","param3"]).

Рекомендовано вказувати "paramOrder" після "params", саме так, як це робить редактор TemplateData, оскільки цей параметр сам не відображується в документації TemplateData, а лише нав'язує порядок відображення параметрів шаблону. Інколи потрібно лише кинути оком на деталі параметрів та щось змінити, і для цього не хотілося б шукати за "paramOrder", особливо якщо параметрів у шаблону багато. Якщо його все ж таки розміщено в іншому місці, аніж наприкінці блоку TemplateData, впевніться, що його відділено комою від наступного параметру TemplateData.

Список має бути повним, тобто містити назву кожного з параметрів шаблону, що їх описано в блоці TemplateData, інакше отримаємо помилку "Відсутній атрибут".

Якщо не вказано

Якщо "paramOrder" немає чи він з порожнім значенням, параметри шаблону відображуються в тому порядку, в якому їх визначено в коді шаблону. Якщо цей код містить вкладені об'єкти, то першими відображуються параметри зовнішніх об'єктів, потім - внутрішніх.

З іншими параметрами

В редакторі вікітексту 2010 із TemplateWizard, "обов'язкові" параметри завжди відображуються першими, незалежно від порядку, вказаному в "paramOrder", тоді як "рекомендовані" параметри відобразяться після них і перед "optional". "Застарілі" параметри взагалі не будуть відображені в цьому редакторі; див. опис "deprecated" за додатковою інформацією. "paramOrder" лише задає їхній порядок всередині цих категорій, тобто параметри "required" відобразяться в порядку, вказаному в "paramOrder", як і параметри "suggested", але всі параметри "suggested" будуть відображені після параметрів "required".

У візуальному редакторі та редакторі вікітексту 2017 "paramOrder" жорстко задає порядок параметрів незалежно від їхніх категорій.

"paramOrder": [
	"date",
	"reason",
	"talk"
]

Всередині params

Параметр Опис Приклад
parameter name

Єдиним параметром першого рівня в об'єкті params є назва параметру шаблону.

Так, якщо в коді шаблону зустрічається {{{date}}}, це його параметр і його слід додати в "params" під назвою "date".

Також можна зустріти параметри з іменем {{{1}}} (чи іншим числовим), його назвою в блоці TemplateData може бути, приміром, "1". Ці "позиційні" параметри можна задавати при використанні шаблону опускаючи назву та знак рівності (приміром, |value| замість |parametername=value|). Їхні номери потрібні для ідентифікації неназваних параметрів в коді шаблону. Приміром, слід очікувати, що в

{{example template|value1|value2}}

value1 є значенням параметру {{{1}}}, а value2 є значенням параметру {{{2}}}. Опис в блоці TemplateData має це відбивати. Примітка: параметри з числовими назвами необов'язково нумерувати послідовно; так, можна використати {{{2}}} без {{{1}}}, додавши названий параметр "2" при редагуванні коду шаблону та написавши "|2=" при використанні цього шаблону.

Як користуватися

Кожен із цих об'єктів "назва параметру" має містити всю інформацію щодо цього параметру шаблону в формі параметрів блоку TemplateData. Їх перелічено в наступному розділі, Всередині назви параметру.

"1": {     // назва параметру
    ...    // тут іде інформація про параметр
}

Всередині назви параметру

Параметр Опис Приклад
aliases

Параметр "aliases" необов'язковий і корисний тоді, коли один чи кілька параметрів шаблону мають синонімічні назви. Це можна перевірити, пошукавши у коді шаблону запис:

{{{parameter1|{{{parameter2}}}}}}, or {{{parameter1|{{{parameter2|}}}}}}

Це означає, що назви параметра синонімічні, можна застосувати будь-яку для задання його значення. Така конструкція в коді перекладається дослівно так: "Значення parameter1. Якщо parameter1 невизначений чи його значення порожнє, то значення parameter2." У другому випадку далі так: "Якщо parameter2 не вказаний чи має порожнє значення, то порожнє значення."

Аби додати синонімічні назви за допомогою "aliases", додайте текст "aliases", двокрапку, пропуск, ліву квадратну дужку, потім кожен синонім назви в лапках, розділені комами. Зрештою, закрийте праву скобку. Так створюється масив значень.

"aliases": ["1", "talk", "talksection"],
inherits

Необов'язковий параметр "inherits" застосовується, коли опис параметра має наслідувати (повторювати) опис іншого параметра в TemplateData. Повторювані поля можна перевизначити, як при наслідуванні в мовах програмування.

Аби застосувати цей параметр, напишіть "inherits" :, потім назву іншого параметра в лапках, як-от "talk" чи "1". Нижче можна перевизначити якісь із наслідуваних полів, приміром, "label" : "A different label". Так третій параметр наслідує всі властивості першого, крім цієї, мітки.

    "params": {
        "тема1": {
            "label": "Тема",
            "description": "Тема, що згадується на цій сторінці неоднозначності",
            "type": "string"
        },
        "тема2": {
            "inherits": "тема1"
        },
        "тема3": {
            "inherits": "тема1",
            "label" : "A different label"
        }
    }
label

Параметр TemplateData "label" містить короткий текстовий опис параметра шаблону, цей опис відображуватиметься в редакторі шаблонів. Він відобразиться на місці назви параметра з вікі-коду. Це необов'язковий, але настійливо рекомендований параметр.

"label": "Місяць та рік",
description

Тут "description" — це опис параметра, а не всього шаблону. Цей опис відображується як підказка, коли користувач наводить покажчик на символ "i" біля параметра шаблону в редакторі шаблонів. Він необов'язковий, але настійливо рекомендований.

"description": "Місяць і рік, коли цей шаблон було додано до бази.",
type

See the #Type parameter section.

default

Інколи для параметра шаблону код містить значення за замовчуванням, яке застосовується, якщо користувач не вказав значення цього параметра при застосуванні шаблону. Параметр TemplateData "default" призначений для того, щоб відображувати це значення за замовчуванням; він необов'язковий. Його значення не перевіряється на збіг зі справжнім значенням за замовчуванням і не має функціонального ефекту. Ви можете проігнорувати заповнення цього параметра, якщо стандартне значення для нього відсутнє.

Вплив

У всіх основних редакторах (візуальний редактор, редактор вікітексту 2017 та редактор вікітексту 2010 із TemplateWizard) текст "default" відображується сірим в полі вводу порожнього відкритого параметра в форматі "Default: default text". До того ж воно відображуватиметься звичайним текстом в описі параметра шаблона, коли користувач наведе покажчик на символ "i". У візуальному редакторі та редакторі вікітексту 2017 воно буде відображено під описом параметра, нижче "Поле обов'язкове"/"Поле застаріле", якщо вказано (редактор вікітексту 2010 не відображує) і вище "приклад", якщо вказано (редактор вікітексту 2010 не відображує "приклад" в описі параметра). В редакторі вікітексту 2010 із TemplateWizard текст "default" відображується безпосередньо після опису параметра, на тому самому рядку після пропуска. Формат відображення такий самий, як і в інших редакторах: "Default: default text".

З іншими параметрами

У всіх основних редакторах (візуальний редактор, редактор вікітексту 2017 та редактор вікітексту 2010 із TemplateWizard), якщо вказано "default", значення поля "example" не буде відображене у вікні вводу.

"default": "Category:CommonsRoot",
autovalue

Ви можете задати «автозначення» для певного параметра. Коли користувачі додаватимуть шаблон на сторінку, це значення буде заповнюватись автоматично. Наприклад, чимало шаблонів упорядкування потребують додавання дати; якщо ж Ви встановите автозначення для параметра дати {{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}, тоді дата встановлення заповнюватиметься автоматично.

Параметр не змушує параметр шаблона завжди мати саме таке значення. Це лише автоматична підказка в полі вводу, яку користувач може змінити.

З іншими параметрами

У всіх основних редакторах (візуальний редактор, редактор вікітексту 2017 та редактор вікітексту 2010 із TemplateWizard) "autovalue" перекриває видимий вплив параметра TemplateData "url". Див. опис "type" за додатковою інформацією.

"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
example

Параметр TemplateData "example" необов'язковий і призначений для надання прикладу вказівки цього параметра шаблону при застосуванні шаблону.

Вплив

У всіх основних редакторах (візуальний редактор, редактор вікітексту 2017 та редактор вікітексту 2010 із TemplateWizard) це значення відображується в полі вводу будь-якого параметру (якщо його значення наразі порожнє) в форматі "приклад текст зразку". У візуальному редакторі і редакторі вікітексту 2017 воно додатково відображується звичайним текстом під описом параметра (і під значенням "default", якщо воно задане).

З іншими параметрами

У всіх основних редакторах (візуальний редактор, редактор вікітексту 2017 та редактор вікітексту 2010 із TemplateWizard), значення "example" не буде відображене у вікні вводу, якщо вказано "default".

"example": "January 2013",
required

Також у нас є "required", котрому можна надати значення або true, або false. За замовчуванням прийнято значення false.

Воно вказує, чи буде заповнення параметра обов'язковим при використанні шаблону.

Вплив

Статус обов'язкового параметра впливає на візуальний редактор та Редактор вікі-тексту 2017 в такий спосіб:

  • параметр автоматично показується при використанні шаблону;
  • біля мітки параметра ставиться сіра зірочка;
  • в правій частині поля вводу ставиться сіра зірочка;
  • під описом параметра курсивом відображується текст "Це поле обов'язкове";
  • поле вводу набуває червоного кольору, якщо користувач прибирає звідти покажчик, не заповнивши значення;
  • якщо користувач намагається використати шаблон без визначення такого параметра, відображується вікно з вимогою підтвердження. При отриманні підтвердження параметр буде вказано із порожнім значенням. В такому разі редактор, тим не менше, вставить шаблон без відображення помилок (хоча сам шаблон може бути запрограмований видати помилку в такій ситуації).

2010 wikitext editor із TemplateWizard, як і інші редактори, так само автоматично при використанні шаблону відображує такий параметр, але його неможливо прибрати. Він також пише "Це поле обов'язкове" в описі параметра, а натомість відображає назву параметра збоку під заголовком "Обов'язкові параметри". В усіма іншому він спрацьовує так само, як і два інших редактори, за винятком того, що попередження пише про "ввод не відповідає очікуваному формату".

З іншими параметрами

У візуальному редакторі та редакторі вікітексту 2017 статус "застарілий" не блокує функціональності параметра, але в редакторі вікітексту 2010 із TemplateWizard блокує її. Див. опис "deprecated" за додатковою інформацією.

"required": true
suggested

Статус "suggested" можна встановити або в true, або в false. За замовчуванням він встановлений у false.

Це — статус для параметрів, які не є «обов'язковими», але їх використання рекомендоване (але не необхідне) через значну цінність для користувачів шаблонів.

Вплив

У візуальному редакторі та Редактор вікі-тексту 2017 цей статус автоматично відображує параметр, коли користувач застосовує шаблон. Якщо для параметра вказано "автозначення", воно також автоматично відобразиться у полі вводу. Інших ефектів немає, як і додаткового тексту чи вікон попереджень.

2010 wikitext editor із TemplateWizard параметр не відображується автоматично при використанні шаблону, але його назва потрапляє збоку в перелік під заголовком "Пропоновані параметри". Далі користувач може натиснути символ "+" поряд з назвою параметра, аби додати його до використання шаблону.

З іншими параметрами

Статус "required" перекриває цей статус в усіх основних редакторах (візуальний, редактор вікітексту 2017 та 2010). Так само він перекривається в документації TemplateData (буде відображено "обов'язковий", якщо обидва "required" та "suggested" встановлені у true).

"suggested": true
deprecated

Нарешті, наявний "deprecated", який можна встановити у true, false чи рядок, який описує, що користувач повинен натомість зробити. За замовчуванням прийнято значення false.

Це статус параметрів, які більше не повинні використовуватися, але поки що існують. Таке трапляється, коли редагуванням шаблону змінюють набір його параметрів.

Вплив

Візуальний редактор та редактор вікітексту 2017 під впливом цього параметра відображують сірий знак оклику біля назви параметра шаблону при його вставленні, а в підказці під його описом відображують сірим курсивом текст "Це поле застаріло". На функціональність і застосовність параметра шаблону це не впливає, як і не веде до відображення додаткових попереджень.

Попри той факт, що цей параметр блоку TemplateData може набувати текстового значення, з січня 2020 р. жоден із основних редакторів (візуальний, редактор вікітексту 2017 та 2010) не відображує користувачу цього тексту. Введений текст дає той самий ефект, що й значення true.

Редактор вікітексту 2010 із TemplateWizard не дозволяє бачити чи додавати параметр шаблону, для якого "deprecated" встановлено в true.

З іншими параметрами

Якщо разом із цим встановити в true параметр "suggested", статус параметра шаблону відображуватиметься як "застарілий" в документації TemplateData, але в іншому обидва редактори, візуальний та редактор вікітексту 2017, збережуть і ту, й ту функціональність; параметр буде згенеровано при додаванні шаблону, але він буде позначений статусом "застарілий".

Якщо встановити разом із цим у true параметр "required", статус параметра шаблону відображуватиметься в документації TemplateData як "застарілий", але в редакторах візуальному та вікітексту 2017 функціональність відповідатиме статусу "обов'язковий", тобто параметр шаблону додаватиметься автоматично при вставленні шаблону і матиме примітку "обов'язковий". Це справедливо також, якщо всі три "deprecated", "suggested" та "required" встановити у true.

В редакторі вікітексту 2010 із TemplateWizard, навпаки, "deprecated" перекриває статуси "required" чи "suggested".

"deprecated": "Натомість використовуйте, будь ласка, «publicationDate»."
suggested values

Атрибут suggestedvalues параметра шаблону дозволяє визначити наперед набір значень, які візуальний редактор надаватиме для швидкого обрання. Це можна зробити як вручну з JSON, так і в редакторі TemplateData. Є можливість надати такий перелік значень для параметрів шаблону, які мають один із наступних типів:

  • content
  • line
  • string
  • number
  • unknown
  • unbalanced wikitext.

Інші типи (file, page, template, user, date, boolean, URL) наразі не підтримуються, оскільки вони мають особливу функціональність у візуальному редакторі, як-от автозаповнення, яке створить колізію із випадаючим меню із запропонованими значеннями.

Редагування даних TemplateData як JSON у вікітексті

Аби додати перелік запропонованих значень для параметра шаблону, додайте новий атрибут "suggestedvalues" в JSON. Значенням атрибуту “suggestedvalues” має бути перелік рядків (ланцюжків).

Editing TemplateData with the TemplateData Editor

  1. Натисніть "Редагувати TemplateData".
  2. Натисніть назву параметра шаблону, до якого слід додати перелік значень.
  3. Якщо цього ще не було зроблено, встановіть тип параметра в один із таких: content, line, string, number, unknown або unbalanced wikitext.З'явиться нове поле вводу "Запропоновані значення". Якщо параметр уже має один із таких типів, поле вводу має бути видимим одразу.
  4. Введіть запропоноване значення включно із пропусками та спеціальними символами, потім натисніть ввод для додавання значення до переліку.

Effects

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

	"suggestedvalues": [
		"Journal",
		"Book",
		"Newspaper",
		"Magazine"
	]

Примітка: якщо жоден із атрибутів "required", "suggested" чи "deprecated" для параметра шаблону не встановлений, його статус в документації TemplateData відповідатиме "optional" (необов'язковий).

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

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

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

Параметр type

Параметр блоку TemplateData "type" дає інформацію редактору шаблонів щодо природи значення параметра шаблону. В деяких випадках редактор шаблону отримує інструкції модифікувати користувацький інтерфейс відповідно до цієї природи, зокрема, дозволяти користувачу вводити лише значення, що відповідають вказаному типу. Цей параметр не справляє функціонального ефекту на параметр шаблону чи його значення, він керує лише відображенням параметра шаблону в редакторі шаблонів.

Як користуватися

Додати параметр "type", за яким двокрапку, пропуск та будь-який із типів, вказаний у першому стовпчику таблиці нижче.

Приклад:

"type": "string",

Вплив

З лютого 2020 р. лише 5 із 13 типів впливають на інтерфейс візуального редактора та редактора вікітексту 2017, а в TemplateWizard таких типів 8.

Вплив певних типів напевне змінюватиметься, коли редактори шаблонів отримуватимуть оновлення для їхньої підтримки. Один із таких проєктів для візуального редактора та редактора вікітексту 2017 відслідковується в задачі Phabricator T55613. Подібний проєкт підтримки логічного типу в TemplateWizard відслідковується в T200664.

Нижче перелічено актуальні ефекти.

Value Description
unknown

Значення "unknown" відповідає типу за замовчуванням. Але його можна і вказати безпосередньо: "type": "unknown".

Вплив

Тип "unknown" не дає зовнішніх ефектів у всіх основних редакторах (візуальний редактор, редактор вікітексту 2017 та редактор вікітексту 2010 із TemplateWizard).

number

Значення "number" призначене для числових значень параметра шаблону, включно із від'ємними числами та десятковими дробами.

Вплив

  • У візуальному редакторі та редакторі вікітексту 2017 "number" не справляє впливу.
  • В редакторі вікітексту 2010 із TemplateWizard "number" відображує кнопки "+" та "-" обабіч поля вводу, яким можна збільшувати чи зменшувати числове значення, а в полі вводу можна ввести лише число. Кнопкою також можна зменшити число до від'ємного.

З іншими параметрами

  • В редакторі вікітексту 2010 "number" перекриває вплив "autovalue"; значення "autovalue" не буде автоматично вміщено до поля вводу, якщо параметр шаблону має тип "number".
string

Значення "string" описує будь-який рядок звичайного тексту.

Вплив

У всіх основних редакторах (візуальний редактор, редактор вікітексту 2017 та редактор вікітексту 2010 із TemplateWizard) "string" не справляє впливу і працює як "unknown".

line

Значення "line" описує вміст, який повинен займати лише один рядок.

Вплив

  • У візуальному редакторі та редакторі вікітексту 2017 "line" не дозволяє більше одного рядка в полі вводу.
  • В редакторі вікітексту 2010 із TemplateWizard "line" не справляє впливу, оскільки в ньому поля вводу не дозволяють ввести більше одного рядка.
boolean

Тип "boolean" описує параметр, який може набувати значень true, false чи невизначеного. Це згідно з документацією буде представлено відповідно "1", "0" чи порожнім значенням.

Вплив

З лютого 2020 р. жоден із основних редакторів (візуальний, редактори вікітексту 2017 та 2010 із TemplateWizard) не використовує це значення, тобто не дає видимих ефектів.

Із autovalue:0 візуальний редактор відображує w:uk:прапорець, який можна ввімкнути чи вимкнути.

date

Тип "date" призначений для відображення дати YYYY-MM-DD в форматі ISO 8601, приміром, 2014-05-22. Документація TemplateData стверджує, що він також придатний для комбінації дати й часу за ISO 8601, як-от 2014-05-22T16:01:12Z, але на практиці жоден із основних редакторів з лютого 2020 не використовує його в такий спосіб, тому майже на всіх вікі дата й час як параметри шаблону записані окремо.

Вплив

  • У візуальному редакторі та редакторі вікітексту 2017 тип "date" не справляє впливу.
  • В редакторі вікітексту 2010 із TemplateWizard "date" зменшує на третину ширину відповідного поля вводу та додає спадне меню-календар, що дозволяє користувачу обрати дату. В полі вводу спочатку вміщується сірим текст прикладу "YYYY-MM-DD". Якщо ввод користувача не відповідає цій схемі, поле вводу червоніє, а редактор завжди зберігає дату в стандартному форматі (якщо її введено правильно) або нічого (якщо поле залишено порожнім чи із помилковим вводом).

З іншими параметрами

  • В редакторі вікітексту 2010 із TemplateWizard "date" перекриває вплив "автозначення", значення "autovalue" не буде вміщено в поле вводу параметра шаблону типу "date".
url

Значення "url" описує URL, включно з протоколом, як-от https:// чи "//".

Вплив

  • У візуальному редакторі та редакторі вікітексту 2017 "url" відображує ліворуч від поля вводу позначку зовнішнього посилання (квадрат зі стрілкою назовні) і забарвлює поле червоним, якщо користувач прибирає звідти покажчик, не вставивши адреси URL із префіксом-протоколом. Другий ефект подібний до того, що відбувається для required, але користувачу не видається попередження при вставленні шаблону без URL. Це також має місце за будь-якого статусу (як-от "suggested"" чи "deprecated").
  • В редакторі вікітексту 2010 із TemplateWizard "url" не дає зовнішнього ефекту.

З іншими параметрами

  • У візуальному редакторі та редакторі вікітексту 2017 "autovalue" перекриває вплив "url": якщо виставлено обидва, поле вводу не міститиме піктограми URL і не вимагатиме введення URL.
wiki-page-name

Тип "wiki-page-name" позначає назву сторінки вікі.

Вплив

У всіх основних редакторах (візуальний, редактор вікітексту 2017 та 2010 із TemplateWizard) "wiki-page-name" відображує поле вводу зі спадним меню назв сторінок, з якого можна обрати необхідну. Простори назв теж можуть бути визначені. До того ж, у візуальному редакторі та редакторі вікітексту 2017 вміст поля вводу утримується в межах одного рядка. Редактори не запобігають введенню назви неіснуючої сторінки.

wiki-file-name

Тип "wiki-file-name" описує назву файла, розміщеного або в локальній вікі, або на Вікісховищі.

Вплив

  • У візуальному редакторі та редакторі вікітексту 2017 "wiki-file-name" не справляє зовнішнього впливу.
  • В редакторі вікітексту 2010 із TemplateWizard "wiki-file-name" додає до поля вводу спадне меню з переліком назв файлів, розміщених як локально, так і на Вікісховищі, з якого можна обрати потрібну. The file names do not contain the "File:" namespace prefix. Це спадне меню також містить ескізи файлів. Редактори не запобігають введенню назви неіснуючого файла.
wiki-template-name

Тип "wiki-template-name" визначає назву шаблона.

Вплив

У всіх основних редакторах (візуальний, редактор вікітексту 2017 та 2010 із TemplateWizard) "wiki-template-name" відображує поле вводу зі спадним меню з переліком назв шаблонів, з якого можна обрати необхідну. До того ж, візуальний редактор та редактор вікітексту 2017 обмежують поле вводу єдиним рядком. Редактори не запобігають введенню назви неіснуючого шаблону.

wiki-user-name

Тип "wiki-user-name" описує ім'я користувача вікі.

Вплив

У всіх основних редакторах (візуальний, редактор вікітексту 2017 та 2010 із TemplateWizard) "wiki-user-name" відображує поле вводу зі спадним меню з переліком актуальних імен користувачів, з якого можна обрати необхідне. До того ж, візуальний редактор та редактор вікітексту 2017 обмежують поле вводу єдиним рядком. Редактори не запобігають введенню імені неіснуючого користувача.

content

Тип "content" описує фрагмент вікітексту сторінки, приміром, посилання, зображення чи текст із форматуванням.

Вплив

  • У візуальному редакторі та редакторі вікітексту 2017 "content" не справляє зовнішнього впливу.
  • В редакторі вікітексту 2010 із TemplateWizard "content" додає один рядок до вікна вводу й дозволяє переходи на нові рядки, на відміну від звичайних полів для вводу цього редактора.
unbalanced-wikitext

Тип "unbalanced-wikitext" описує частковий фрагмент вікітексту, тобто такий, в якому відсутній початковий чи кінцевий теги або який містить посилання на іншу частину вікітексту.

Вплив

  • У візуальному редакторі та редакторі вікітексту 2017 "unbalanced-wikitext" не справляє зовнішнього впливу.
  • В редакторі вікітексту 2010 із TemplateWizard "unbalanced-wikitext" додає один рядок до вікна вводу й дозволяє переходи на нові рядки, на відміну від звичайних полів для вводу цього редактора.

Спеціальні формати

Редагуванням значення "format" можна створити спеціальні формати, якщо ввести набір символів вікітексту, дотримуючись певних наперед заданих правил.

  • {{ - початок шаблону
  • _ - вміст (рядок, ціле число, параметр тощо). Символ підкреслювання визначає найменшу довжину значення в символах, його можна повторювати, як-от у _______. Якщо користувач не вичерпав усю довжину, значення буде доповнено пропусками. Це можна застосувати, приміром, для вирівнювання всіх знаків рівності після параметрів на певній позиції (якщо застосовано із \n як позначкою нового рядка).
  • | - вертикальна риска (розділює параметри)
  • = - знак рівності (передує значенню параметра)
  • \n або натискання кнопки вводу - новий рядок (відобразить у полі вводу)
  • - пропуск (може застосовуватися із \n для формування відступу рядків)
  • }} - кінець шаблону

Вікітекст має щонайменше задовольняти мінімуму {{_|_=_}}, інакше буде видано помилку форматного рядку.

Приклади форматів, які ви можете використовувати
Мета Рядок формату Виведення
Рядкове форматування {{_|_=_}}
inline
{{Foo|bar=baz|qux=quux}}{{Bar}}
Блокове форматування {{_\n| _ = _\n}}
block
{{Foo
| bar = baz
| qux = quux
}}{{Bar
}}
Без пропуску перед іменем параметру,

кожен шаблон на своєму власному рядку

\n{{_\n|_ = _\n}}\n
{{Foo
|bar = baz
|qux = quux
}}
{{Bar
}}
Відступ кожного параметру {{_\n |_ = _\n}}
{{Foo
 |bar = baz
 |qux = quux
}}{{Bar
}}
Вирівнювати всі імена параметрів до даної довжини {{_\n|_______________ = _\n}}\n
{{Foo
|bar             = baz
|qux             = quux
|veryverylongparameter = bat
}}
{{Bar
}}
Pipe-символи наприкінці попереднього рядка {{_|\n _______________ = _}}
{{Foo|
  bar             = baz|
  qux             = quux}}{{Bar}}
Рядковий стиль із більшою кількість пропусків, повинен бути на початку рядка \n{{_ | _ = _}}
{{Foo | bar = baz | qux = quux}}
{{Bar }}
Шаблон на початку рядка, вирівняні відступи параметрів, вертикальна риска завчасно \n{{_ |\n _______________ = _}}
{{Foo |
  bar             = baz |
  qux             = quux}}
{{Bar}}

Порожня заготовка

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

<templatedata>
{
    "description": "",
    "params": {
        "1": {
            "label": "",
            "description": "",
            "type": ""
        },
        "2": {
            "label": "",
            "description": "",
            "type": ""
        }
    }
}
</templatedata>

Помилки

Синтаксичні помилки в JSON / Неправильний формат JSON

Ця помилка виникає в разі спроби запису блоку TemplateData, який містить помилки в коді JSON, як-от дублікатні ключі (параметри) або надлишкові чи відсутні коми, із візуального редактора чи з редактора вікітексту 2017 (тобто редакторів на JavaScript).

"Синтаксична помилка в JSON" виникає при спробі записати такий код із візуального чи редактора вікітексту 2017, а "Неправильний формат JSON" - при спробі відкрити подібний код у графічному редакторі TemplateData зі сторінки шаблону.

Ця помилка може зустрічатися часто при редагуванні блоку TemplateData. Найпоширенішою причиною її може бути надлишкова кома (після останнього блоку перед правою скобкою), відсутня кома (між параметрами всередині блоку) та відсутні лапки.

Приклади зайвої коми:
<templatedata>
{
    "description": "",
    "format": "inline",
    "params": {
        "1": {
            "label": "",
            "description": "",
            "type": "", // <-- This comma shouldn't be here.
        }, // <-- This comma shouldn't be here.
    }, // <-- This comma shouldn't be here.
}
</templatedata>
Приклади пропущеної коми:
<templatedata>
{
    "description": "",
    "format": "inline" // <-- A comma should be here.
    "params": {
        "1": {
            "label": "",
            "description": "" // <-- A comma should be here.
            "type": ""
        }
    }
}
</templatedata>
Приклади пропущених лапок:
"description": An example description // <-- This text should have quotation marks.

Щоб знайти такі помилки, слід поглянути в код JSON або виконати перевірку блоку JSON зовнішнім валідатором, таким як JSONLint, який підсвітить всі проблемні фрагменти.

Внаслідок довготривалої помилки користувачі редактора вікітексту 2010 можуть записати неправильний JSON (подробиці: task T128029), оскільки парсер JavaScript менш прискіпливий і дозволяє неправильний JSON.

Обов'язковий атрибут "paramOrder(номер)" не знайдено.

Ця помилка виникає, коли певний параметр введено в "params", але він відсутній в "paramOrder". Число в квадратних дужках посилається на параметр із "paramOrder", відсутній в подальшому. Це порядковий номер, нумерація починається з 0, тобто перший параметр має номер 0, другий - 1 тощо.

"params": {
    "date": { ...
    },
    "reason": { ...
    },
    "talk": { ... // <-- This parameter is not stated in "paramOrder", but it should be.
    }
},
"paramOrder": [
	"date",
	"reason"
]

// Error: Required property "paramOrder[2]" not found.

Для усунення помилки упевніться, що всі параметри, визначені в "params", також зібрані в "paramOrder". Або ж ви можете взагалі прибрати об'єкт "paramOrder" із блоку TemplateData.

Неправильне значення атрибуту "paramOrder(номер)".

Ця помилка виникає, коли певний параметр введено в "paramOrder", але він відсутній в "params". Число в квадратних дужках посилається на параметр у "paramOrder", якого там не має бути. Це порядковий номер, нумерація починається з 0, тобто перший параметр має номер 0, другий - 1 тощо.

"params": {
    "date": { ...
    },
    "talk": { ...
    }
},
"paramOrder": [
	"date",
	"reason", // <-- This parameter is not stated in "params", but it should be.
    "talk"
]

// Error: Invalid value for property "paramOrder[1]".

Для усунення помилки упевніться, що всі параметри, визначені в "paramOrder", також зібрані в "params". Або ж ви можете взагалі прибрати об'єкт "paramOrder" із блоку TemplateData.

Атрибут "params.parametername.required" повинен мати тип "boolean".

Ця помилка виникає, якщо взяти в лапки значення параметрів "required" або "suggested".

"suggested": "true" // <-- These quotation marks shouldn't be here.

Оскільки це логічні змінні, а не рядки, лапки для них зайві. Аби усунути цю помилку, приберіть всі лапки навколо значень true чи false цих параметрів.

Атрибут "format" очікується як ...

Якщо параметр "format" вказаний зі значенням, відмінним від "inline", "block" чи коректного рядка форматування, виникне помилка "Атрибут "format" очікується як "inline", "block" чи правильний форматний рядок."

"format": "notinline"

// Error : Property "format" is expected to be "inline", "block", or a valid format string.

Аби усунути помилку, перевірте, що значення після "format": дорівнює "inline" чи "block" і що в ньому немає помилок написання. Або ж, якщо робота з вікітекстом, перевірте, що він містить якнайменше {{_|_=_}} і не містить синтаксичних помилок, які зазвичай не дозволять обробити код шаблону, як-от подвійні знаки рівності чи зайві/відсутні фігурні дужки" див. розділ #Нестандартні формати за подробицями синтаксису. Або ж ви можете взагалі прибрати параметр "format", щоб усунути цю помилку.

Неочікуваний атрибут "parametername".

Ця помилка виникає, якщо створити неприпустимий параметр блоку TemplateData. Радше за все це помилка друку.

<templatedata>
{
    "description": "",
    "format": "inline",
    "params": {
        "1": {
            "label": "",
            "descriptino": "", // <-- spelling mistake
            "type": ""
        }
    }
}
</templatedata>

Вона також трапляється, якщо записати параметр одного блоку з TemplateData в інший його блок. Це також може бути спричинено помилкою друку (розстановка дужок).

Приміром, можна було помилково записати параметр "label" в кореневому блоці об'єкту TemplateData замість всередині "params":

<templatedata>
{
    "description": "",
    "format": "inline",
    "label": "", // <-- incorrectly placed parameter
    "params": {
        "1": { // ↓ it should be in here
            "description": "",
            "type": ""
        }
    }
}
</templatedata>

Або ж, якщо неочікуваний параметр знаходиться всередині параметра parametername шаблону "params", в описі помилки ви побачите його назву як "params.parametername."

Аби усунути помилку, перевірте, що всі назви параметрів написано правильно, а також що всі параметри записано у відповідному блоці. Ще перевірте, що ви не додали неіснуючий в об'єкті TemplateData параметр. Можна перевірити, які параметри відомі для певного об'єкту, в розділі #Параметри TemplateData.

Обов'язковий атрибут "params" не знайдено.

Ця помилка виникає, якщо в блоці TemplateData відсутній об'єкт "params". Це обов'язковий об'єкт, оскільки він містить всю інформацію про кожен із параметрів шаблону, тож виправте цю помилку, перевіривши, що він доданий без синтаксичних помилок. Див. вище інструкцію з додавання параметра "params".

Обмеження і запитання

  • Відсутні функції – TemplateData є, значною мірою, прикладом інструмента, який було випущено з небагатьма функціями в надії, що користувачі допоможуть спрямувати розвиток функцій у бажане для них русло. Якщо Ви хочете подати запит на нові функції TemplateData, будь ласка, дайте нам знати.
  • Затримки у відображенні в шаблонах – Після додавання TemplateData до шаблону, метадані повинні бути видимі миттєво, як тільки шаблон буде відкрито у Візуальному редакторі. Однак існує ймовірність, що оновлення метаданих займе більше часу — навіть до кількох годин. Ви можете пришвидшити оновлення, виконавши нульове редагування сторінки самого шаблону (але не сторінки документації). Для виконання нульового редагування відкрийте сторінку шаблону для редагування, та збережіть її без внесення будь-якої зміни і без додавання будь-якого опису редагування.
  • Поточні проблеми – Список поточних баґів та запитів на функції можна переглянути на баґтрекері Вікімедіа.

Інші інструменти

Help:Extension:TemplateWizard
Діалогове вікно панелі інструментів для введення вікі-тексту шаблону через форму, що будується з TemplateData.
TemplateData Wizard
Інструмент, що генерує TemplateData через інтерактивний інтерфейс.
Skeleton TemplateData generator
Інструмент, що зчитує вихідний код шаблона, намагається відшукати усі параметри, що в ньому використовуються, та продукує макет TemplateData із вже занесеними до нього параметрами.
JSONLint
Інструмент, що дозволяє перевірити написаний вручну код JSON, відшукуючи помилки у синтаксисі.