Шаблон:doc

Документация

[просмотр | править | история | обновить]

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

Использование

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

<noinclude>{{doc}}</noinclude>.

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

Технические детали

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

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

См. также

• {{docpage}} (вставляется на подстраницу документации к шаблону название страницы/Документация кодом <noinclude>{{docpage}}</noinclude>)
• {{doc-inline}}

Во избежание поломок страниц, использующих этот шаблон, экспериментируйте в песочнице (редактировать | разница) или своём личном пространстве.
Подстраницы этого шаблона.