Шаблон:Documentation/doc

Описание

Этот шаблон используется для вставки описаний на страницах шаблонов.

Синтаксис

Добавьте <noinclude>{{ documentation }}</noinclude> в конце страницы шаблона.

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

На странице Шаблона

Это нормальный формат при использовании:

КОД ШАБЛОНА<includeonly>Любые категории для вставки в статьи по шаблону</includeonly><noinclude>

{{documentation}}</noinclude>

Если ваш шаблон не является законченным div или table, то, возможно, вам потребуется закрыть теги непосредственно перед вставкой {{documentation}} (в пределах тегов noinclude).

Разрыв строки прямо перед {{documentation}} также может быть полезным, так как это помогает предотвратить "столкновение" шаблона документации с предыдущим кодом.

На странице Template/doc

Обычно вы захотите написать что-то вроде следующего на странице документации:

== Описание ==

Этот шаблон используется, чтобы сделать что-то.

== Синтаксис ==

Напишите <code>{{t|templatename}}</code> где-то.

== Примеры ==

<code><nowiki>{{templatename|input}}</nowiki></code>

превращается в...

{{templatename|input}}

<includeonly>Любые категории для самого шаблона</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

Используйте любой или все вышеприведенные разделы описания/синтаксиса/примера вывода. Вы также можете добавить «См. также» или другие разделы.

Обратите внимание, что в приведенном выше примере также используется шаблоны Template:T и Template:T/piece.