Проект:Документирование шаблонов

Материал из Буквицы
Версия от 07:42, 14 апреля 2015; Karaby (обсуждение | вклад) (Новая страница: «{{Временно}} <!-- {{shortcut|ВП:П:ДШ}} -->__NOTOC__ Проект «Документирование шаблонов» создан для выр…»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)
Перейти к навигации Перейти к поиску

Проект «Документирование шаблонов» создан для выработки общих правил пользования шаблонами (уместность применения, правила установки и снятия и т. д.). На данный момент многие шаблоны не имеют соответствующих отметок, что необходимо исправлять. Главная категория для работы — Буквица:Недокументированные шаблоны.

На страницу задокументированного шаблона ставится пометка <noinclude>{{doc}}</noinclude>. При этом создаётся ссылка на страницу документации. После написания документации на соответствующей странице ссылка автоматически будет заменена документацией. Обратите внимание, что редактирование документации не вызовет перерисовки всех страниц, использующих шаблон.

Сверху страницы документации также следует добавлять <noinclude>{{docpage}}</noinclude> для создания простой навигации между шаблоном, его страницей документации и обсуждением. Помещать его на страницу шаблона не нужно, имеющиеся в нём ссылки уже есть в шаблоне {{doc}}.

См. список задокументированных шаблонов, категория документаций шаблонов.

Для шаблонов, которым не требуется подробная и/или часто обновляемая документация, может использоваться конструкция <noinclude>{{doc-inline}}</noinclude> для размещения документации прямо в тексте шаблона.