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

Матеріал з Вікіпедії — вільної енциклопедії.
Перейти до: навігація, пошук
Іконка документації Документація шаблону[перегляд] [редагувати] [історія] [очистити кеш]

Базове використання[ред. код]

Шаблон без параметрів:

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

Параметри[ред. код]

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

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

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

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

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

Стандартно
порожній
Приклад
групи сторінок та шаблонів
Автоматичне значення
порожньо
Рядок пропонований
2 2

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

Стандартно
порожній
Приклад
оригінального списку сторінок
Автоматичне значення
порожньо
Рядок пропонований
Override override

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

Стандартно
порожній
Приклад
підсторінка
Автоматичне значення
порожньо
Рядок пропонований
Doc-notice doc-notice

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

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

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

Стандартно
порожній
Приклад
Ключ_сортування
Автоматичне значення
порожньо
Рядок пропонований
Nocat nocatinhibit

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

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

Використання з параметрами[ред. код]

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

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


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

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


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

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


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

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

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

Категоризація[ред. код]

Шаблон додає сторінку, на якій встановлений, в категорію: для шаблонів — «Сторінки документації шаблонів», для модулів — «Сторінки документації модулів», для користувачів не додає категорії (простір користувача не категоризується), для решти просторів — «Сторінки документації Вікіпедії».

Див. також[ред. код]