458
правок
Изменения
Шаблон:Documentation/doc (посмотреть исходный код)
Версия от 12:31, 22 июля 2020
, 12:31, 22 июля 2020Fixing
== Описание ==
== Описание ==
Этот шаблон используется для вставки описаний на страницах шаблонов.
Этот шаблон используется для вставки описаний на страницах шаблонов.
== Синтаксис ==
== Синтаксис ==
Добавьте <code><nowiki><noinclude></nowiki>{{t|documentation}}<nowiki></noinclude></nowiki></code> или <code><nowiki><noinclude></nowiki>{{ [[:Template: Documentation]] }}<nowiki></noinclude></nowiki></code> в конце страницы шаблона.
Добавьте <code><nowiki><noinclude></nowiki>{{t|documentation}}<nowiki></noinclude></nowiki></code> в конце страницы шаблона.
== Использование ==
== Использование ==
=== На странице шаблона ===
=== На странице Шаблона ===
Это нормальный формат при использовании:
Это нормальный формат при использовании:
<pre>
<pre>
КОД_ШАБЛОНА<includeonly>Любые категории для вставки в статьи по шаблону</includeonly><noinclude>
{{documentation}}</noinclude>
{{ Template: Documentation }}</noinclude>
</pre>
</pre>
''Если ваш шаблон не является законченным [http://htmlbook.ru/html/div div] или [http://htmlbook.ru/html/table table], то, возможно, вам потребуется закрыть теги непосредственно перед вставкой <code><nowiki>{{documentation}}</nowiki></code> (в пределах тегов [https://ru.wikipedia.org/wiki/Википедия:Механизм_шаблонов#Теги_noinclude,_includeonly,_onlyinclude noinclude]).''
''Если ваш шаблон не является законченным [http://htmlbook.ru/html/div div] или [http://htmlbook.ru/html/table table], то, возможно, вам потребуется закрыть теги непосредственно перед вставкой <code><nowiki>{{documentation}}</nowiki></code> (в пределах тегов [https://ru.wikipedia.org/wiki/Википедия:Механизм_шаблонов#Теги_noinclude,_includeonly,_onlyinclude noinclude]).''
''Разрыв строки прямо перед <code><nowiki>{{documentation}}</nowiki></code> также может быть полезным, так как это помогает предотвратить "столкновение" шаблона документации с предыдущим кодом.''
''Разрыв строки прямо перед <code><nowiki>{{ Template: Documentation }}</nowiki></code> также может быть полезным, так как это помогает предотвратить "столкновение" шаблона документации с предыдущим кодом.''
=== На странице Template/doc ===
=== На странице Template/doc ===
Обычно вы захотите написать что-то вроде следующего на странице документации:
Обычно вы захотите написать что-то вроде следующего на странице документации:
== Описание ==
== Описание ==
Этот шаблон используется, чтобы сделать что-то.
Этот шаблон используется, чтобы сделать что-то.
== Синтаксис ==
== Синтаксис ==
Напишите <code>{{t|имя_шаблона}}</code> в необходимом месте.
== Параметры ==
При вставке шаблона ему можно передать опциональные (или обязательные) параметры.
{| border="1" class="wikitable sortable"
|-
|
* '''param1'''
|
Описание параметра №1.
|-
|
* '''param2'''
|
Описание параметра №2.
|}
== Примеры ==
== Примеры ==
=== Без использования параметров ===
: <code><nowiki>{{ Template: имя_шаблона }}</nowiki></code>
превращается в...
{{ Template: имя_шаблона }}
<code><nowiki>{{templatename|input}}</nowiki></code>
=== С использованием параметров ===
: <code><nowiki>{{ Template: имя_шаблона|вводные_параметры }}</nowiki></code>
превращается в...
превращается в...
{{templatename|input}}
{{ Template: имя_шаблона|вводные_параметры }}
=== О категории шаблона ===
В конце шаблона должна быть такая запись:
<code><nowiki> <includeonly>Любые категории для самого шаблона</includeonly><noinclude>[[ Category:Template documentation|{{PAGENAME}} ]]</noinclude> </nowiki></code>
<includeonly>Любые категории для самого шаблона</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
==== Пример категории шаблона ====
<code><nowiki> <includeonly>[[ Category: Article_management_templates|{{PAGENAME}} ]]</includeonly><noinclude>[[ Category: Template_documentation|{{PAGENAME}} ]]</noinclude> </nowiki></code>
</pre>
</pre>
Используйте любой или все вышеприведенные разделы [[#Описание|описания]]/[[#Синтаксис|синтаксиса]]/[[#Использование|примера вывода]]. Вы также можете добавить «См. также» или другие разделы.
Используйте любой или все вышеприведенные разделы [[#Описание|описания]]/[[#Синтаксис|синтаксиса]]/[[#Использование|примера вывода]]. Вы также можете добавить «См. также» или другие разделы.
Обратите внимание, что в приведенном выше примере также используется шаблоны [[Template:T]] и [[Template:T/piece]].
Обратите внимание, что в приведенном выше примере также используется шаблоны [[ :Template: T ]] и [[ :Template: T/piece ]].
<includeonly>[[Category:General wiki templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
<includeonly>[[ Category: General_wiki_templates|{{PAGENAME}} ]]</includeonly><noinclude>[[ Category: Template_documentation|{{PAGENAME}} ]]</noinclude>