Шаблон:Doc/doc

Шаблон:Fmbox {{#invoke:Message box|ombox}} Включает подстраницу с документацией для текущего шаблона. Точнее, включает страницу «Название текущей страницы/doc». Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения (хотя включение документации в обсуждение является нежелательным).

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

Документация шаблона {{safesubst:#invoke: Template call code | withoutParams }} сформирована по тому же принципу, так что можно посмотреть код.

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

Шаблон поддерживает необязательный параметр. При вводе {{safesubst:#invoke: Template call code | withParams | _tag = code }} вместо страницы «/doc» будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.

Другое название этого шаблона — {{safesubst:#invoke: Template call code | withoutParams }}.

См. также

• Проект по документированию шаблонов
• Пара шаблонов {{safesubst:#invoke: Template call code | withoutParams }} и {{safesubst:#invoke: Template call code | withoutParams }}

TemplateData

<templatedata> { "params": { "1": {}, "2": {}, "3": {}, "4": {}, "5": {}, "editsection": {}, "SUBJECTPAGENAME": {} }, "format": "block" } </templatedata>