Цей шаблон використовує деякі надзвичайно складні й езотеричні властивості мови визначення шаблонів.
Будь ласка, не намагайтеся змінювати його доти, поки ви:
не зрозумієте до кінця, як він побудований;
не будете готові до усунення будь-яких наслідків у разі неочікуваного результату.
Цей шаблон використовується на 18 000+ сторінках і його зміни будуть дуже помітними. Будь ласка, перевіряйте будь-які зміни на підсторінках /пісочниці та /тестів цього шаблону, або у вашому особистому просторі, та зважайте на обговорення змін на сторінці обговорення перед їхнім впровадженням.
Шаблон {{документація}} використовується для вмісту документальної інформації та інструкцій конкретних шаблонів, зазвичай з підсторінки /документація. Він також може бути сконфігурований для підвантаження контенту з інших сторінок, або безпосередньо з тексту.
Цей шаблон складається з двох частин: великого «контейнера документації» з документацією всередині з вбудованою панеллю інструментів (посилання [перегляд][редагувати][історія][очистити кеш]), та меншого «контейнера посилань», який показує метадані щодо документації разом із посиланнями пісочниць й тестів[en].
Використання шаблонів дозволяє їм бути захищеними, де це потрібно, одночасно дозволяючи будь-кому редагувати документацію та категорії.
Основний синтаксис
Зазвичай, шаблон використовується без параметрів та розташовується всередині <noinclude>...</noinclude> внизу сторінки шаблона (задля подробиць див. #Розміщення та теги):
<!--Останній рядок коду вашого шаблона--><noinclude>{{документація}}<!-- Додавайте категорії на підсторінку /документація --></noinclude>
Включення іншої сторінки
Для включення сторінки відмінної від підсторінки /документація, просто введіть |1= наступним чином:
При використанні цього параметра панель інструментів не відображатиметься. Зауважте, що підсторінка /документація у полі посилання все одно відображатиметься, якщо вона існує.
Також зауважте, що коли визначені |1= та |content=, |content= має пріоритет і завжди відображається у контейнері документації.
Розширений синтаксис
Налаштування заголовка
Заголовок у полі документації змінюється залежно від простору назв. Перегляньте наведений нижче перелік тексту за замовчуванням у кожному просторі назв:
Простір шаблонів: Документація шаблону
Простір модулів: Документація модуля
Інші простори назв: Документація
Щоб налаштувати заголовок, просто встановіть параметр |heading= до будь чого, наприклад |heading=Документація картки.
Зауважте, якщо параметр заголовка порожній, але визначений (як |heading=) заголовок поруч із панеллю інструментів не відображатиметься.
Параметром |heading-style= можна вказати за бажанням значення CSS, як |heading-style=font-size:150%;color:red;. Зауважте, що ви повинні опускати лапки " " і додавати кінцеву крапку з комою ;.
Налаштування вікна посилання
Щоб налаштувати поле посилання, просто встановіть |link box= до іншого значення, like |link box=Наведена вище документація автоматично створюється з Шаблон:Foo.
Щоб приховати поле посилання, просто встановіть |link box= до off.
Тестування
Ви можете змоделювати вихід для певної сторінки за допомогою параметра |page=. Наприклад, якщо ви використовуєте код |page=Шаблон:Edit protected, шаблон поводитиметься так само, як якщо б він був на сторінці Шаблон:Edit protected, в тому числі показ документації з Шаблон:Edit protected/документація, посилаюченої до Шаблон:Edit protected/пісочниця, і т. д. Цей параметр корисний для тестування та широко використовується на сторінці тестів модуля.
Наступний код слід додати внизу кодової сторінки шаблону без пробілу перед ним <noinclude> (що призводить до появи додаткових пробілів на сторінках, де включено шаблон):
<!--Останній рядок коду вашого шаблона--><noinclude>{{документація}}<!-- Додавайте категорії на підсторінку /документація --></noinclude>
Щоб автоматично вставити наведений вище текст, ви також можете скористатися підстановкою скорочення коду {{subst:doc-code}}.
Якщо сторінка документації не існує, панель інструментів замінюється на посилання [створити]. Воно автоматично створює сторінку з передзавантаженим текстом з базовим синтаксисом документації. Предзавантажений текст також використовується для посилань [створити] на підсторінках /пісочниця та /тести.
У просторі MediaWiki, оскільки <noinclude> часто не працює у системних повідомленнях, та оскільки простір MediaWiki потрібно тримати чистим задля продуктивності.
Коли розташований на сторінці обговорення, цей шаблон зазвичай розташовується біля початку сторінки та без тегів <noinclude>...</noinclude>.
Сторінки /документація, /пісочниця та /тести зазвичай повинні розташовуватися у предметному просторі, за виключенням коли простір назв не має активованої властивості підсторінки MediaWiki: Основний, Файл, та MediaWiki. (Категорії можуть мати підсторінки, але документація створюється в просторі обговорення Категорій задля уникнення створення порожніх категорій. Також є багато інших технічних причин, чому сторінка /документація повинна зберігатися під сторінкою обговорення для цих (але не тільки) просторів назв.
Цей шаблон автоматично пов'язує його посилання [створити] для /документація, /пісочниця та /тести до відповідного простору назв.
Повний синтаксис
{{документація}}
або
{{документація| [шлях до сторінки документації]
}}{{документація| content =}}
або
{{документація| [шлях до сторінки документації]
| heading-style =| heading =| link box =}}
або
{{документація| [шлях до сторінки документації]
| content =| heading-style =| heading =| link box =| page =}}
Як пропозицію, тут подано кольори для navbox-ів призначених тільки для сторінок документації.
Вони дотримуються затінення звичайного синього кольору navbox-а:
Документація шаблону[перегляд] [редагувати] [історія] [очистити кеш]
