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

Матеріал з Minecraft Wiki
Перейти до: навігація, пошук
Lua logo.svg
Цей шаблон використовує Модуль:Документація, написаний на мові програмування Lua.
Будь ласка, перегляньте wikipedia:Wikipedia:Lua і mw:Extension:Scribunto (обидві англ.) для розуміння роботи модуля.

Для шаблонів: вставте <noinclude>{{subst:док}}</noinclude> після коду шаблону і збережіть сторінку. Ця дія помістить {{Документація}} і коментар, повідомляє редакторам, куди розміщувати категорії і інтервікі. Для інших типів сторінок: шаблон документації вже повинен бути там.

Натисніть кнопку «Створити» в самому верху сторінки, і відкриється вікно редагування сторінки документації з деяким початковим вмістом, що полегшує форматування.

Сторінки документації автоматично будуть додані в категорію Сторінки документації.

Додаткові параметри

Ці параметри можуть бути додані як до шаблону {{subst:док}} при створенні сторінки, так і до шаблону {{Документація}} після цього.

тип

Задає «тип» документованої сторінки: модуль, шаблон, повідомлення, тощо. Це буде використано в деяких відображуваних шаблоном повідомленнях, а також в назвах проставляють категорій.

Тип задається автоматично в залежності від того, в якому просторі імен знаходиться сторінка, тому зазвичай його перевизначати не потрібно.

сторінка

Сторінка, де повинна бути розташована документація. За замовчуванням це підсторінка поточної сторінки з назвою «док».

nodoc

Якщо у шаблону немає документації, а ви не знаєте, як його використовувати, додайте nodoc=1 до шаблону Заголовок документації на сторінці документації. Фон документації стане червоним для збільшення помітності, і сторінка, якщо вона є шаблоном, буде додана в категорію Шаблони без документації.

Цей параметр задається автоматично, якщо сторінка документації не існує, тому зазвичай його вказувати не потрібно.

baddoc

Подібно параметру nodoc, цей параметр використовується для вказівки сторінок, у яких є документація, але вона низької якості. Це може означати, що в документації недостатньо прикладів використання, пояснені не всі можливості або мета і методи використання документованого шаблону. Щоб збільшити помітність, колір фону буде змінений на жовтий, а сторінка, якщо вона є шаблоном, буде додана в категорію Шаблони з поганою документацією.

[перегляд | редагувати | історія | оновити]Розташована вище документація включена з Шаблон:Документація/док.