Шаблон:Документація

Документація шаблону]

Не плутати з Шаблон:Підсторінка документації.

Цей шаблон використовує деякі надзвичайно складні й езотеричні властивості мови визначення шаблонів. Будь ласка, не намагайтеся змінювати його доти, поки ви: не зрозумієте до кінця, як він побудований; не будете готові до усунення будь-яких наслідків у разі неочікуваного результату. Усі експерименти повинні проводитися у вашому персональному просторі чи в пісочниці шаблонів.

• {{Documentation}}
• {{Doc}}

Цей шаблон не повинен бути підставленим.

Шаблон {{документація}} використовується для вмісту документальної інформації та інструкцій конкретних шаблонів, зазвичай з підсторінки /документація. Він також може бути сконфігурований для підвантаження контенту з інших сторінок, або безпосередньо з тексту.

Задля детальної інформації щодо того як і коли його використовувати, див. Вікіпедія:Документація шаблонів (скор.: ВП:ДОК).

Цей шаблон складається з двох частин: великого «контейнера документації» з документацією всередині з вбудованою панеллю інструментів (посилання [перегляд][редагувати][історія][очистити кеш]), та меншого «контейнера посилань», який показує метадані щодо документації разом із посиланнями пісочниць й тестів^[en].

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

Основний синтаксис

Зазвичай, шаблон використовується без параметрів та розташовується всередині <noinclude>...</noinclude> внизу сторінки шаблона (задля подробиць див. #Розміщення та теги):

<!--Останній рядок коду вашого шаблона--><noinclude>{{документація}}<!-- Додавайте категорії на підсторінку /документація --></noinclude>

Включення іншої сторінки

Для включення сторінки відмінної від підсторінки /документація, просто введіть |1= наступним чином:

<!--Останній рядок коду вашого шаблона--><noinclude>{{документація|Шаблон:Інша сторіка/документація}}</noinclude>

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

Використання параметра |content=

Також документація може бути внесена безпосередньо текстом, з використанням параметра |content=:

<!--Останній рядок коду вашого шаблона--><noinclude>{{документація | content =<!-- документація шаблона -->}}</noinclude>

При використанні цього параметра панель інструментів не відображатиметься. Зауважте, що підсторінка /документація у полі посилання все одно відображатиметься, якщо вона існує.

Також зауважте, що коли визначені |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}}.

Категорії та інтервікі

Залежно від того, де розміщено документацію, може бути складно працювати з категоріями та інтервікі. Задля отримання інформації про їх додавання див. Вікіпедія:Документація шаблонів#Категорії та інтервікі-посилання § Зауваження .

Технічні подробиці

Автоматичні функції

Якщо сторінка документації не існує, панель інструментів замінюється на посилання [створити]. Воно автоматично створює сторінку з передзавантаженим текстом з базовим синтаксисом документації. Предзавантажений текст також використовується для посилань [створити] на підсторінках /пісочниця та /тести.

Передзавантажувальна сторінка для посилання [створити] /документація розташована в Шаблон:Документація/preload. Передзавантажувальні сторінки для посилань /пісочниця та /тести Шаблон:Документація/preload-sandbox та Шаблон:Документація/preload-testcases. Передзавантажувальна сторінка для посилання [скопіювати] підсторінки /пасочниця Шаблон:Документація/mirror.

Шаблон також автоматично додає {{pp-template}} на захищені сторінки шаблонів, й таким чином не потрібно робити це вручну.

Коли шаблон розташований на підсторінці /пісочниця він автоматично додає шаблон {{Пісочниця шаблону}}.

Функції вікна посилань

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

На додачу до цього, якщо |1= або |content= визначені, рядок «Додавайте категорії на підсторінку /документація» не буде відображатися.

Предметні простори назв vs. простори назв обговорень

Цей шаблон зазвичай розташовується в предметних просторах. Але у деяких випадках цей шаблон може бути потрібно використати у просторах Обговорення:

• У просторі MediaWiki, оскільки <noinclude> часто не працює у системних повідомленнях, та оскільки простір MediaWiki потрібно тримати чистим задля продуктивності.

Коли розташований на сторінці обговорення, цей шаблон зазвичай розташовується біля початку сторінки та без тегів <noinclude>...</noinclude>.

Сторінки /документація, /пісочниця та /тести зазвичай повинні розташовуватися у предметному просторі, за виключенням коли простір назв не має активованої властивості підсторінки MediaWiki: Основний, Файл, та MediaWiki. (Категорії можуть мати підсторінки, але документація створюється в просторі обговорення Категорій задля уникнення створення порожніх категорій. Також є багато інших технічних причин, чому сторінка /документація повинна зберігатися під сторінкою обговорення для цих (але не тільки) просторів назв.

Цей шаблон автоматично пов'язує його посилання [створити] для /документація, /пісочниця та /тести до відповідного простору назв.

Повний синтаксис

{{документація}}або{{документація | [шлях до сторінки документації]}}{{документація | content =}}або{{документація| [шлях до сторінки документації]| heading-style = | heading = | link box = }}або {{документація| [шлях до сторінки документації]| content = | heading-style = | heading = | link box = | page =}}

Кольорова схема

| titlestyle = background:#ccffe5| basestyle  = background:#ddffee<!-- basestyle= sets groupstyle, abovestyle, belowstyle together -->

{{Navbox|child| groupstyle = background:#e6fff2...

Див. також

• {{Підсторінка документації}}
• {{Поліпшити документацію}}
• {{Без документації}}