Шаблон:Docpage/Документация
[[:{{#rel2abs: .. | Шаблон:Docpage/Документация}}]] · Документация · [[{{#rel2abs: .. | Обсуждение шаблона:Docpage/Документация}}|Обсуждение]] · [[Служебная:Whatlinkshere/{{#rel2abs: .. | Шаблон:Docpage/Документация}}|Где используется]] {{#ifeq:Шаблон|Шаблон|(использование шаблона параметры)}}
{{#if:||}}
}}
Включает подстраницу с документацией для текущего шаблона. Точнее, включает шаблон название страницы/doc. Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения. И всё же включение документации в обсуждение является нежелательным.
Проще всего вставить вызов этого шаблона, а потом перейти по появившейся ссылке и создать или скопировать туда документацию. Достаточно добавить код <noinclude>{{doc}}</noinclude>.
Документация шаблона {{doc}} сформирована по тому же принципу, так что можно посмотреть код.
Основная цель выноса документации на отдельную страницу — избежать перегенерации HTML для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще.
Шаблон поддерживает необязательный параметр. При вводе {{doc{{#if:Полное название страницы||Полное название страницы}}{{#if:||{{{3}}}}}{{#if:||{{{4}}}}}{{#if:||и т. д.}}}} вместо страницы /doc будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.
См. также
- Проект по документированию шаблонов
- Пара шаблонов {{doc-inline}} и {{doc-end}}
