Шаблон:Documentation: различия между версиями
м (Форматирование) |
м (А так это будет работать, как задумывалось?) |
||
| Строка 1: | Строка 1: | ||
<includeonly><div style="border:3px dashed #920; padding:0.5em 1em;">{{tocright}} | <includeonly><div style="border:3px dashed #920; padding:0.5em 1em;">{{tocright}} | ||
| − | <div style="font-size:18px; color:#920; text-align:center;"><big>Документация Шаблона</big><br /><br /><code>{{ | + | <div style="font-size:18px; color:#920; text-align:center;"><big>Документация Шаблона</big><br /><br /> {{<code>{{PAGENAME}}</code>}} </div> |
<div style="border-bottom:3px dashed #920;">''Примечание: шаблон выше иногда может быть частично или полностью невидимым.'' | <div style="border-bottom:3px dashed #920;">''Примечание: шаблон выше иногда может быть частично или полностью невидимым.'' | ||
<br/>Посетите [[Template: {{PAGENAMEE}}/doc]], чтобы просмотреть эту документацию. ([{{FullURL: Template: {{PAGENAMEE}}/doc|action=edit}} править]) ([[Template:Documentation|Как это работает?]])</div> | <br/>Посетите [[Template: {{PAGENAMEE}}/doc]], чтобы просмотреть эту документацию. ([{{FullURL: Template: {{PAGENAMEE}}/doc|action=edit}} править]) ([[Template:Documentation|Как это работает?]])</div> | ||
Версия от 13:49, 2 июля 2020
{{
Documentation}} Посетите Template: 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 .
