Шаблон:Doc

Материал из Справочника наблюдателя
Перейти к:навигация, поиск

(i)      Описание шаблона[]

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

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

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

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

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

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