Шаблон:Documentation/doc: различия между версиями

Материал из Chaotic Onyx
Перейти к навигацииПерейти к поиску
(Позаимствовано: https://www.underrail.com/wiki/index.php?title=Template:Documentation/doc)
 
м (Fixing)
 
(не показаны 3 промежуточные версии этого же участника)
Строка 1: Строка 1:
−
==Description==
+
== Описание ==
 +
Этот шаблон используется для вставки описаний на страницах шаблонов.
  
−
This template is used to insert descriptions on template pages.
+
== Синтаксис ==
 +
Добавьте <code><nowiki><noinclude></nowiki>{{t|documentation}}<nowiki></noinclude></nowiki></code> или <code><nowiki><noinclude></nowiki>{{ [[:Template: Documentation]] }}<nowiki></noinclude></nowiki></code> в конце страницы шаблона.
  
−
==Syntax==
+
== Использование ==
 +
=== На странице шаблона ===
 +
Это нормальный формат при использовании:
  
−
Add <code><nowiki><noinclude></nowiki>{{t|documentation}}<nowiki></noinclude></nowiki></code> at the end of the template page.
+
<pre>
  
−
==Usage==
+
КОД_ШАБЛОНА<includeonly>Любые категории для вставки в статьи по шаблону</includeonly><noinclude>
  
−
===On the Template page===
+
{{ Template: Documentation }}</noinclude>
  
−
This is the normal format when used:
+
</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]).''
  
−
TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
+
''Разрыв строки прямо перед <code><nowiki>{{ Template: Documentation }}</nowiki></code> также может быть полезным, так как это помогает предотвратить "столкновение" шаблона документации с предыдущим кодом.''
  
−
{{documentation}}</noinclude>
+
=== На странице Template/doc ===
 +
Обычно вы захотите написать что-то вроде следующего на странице документации:
  
−
</pre>
+
<pre>
  
−
''If your template is not a completed div or table, you may need to close the tags just before <code><nowiki>{{documentation}}</nowiki></code> is inserted (within the noinclude tags).''
+
== Описание ==
 +
Этот шаблон используется, чтобы сделать что-то.
  
−
''A line break right before <code><nowiki>{{documentation}}</nowiki></code> can also be useful as it helps prevent the documentation template "running into" previous code.''
+
== Синтаксис ==
 +
Напишите <code>{{t|имя_шаблона}}</code> в необходимом месте.
  
−
===On the Template/doc page===
+
== Параметры ==
 +
При вставке шаблона ему можно передать опциональные (или обязательные) параметры.
  
−
Normally, you will want to write something like the following on the documentation page:
+
{| border="1" class="wikitable sortable"
−
 
+
|-
−
<pre>
+
|
 +
* '''param1'''
 +
|
 +
Описание параметра №1.
 +
|-
 +
|
 +
* '''param2'''
 +
|
 +
Описание параметра №2.
 +
|}
  
−
==Description==
+
== Примеры ==
 +
=== Без использования параметров ===
 +
: <code><nowiki>{{ Template: имя_шаблона }}</nowiki></code>
  
−
This template is used to do something.
+
превращается в...
  
−
==Syntax==
+
{{ Template: имя_шаблона }}
  
−
Type <code>{{t|templatename}}</code> somewhere.
+
=== С использованием параметров ===
 +
: <code><nowiki>{{ Template: имя_шаблона|вводные_параметры  }}</nowiki></code>
  
−
==Samples==
+
превращается в...
  
−
<code>&lt;nowiki>{{templatename|input}}&lt;/nowiki></code>
+
{{ Template: имя_шаблона|вводные_параметры }}
  
−
results in...
+
=== О категории шаблона ===
 +
В конце шаблона должна быть такая запись:
  
−
{{templatename|input}}
+
<code><nowiki> <includeonly>Любые категории для самого шаблона</includeonly><noinclude>[[ Category:Template documentation|{{PAGENAME}} ]]</noinclude> </nowiki></code>
  
−
<includeonly>Any categories for the template itself</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>
  
−
Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or other sections.
+
Используйте любой или все вышеприведенные разделы [[#Описание|описания]]/[[#Синтаксис|синтаксиса]]/[[#Использование|примера вывода]]. Вы также можете добавить «См. также» или другие разделы.
  
−
Note that the above example also uses the [[Template:T]] and [[Template:T/piece]] templates.
+
Обратите внимание, что в приведенном выше примере также используется шаблоны [[ :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>

Текущая версия от 12:31, 22 июля 2020

Описание

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

Синтаксис

Добавьте <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 .

Источник — https://wiki.ss13.ru/index.php?title=Шаблон:Documentation/doc&oldid=32537