Шаблон:Doc/doc
Назначение[править]
Используется для создания страницы, содержащей описание и руководство для шаблона.
Создаёт подстраницу Шаблон:<Название шаблона>/doc. Основная цель выноса документации на отдельную страницу — избежать перегенерации HTML для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще.
Шаблон {{doc}} можно также вставлять в обсуждении шаблона, однако включение документации в обсуждение является нежелательным.
 |
Этот шаблон автоматически добавляет страницу в категорию Шаблоны с документацией.
|
Использование[править]
- Для создания документации шаблона
- В шаблон, для которого создаётся документация, добавить код
<noinclude>{{doc}}</noinclude>.
В шаблоне появится раздел Документация с меню управления. - В меню управления выбрать команду Править.
- В первую строчку страницы вставить шаблон {{docpage}}.
- Написать документацию и записать страницу.
Параметры[править]
Шаблон поддерживает необязательный параметр. При вводе {{doc|Полное название страницы}} вместо страницы /doc будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов. Для примера, см. код документации любого из языковых шаблонов.
См. также[править]
