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

Вы находитесь на сайте "Архив статей из ЭЕЭ и статей на еврейские темы из Википедии"

---

Версия 23:32, 26 мая 2011

Файл:Gtk-redo-ltr.svg

ВП:П:ДШ

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

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

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

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

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

Участники

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

• Aleksandrit
• Atorero
• flrn
• Insider
• Kaganer
• Kalan
• Maryanna Nesina (mar)
• Mashiah
• Micha Zima
• putnik
• Rave
• ВасильевВВ
• Folia Vernalia
• LonelyKoyote
• Shtrafbat
• Abiyoyo
• NKM
• iohanss
• SmesharikiAreTheBest