Шаблон:Documentation/doc

Описание

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

Синтаксис

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

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

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

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

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

{{ Template: Documentation }}</noinclude>

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

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

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

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

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

== Синтаксис ==
Напишите <code>{{t|имя_шаблона}}</code> в необходимом месте.

== Параметры ==
При вставке шаблона ему можно передать опциональные (или обязательные) параметры.

{| border="1" class="wikitable sortable"
 |-
 | 
* '''param1'''
 | 
Описание параметра №1.
 |- 
 | 
* '''param2'''
 | 
Описание параметра №2.
|}

== Примеры ==
=== Без использования параметров ===
: <code>{{ Template: имя_шаблона }}</code>

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

{{ Template: имя_шаблона }}

=== С использованием параметров ===
: <code>{{ Template: имя_шаблона|вводные_параметры  }}</code>

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

{{ Template: имя_шаблона|вводные_параметры }}

=== О категории шаблона ===
В конце шаблона должна быть такая запись:

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

==== Пример категории шаблона ====
<code> <includeonly>[[ Category: Article_management_templates|{{PAGENAME}} ]]</includeonly><noinclude>[[ Category: Template_documentation|{{PAGENAME}} ]]</noinclude> </code>

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

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