Шаблон:Підсторінка документації: відмінності між версіями
[перевірена версія] | [неперевірена версія] |
NickK (обговорення | внесок) м ось так точніше буде |
Avatar6 (обговорення | внесок) Немає опису редагування |
||
Рядок 8: | Рядок 8: | ||
| style = margin-bottom:1.0em; |
| style = margin-bottom:1.0em; |
||
| text = |
| text = |
||
'''Це [[Вікіпедія:Підсторінки|підсторінка]] [[Вікіпедія:Документація шаблонів|документації]] {{{1|{{#switch:{{SUBJECTSPACE}} |{{ns:Template}}=шаблону |{{ns:Module}}=модуля |{{ns:User}}=користувача |#default=Вікіпедії}} [[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}|{{BASEPAGENAME}}]]}}}'''.<br />Вона містить інформацію про використання, [[Вікіпедія:Категоризація|категорії]] та інший вміст, що не є частиною {{#if:{{{2|}}} |{{{2|}}} |{{#if:{{{1|}}} |оригінальної сторінки |{{#if:{{SUBJECTSPACE}} |оригінальної сторінки {{#switch:{{SUBJECTSPACE}} |{{ns:Template}}=шаблону |{{ns:Module}}=модуля |{{ns:User}}=користувача |#default=Вікіпедії}}|статті}}}}}}. |
'''Це [[Вікіпедія:Підсторінки|підсторінка]] [[Вікіпедія:Документація шаблонів|документації]] {{{1|{{#switch:{{SUBJECTSPACE}} |{{ns:Template}}=шаблону {{ti|{{BASEPAGENAME}}}}|{{ns:Module}}=модуля {{mi|{{BASEPAGENAME}}}} |{{ns:Gadget}}=гаджета [[{{SUBJECTSPACE}}:{{BASEPAGENAME}}{{!}}{{BASEPAGENAME}}]] |{{ns:User}}=користувача [[{{SUBJECTSPACE}}:{{BASEPAGENAME}}{{!}}{{BASEPAGENAME}}]] |#default=Вікіпедії}} [[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}|{{BASEPAGENAME}}]]}}}'''.<br />Вона містить інформацію про використання, [[Вікіпедія:Категоризація|категорії]] та інший вміст, що не є частиною {{#if:{{{2|}}} |{{{2|}}} |{{#if:{{{1|}}} |оригінальної сторінки |{{#if:{{SUBJECTSPACE}} |оригінальної сторінки {{#switch:{{SUBJECTSPACE}} |{{ns:Template}}=шаблону |{{ns:Module}}=модуля |{{ns:User}}=користувача |{{ns:Gadget}}=гаджета |#default=Вікіпедії}}|статті}}}}}}. |
||
}} |
}} |
||
}}<!-- |
}}<!-- |
||
Рядок 17: | Рядок 17: | ||
| <includeonly><!-- |
| <includeonly><!-- |
||
-->{{#ifexist:{{NAMESPACE}}:{{BASEPAGENAME}} |
-->{{#ifexist:{{NAMESPACE}}:{{BASEPAGENAME}} |
||
| {{#ifeq:{{SUBJECTSPACE}} |{{ns:User}}|<!-- сторінки користувачів не категоризуємо -->|[[Категорія:Сторінки документації {{#switch:{{SUBJECTSPACE}} |Шаблон=шаблонів |Модуль=модулів |#default=Вікіпедії}}]]}} |
| {{#ifeq:{{SUBJECTSPACE}} |{{ns:User}}|<!-- сторінки користувачів не категоризуємо -->|[[Категорія:Сторінки документації {{#switch:{{SUBJECTSPACE}} |Шаблон=шаблонів |Модуль=модулів|Gadget=гаджетів |#default=Вікіпедії}}]]}} |
||
| [[Категорія:Підсторінки документації без відповідних сторінок]] |
| [[Категорія:Підсторінки документації без відповідних сторінок]] |
||
}}<!-- |
}}<!-- |
||
Рядок 28: | Рядок 28: | ||
}}<!-- |
}}<!-- |
||
--></includeonly><noinclude> |
--></includeonly><noinclude> |
||
<!-- Додавайте категорії на підсторінку / |
<!-- Додавайте категорії на підсторінку /документація, а не сюди. Дякуємо! --> |
||
{{документація}} |
{{документація}} |
||
</noinclude> |
</noinclude> |
Версія за 14:32, 3 жовтня 2016
Це підсторінка документації шаблону {{Підсторінка документації}} (обг. · викор. · ред.) Підсторінка документації. Вона містить інформацію про використання, категорії та інший вміст, що не є частиною оригінальної сторінки шаблону. |
Цей шаблон використовується на 16 390+ сторінках. Для уникнення великомасштабних збоїв та непотрібного навантаження на сервер, будь-які зміни цього шаблону спочатку потрібно перевірити на його підсторінках /пісочниці та /тестів, або у вашому особистому просторі. Потім перевірені зміни можуть бути впроваджені на цій сторінці єдиним редагуванням. Будь ласка, обговорюйте будь-які зміни на сторінці обговорення перед їхнім впровадженням. |
Цей шаблон призначений для позначення підсторінок /документація
сторінок просторів назв Вікіпедії (передусім шаблонів і модулів[1]) та створення їхнього узгодженого типового вмісту.
Базове використання
Шаблон без параметрів додає на підсторінку /документація
заготовлений пустий код:
{{підсторінка документації}} <!-- РЕДАГУЙТЕ ДОКУМЕНТАЦІЮ ШАБЛОНУ НИЖЧЕ ЦЬОГО РЯДКА --> ...
Використання для створення типового вмісту
Включення підшаблонів відображає текст документації, який визначено на підсторінці підсторінка документації/підсторінка_шаблону
. Якщо певний розділ документації не підходить для певного шаблону чи модуля, додайте текст вручну чи створіть новий підшаблон. Кожен блок тексту є підшаблоном, який можна відредагувати через відповідне посилання.
Створючи документацію, додавайте розділи вмісту (за потреби) в такому порядку:
- Вступ: короткий огляд призначення (опис) шаблону/модуля
- Використання: заготовки з порожніми параметрами, які можна копіювати для використання
- Приклади: приклади різного використання
- Параметри: детальні описи всіх параметрів
- Синтаксис: огляд синтаксису шаблону
- Застарілі параметри: список застарілих параметрів
- Опис: описи, розділені за функціями
Вступ
Використовуйте шаблон {{підсторінка документації/lead}}
створювати типовий узгоджений вміст для вступу на підсторінці /документація
.
{{Підсторінка документації}}
використовують створювати певний вміст для включення на сторінку.Виклик шаблону: {{для повідомлення мети використання|обмеження простору використання
|підсторінка документації/lead|для повідомлення мети використання|обмеження простору використання
}}
Приклади
Розмітка | Рендериться як |
---|---|
{{підсторінка документації/lead|''певний вміст для включення на сторінку''}} |
Шаблон |
{{підсторінка документації/lead|''певний вміст для включення на сторінку''|''з обмеженням простору використання''}} |
Шаблон |
TemplateData
Шаблон ставиться угорі сторінок документації шаблонів або модулів. Він відображається лише на сторінці документації (/Документація або /doc) шаблону/модуля та не відображається на інших сторінках, які її включають.
Параметр | Опис | Тип | Статус | |
---|---|---|---|---|
1 | 1 | Замінює частину першого рядка після слова «документація». Має бути в родовому відмінку.
| Рядок | пропонований |
2 | 2 | Замінює частину другого рядка після слова «частиною». Має бути в родовому відмінку
| Рядок | пропонований |
override | override | Замінює назву підсторінки (замість /документація або /doc)
| Рядок | пропонований |
doc-notice | doc-notice | Будь-яке значення для того, щоб не відображати текст, а лише додавати категорії.
| Рядок | пропонований |
defaultsort | defaultsort | Заміщує ключ сортування шаблону в категорії (замість назви сторінки)
| Рядок | пропонований |
nocat | nocat inhibit | Будь-яке значення для того, щоб приховати категорію «Документація шаблонів».
| Рядок | пропонований |
Використання з параметрами
Перший параметр (|1=
) замінює частину першого рядка після слова «документація»:
{{підсторінка документації|групи сторінок та шаблонів}}
Другий параметр (|2=
) замінює частину першого рядка після слова «документація»:
{{підсторінка документації|2=оригінального списку сторінок}}
Ці параметри можна використовувати одночасно:
{{підсторінка документації|групи сторінок та шаблонів|оригінального списку сторінок}}
Параметр |doc-notice=
з будь-яким значенням (наприклад, {{підсторінка документації|doc-notice=приховати}}) лише категоризує сторінку документації та не відображає повідомлення.
Параметр |override=
змінює назву підсторінки, на якій відображається шаблон (за замовчуванням відображається лише на сторінках /документація або /doc без урахування регістру): наприклад, {{підсторінка документації|override=підсторінка}}
дозволить відобразити шаблон на сторінці Шаблон:Назва шаблону/підсторінка
Параметр |defaultsort=
змінює ключ сортування, а |nocat=
або |inhibit=
вимикає категорії. Ці параметри не впливають на відображення шаблону.
Категоризація
Шаблон додає сторінку, на якій встановлений, в наступні категорії:
- для шаблонів — «Категорія:Сторінки документації шаблонів (7825)»
- для модулів — «Категорія:Сторінки документації модулів (825)»
- для користувачів не додає категорії (простір користувача не категоризується)
- для решти просторів — «Категорія:Сторінки документації Вікіпедії (2)»
- якщо підсторінка не має цільової сторінки — Категорія:Підсторінки документації без відповідних сторінок (45).
Примітки
- ↑ Докладніше див. Вікіпедія:Документація шаблонів
Див. також
Документація вище включена з Шаблон:Підсторінка документації/документація. (ред. | історія) Дописувачі можуть експериментувати на підсторінках пісочниці (ред. | різн.) та протестувати зміни (ред.) цього шаблону. Будь ласка, додавайте категорії до підсторінки /документація. Підсторінки цього шаблону. |