Википедия:Проект:Документирование шаблонов
Материал из Википедии — свободной энциклопедии
Википроект «Документирование шаблонов» создан для выработки общих правил пользования шаблонами (уместность применения, правила установки и снятия и т. д.). На данный момент многие шаблоны не имеют соответствующих отметок, что необходимо исправлять.
На страницу задокументированного шаблона ставится пометка <noinclude>{{doc}}</noinclude>. При этом создаётся ссылка на страницу документации. После написания документации на соответствующей страницы, ссылка автоматически будет заменена документацией. Обратите внимание, что редактирование документации не вызовет перерисовки всех страниц, использующих шаблон.
Рекомендуется также использовать {{template navigation}} для создания простой навигации между шаблоном, его страницей документации (ссылка, в основном, нужна для редактирования) и обсуждением.
См. Список задокументированных шаблонов (также Список задокументированных старым способом шаблонов).
[править] Образцовые шаблоны
Вот примеры того, что и как писать в документацию по шаблону:
[править] Участники
Если вы пишете для всех создаваемых вами шаблонов нормальную документацию, как в примерах выше, то добавьте себя в этот список.
- Edward Chernenko?!/©~№?
- ВасильевВВ (talk • contrib • info • block) - в основном специфические шаблоны, типа этого. Но буду и другие.
- Kaganer 19:02, 12 января 2007 (UTC)
- Kalan ↗↓ Распишитесь! 04:54, 13 января 2007 (UTC)
- aTorero+ 10:00, 25 января 2007 (UTC)
[править] Другие варианты документирования
При переносе к нам шаблонов из других разделов (в основном, из английского), вместе с ними могут переноситься ссылки на другие схемы документирования. Для облегчения адаптации импортируемых шаблонов, шаблоны документации для таких схем, по мере их появления, также переводятся. Однако, в целях унификации рекомендуется повсеместно заменять их на вышеописанную схему. Ниже перечислены некоторые из таких «альтернативных» шаблонов.
