Шаблон:Підсторінка документації

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

Документація шаблону[перегляд] [редагувати] [історія] [очистити кеш]

Цей шаблон використовується на 19 000+ сторінках і його зміни будуть дуже помітними. Будь ласка, перевіряйте будь-які зміни на підсторінках /пісочниці та /тестів цього шаблону, або у вашому особистому просторі, та зважайте на обговорення змін на сторінці обговорення перед їхнім впровадженням.

Перенаправлення

{{Documentation subpage}}
{{Docpage}}

Цей шаблон призначений для позначення підсторінок /документація сторінок просторів назв Вікіпедії (передусім шаблонів і модулів^[1]) та створення їхнього узгодженого типового вмісту.

Базове використання

Шаблон без параметрів додає на підсторінку /документація заготовлений пустий код:

{{підсторінка документації}}
<!-- РЕДАГУЙТЕ ДОКУМЕНТАЦІЮ ШАБЛОНУ НИЖЧЕ ЦЬОГО РЯДКА -->
...

Використання для створення типового вмісту

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

Створючи документацію, додавайте розділи вмісту (за потреби) в такому порядку:

Вступ: короткий огляд призначення (опис) шаблону/модуля
Використання: заготовки з порожніми параметрами, які можна копіювати для використання
Приклади: приклади різного використання
Параметри: детальні описи всіх параметрів
- Синтаксис: огляд синтаксису шаблону
- Застарілі параметри: список застарілих параметрів
- Опис: описи, розділені за функціями

Вступ

Використовуйте шаблон {{підсторінка документації/lead}} створювати типовий узгоджений вміст для вступу на підсторінці /документація.

Редагувати підшаблон

Шаблон {{Підсторінка документації}} використовують створювати певний вміст для включення на сторінку.

Виклик шаблону: {{для повідомлення мети використання|обмеження простору використання |підсторінка документації/lead|для повідомлення мети використання|обмеження простору використання }}

Приклади

Розмітка	Рендериться як
{{підсторінка документації/lead\|''певний вміст для включення на сторінку''}}	Шаблон `{{Підсторінка документації}}` використовують створювати певний вміст для включення на сторінку.
{{підсторінка документації/lead\|''певний вміст для включення на сторінку''\|''з обмеженням простору використання''}}	Шаблон `{{Підсторінка документації}}` використовують створювати з обмеженням простору використання певний вміст для включення на сторінку.

TemplateData

Дані TemplateData для Візуального редактора • VisualEditor

Шаблон ставиться угорі сторінок документації шаблонів або модулів. Він відображається лише на сторінці документації (/Документація або /doc) шаблону/модуля та не відображається на інших сторінках, які її включають.

Параметри шаблону[Управління TemplateData]
Для цього шаблону краще внутрішнє форматування параметрів.
Параметр		Опис	Тип	Статус
1	`1`	Замінює частину першого рядка після слова «документація». Має бути в родовому відмінку. Приклад групи сторінок та шаблонів	Рядок	пропонований
2	`2`	Замінює частину другого рядка після слова «частиною». Має бути в родовому відмінку Приклад оригінального списку сторінок	Рядок	пропонований
override	`override`	Замінює назву підсторінки (замість /документація або /doc) Приклад підсторінка	Рядок	пропонований
doc-notice	`doc-notice`	Будь-яке значення для того, щоб не відображати текст, а лише додавати категорії. За замовчуванням show Приклад ні Автоматичне значення	Рядок	пропонований
defaultsort	`defaultsort`	Заміщує ключ сортування шаблону в категорії (замість назви сторінки) Приклад Ключ_сортування	Рядок	пропонований
nocat	`nocat` `inhibit`	Будь-яке значення для того, щоб приховати категорію «Документація шаблонів». Приклад приховати Автоматичне значення	Рядок	пропонований

Використання з параметрами

Перший параметр (|1=) замінює частину першого рядка після слова «документація»:

{{підсторінка документації|групи сторінок та шаблонів}}

Другий параметр (|2=) замінює частину першого рядка після слова «документація»:

{{підсторінка документації|2=оригінального списку сторінок}}

Ці параметри можна використовувати одночасно:

{{підсторінка документації|групи сторінок та шаблонів|оригінального списку сторінок}}

Параметр |doc-notice= з будь-яким значенням (наприклад, {{підсторінка документації|doc-notice=приховати}}) лише категоризує сторінку документації та не відображає повідомлення.

Параметр |override= змінює назву підсторінки, на якій відображається шаблон (за замовчуванням відображається лише на сторінках /документація або /doc без урахування регістру): наприклад, {{підсторінка документації|override=підсторінка}} дозволить відобразити шаблон на сторінці Шаблон:Назва шаблону/підсторінка

Параметр |defaultsort= змінює ключ сортування, а |nocat= або |inhibit= вимикає категорії. Ці параметри не впливають на відображення шаблону.

Категоризація

Шаблон додає сторінку, на якій встановлений, в наступні категорії:

для шаблонів — «Категорія:Сторінки документації шаблонів (7972)»
для модулів — «Категорія:Сторінки документації модулів (864)»
для користувачів не додає категорії (простір користувача не категоризується)
для решти просторів — «Категорія:Сторінки документації Вікіпедії (2)»
якщо підсторінка не має цільової сторінки — Категорія:Підсторінки документації без відповідних сторінок (49).

Примітки

↑ Докладніше див. Вікіпедія:Документація шаблонів

Див. також

Документація вище включена з Шаблон:Підсторінка документації/документація. (ред. | історія)
Дописувачі можуть експериментувати на підсторінках пісочниці (ред. | різн.) та протестувати зміни (ред.) цього шаблону.
Будь ласка, додавайте категорії до підсторінки /документація. Підсторінки цього шаблону.

[1] Докладніше див. Вікіпедія:Документація шаблонів

[1]