Шаблон:Doc

Текущая версия на 21:54, 16 июля 2010

[править] Документация

Этот служебный шаблон предоставляет навигацию для документации шаблона при использовании {{doc}}. Его вставляют на подстраницу ./doc в виде

<noinclude>{{docpage}}</noinclude>

Увидеть, как он выглядит, можно при просмотре документации этого шаблона.

Также этот шаблон автоматически помещает документацию в соответствующую категорию.

Включает подстраницу с документаций для текущего шаблона. Точнее, включает шаблон название страницы/doc. Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения. И всё же включение документации в обсуждение является нежелательным.

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

Документация шаблона {{doc}} сформирована по тому же принципу, так что можно посмотреть код.

Основная цель выноса документации на отдельную страницу — избежать перегенерации HTML для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще.

Шаблон поддерживает необязательный параметр. При вводе {{doc|Полное название страницы}} вместо страницы /doc будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.

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