Шаблон:Підсторінка документації - Wikiwand
For faster navigation, this Iframe is preloading the Wikiwand page for Шаблон:Підсторінка документації.

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

Матеріал з Вікіпедії — вільної енциклопедії.

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

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

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

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

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

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

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

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

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


Вступ

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

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

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

Приклади

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


TemplateData


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

Параметри шаблону

Для цього шаблону краще внутрішнє форматування параметрів.

ПараметрОписТипСтатус
11

Замінює частину першого рядка після слова «документація». Має бути в родовому відмінку.

Приклад
групи сторінок та шаблонів
Рядокпропонований
22

Замінює частину другого рядка після слова «частиною». Має бути в родовому відмінку

Приклад
оригінального списку сторінок
Рядокпропонований
overrideoverride

Замінює назву підсторінки (замість /документація або /doc)

Приклад
підсторінка
Рядокпропонований
doc-noticedoc-notice

Будь-яке значення для того, щоб не відображати текст, а лише додавати категорії.

Стандартно
show
Приклад
ні
Автоматичне значення
Рядокпропонований
defaultsortdefaultsort

Заміщує ключ сортування шаблону в категорії (замість назви сторінки)

Приклад
Ключ_сортування
Рядокпропонований
nocatnocat inhibit

Будь-яке значення для того, щоб приховати категорію «Документація шаблонів».

Приклад
приховати
Автоматичне значення
Рядокпропонований

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

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

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


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

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


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

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


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

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

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

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

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

Примітки

Див. також

{{bottomLinkPreText}} {{bottomLinkText}}
Шаблон:Підсторінка документації
Listen to this article