Харе Кришна.ру
Шри Чайтанья Сарасват Матх в России

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

Материал из
Перейти к:навигация, поиск

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

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

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

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

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

Обратите внимание на Защищённые шаблоны без документации

Участники

Если вы пишете для всех создаваемых вами шаблонов нормальную документацию, добавьте себя в этот список.