Шаблон:Doc — различия между версиями
Русинов (обсуждение | вклад) (http://ru.wikipedia.org/wiki/%D0%A8%D0%B0%D0%B1%D0%BB%D0%BE%D0%BD:Doc) |
(нет различий)
|
Текущая версия на 15:29, 18 января 2012
Включает подстраницу с документацией для текущего шаблона. Точнее, включает шаблон название страницы/doc
. Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения. И всё же включение документации в обсуждение является нежелательным.
Проще всего вставить вызов этого шаблона, а потом перейти по появившейся ссылке и создать или скопировать туда документацию. Достаточно добавить код <noinclude>{{doc}}</noinclude>
.
Документация шаблона {{doc}} сформирована по тому же принципу, так что можно посмотреть код.
Основная цель выноса документации на отдельную страницу — избежать перегенерации HTML для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще.
Шаблон поддерживает необязательный параметр. При вводе {{doc|Полное название страницы}} вместо страницы /doc
будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.
См. также рекомендации по документированию шаблонов.
Во избежание поломок страниц, использующих данный шаблон, желательно экспериментировать в своём личном пространстве.