Проект:Документирование шаблонов
 |
Эта статья заимствована с Википедии (или другой Вики) как временный вариант. Вы можете помочь проекту, написав новую, оригинальную статью на эту тему.
|
Проект «Документирование шаблонов» создан для выработки общих правил пользования шаблонами (уместность применения, правила установки и снятия и т. д.). На данный момент многие шаблоны не имеют соответствующих отметок, что необходимо исправлять. Главная категория для работы — Буквица:Недокументированные шаблоны.
На страницу задокументированного шаблона ставится пометка <noinclude>Для использования в TemplateStyles у страницы Модуль:Template call code/styles.css должна быть модель содержания "Sanitized CSS" (текущая модель: "CSS").{{doc}}</noinclude>. При этом создаётся ссылка на страницу документации. После написания документации на соответствующей странице ссылка автоматически будет заменена документацией. Обратите внимание, что редактирование документации не вызовет перерисовки всех страниц, использующих шаблон.
Сверху страницы документации также следует добавлять <noinclude>Для использования в TemplateStyles у страницы Модуль:Template call code/styles.css должна быть модель содержания "Sanitized CSS" (текущая модель: "CSS").{{docpage}}</noinclude> для создания простой навигации между шаблоном, его страницей документации и обсуждением. Помещать его на страницу шаблона не нужно, имеющиеся в нём ссылки уже есть в шаблоне Для использования в TemplateStyles у страницы Модуль:Template call code/styles.css должна быть модель содержания "Sanitized CSS" (текущая модель: "CSS").{{doc}}.
См. список задокументированных шаблонов, категория документаций шаблонов.
Для шаблонов, которым не требуется подробная и/или часто обновляемая документация, может использоваться конструкция <noinclude>Для использования в TemplateStyles у страницы Модуль:Template call code/styles.css должна быть модель содержания "Sanitized CSS" (текущая модель: "CSS").{{doc-inline}}</noinclude> для размещения документации прямо в тексте шаблона.