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

Материал из Википедии — свободной энциклопедии

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

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

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

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