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

Материал из Space Station 14 Вики
Интерактивная навигация по истории
← Предыдущая правка
ВизуальныйВики-текст
мНет описания правки
мНет описания правки
 
Строка 1: Строка 1:
<!-- from Minecraft Wiki -->
{{Краткий вызов|Шк|Tc}}
{{Краткий вызов|Шк}}
{{docpage}}
Шаблон предназначен для отображения рабочей формулы шаблона в виде кода на страницах обсуждения и справок.
{{onLua|Template call code|withParams}}
Шаблон '''{{t}}''' позволяет показать код включения шаблона. Он является лаконичной альтернативой конструкции {{tag|code|content=&lt;nowiki>...&lt;/nowiki>}}.
 
Разные способы привести код включения шаблона в документации:
 
{|
! Используя {{tago|code}} + {{tago|nowiki}} !! Результат
|-
| <code><nowiki>&lt;code&gt;&lt;nowiki&gt;{{шаблон|параметр}}&lt;/nowiki&gt;&lt;/code&gt;</nowiki></code>
| <code><nowiki>{{шаблон|параметр}}</nowiki></code>
|-
| <code><nowiki>&lt;code&gt;&lt;nowiki&gt;{{шаблон|а=б}}&lt;/nowiki&gt;&lt;/code&gt;</nowiki></code>
| <code><nowiki>{{шаблон|а=б}}</nowiki></code>
|-
| <code><nowiki>&lt;code&gt;&lt;nowiki&gt;{{шаблон|параметр=значение|{{IPA|/tʃ/}}}}&lt;/nowiki&gt;&lt;/code&gt;</nowiki></code>
| <code><nowiki>{{шаблон|параметр=значение|{{IPA|/tʃ/}}}}</nowiki></code>
|-
! Используя {{t}} !! Результат
|-
| <code><nowiki>{{шк|шаблон|параметр}}</nowiki></code>
| {{шк|шаблон|параметр}}
|-
| <code><nowiki>{{шк|шаблон|а{{=}}б}}</nowiki></code>
| {{шк|шаблон|а{{=}}б}}
|-
| <code><nowiki>{{шк|шаблон|параметр{{=}}значение|&lt;nowiki>{{IPA|/tʃ/}}&lt;/nowiki>}}</nowiki></code>
| {{шк|шаблон|параметр{{=}}значение|<nowiki>{{IPA|/tʃ/}}</nowiki>}}
|}
 
{{TOC right}}


== Использование ==
== Использование ==
{{шк|шк|''Название шаблона''}}
* {{пример||шаблон|параметр}}
* {{пример||шаблон|параметр=значение}}
* {{пример||шаблон|параметр 1|||параметр 4}}
* {{пример||подст:шаблон|параметр}}
 
'''Важно:''' хотя шаблон и способен отобразить параметры, которые переданы в него как именованные, то есть такие, где название параметра и значение разделены знаком «=» (благодаря использованию модуля [[Модуль:ParamValue2Value|ParamValue2Value]]), такие параметры в настоящий момент переносятся в конец списка, а их порядок искажается. Чтобы этого избежать, заменяйте знак «=» на {{tcl|=}} или забирайте параметры в {{tag|nowiki}}. Также это следует проделывать для параметров, имена которых начинаются со знака подчеркивания, иначе они не отобразятся.
 
В параметрах шаблона нельзя вписывать конструкции с фигурными скобками. Их можно заключать в {{tag|nowiki}}:
* {{шк||<nowiki>шаблон|&lt;nowiki>{{IPA|/tʃ/}}&lt;/nowiki></nowiki>}} → {{шк|шаблон|<nowiki>{{IPA|/tʃ/}}</nowiki>}}
 
Первый параметр (или только часть с названием шаблона) можно опускать — тогда его заменит название текущей страницы со строчной первой буквы:
* {{пример|||параметр}}
* {{пример||подст:|параметр}}
* {{пример||subst:|параметр}}
 
=== Настройки ===
* <code>_nobr</code>: запретить перенос на следующую строку внутри кода (при непустом значении параметра).
* <code>_tag=kbd</code>: использовать тег {{tago|kbd}} вместо {{tago|code}}.
* <code>_style</code>: [https://w.wiki/5bjc CSS] для тега.
* <code>_spaced</code>: отбить параметры шаблона пробелами (при непустом значении параметра):
*: {{пример||ш|параметр 1{{((}}{{=}}{{))}}значение|параметр 2{{((}}{{=}}{{))}}значение|_spaced{{=}}1}}


Можно также добавить параметры, максимум 8. Обратите внимание, что для нормальной работы символа <code>=</code> нужно использовать шаблон <code><nowiki>{{=}}</nowiki></code>.
=== <!-- На этот раздел есть ссылки на страницах t:optp, t:tlc, t:pre, при переименовании измените и их --> В оформлении документации ===
Помимо примеров, с помощью шаблона можно изящно записывать синтаксис шаблонов в документации. При этом курсивом выделяются «плейсхолдеры» ({{lang-en|placeholders}}, буквально — «держатели места») параметров шаблона, или их описания, чтобы не спутать их с непосредственным содержанием параметров. Шаблоном {{t|optp}}, в свою очередь, можно выделять необязательные параметры, которые отобразятся серым цветом.


=== Примеры использования ===
Пример:
{{шк|шк|subst:autoUnsigned}} выводит:<br>
: {{pre|<nowiki>{{шк|</nowiki>[[Шаблон:Переход|переход]]<nowiki>|''#Раздел или #якорь''{{optp|''тип значка''|''Название раздела''}}}}
{{шк|subst:autoUnsigned}}


{{шк|шк|Блок|3=2=тип=древесина}} выводит:<br>
{{optp/comment}}</nowiki>}}
{{шк|Блок|2=тип=древесина}}
: {{sp↓}}
: {{шк|переход|''#Раздел или #якорь''{{optp|''тип значка''|''Название раздела''}}}}{{optp/comment}}


{{шк|шк|:Команды консоли/infobox}} выводит:<br>
Обратите внимание, что в описании параметров здесь имитируется вид реального содержания параметров: в соответствии с ним выбирается заглавная или строчная буква, ставится или не ставится точка (в данном примере к названию раздела или якоря добавлен знак решётки). Это делается для того, чтобы по одному взгляду на синтаксис шаблона можно было понять, как его надо использовать.
{{шк|:Команды консоли/infobox}}


{{шк|шк|К переименованию|Новое имя страницы|Причина переименования}} выводит:<br>
Многострочные примеры использования шаблонов можно давать не только посредством тега {{tago|pre}}, который не поддерживает разметку внутри себя, но и при помощи пробела в начале строк или (что менее удобно) шаблона {{t|pre}} (а также {{t|*pre}}, позволяющего использовать тег {{tago|pre}} с маркерами списка при такой необходимости).
{{шк|К переименованию|Новое имя страницы|Причина переименования}}


== См. также ==
== См. также ==
* {{шс|Ссылка на шаблон}}
* {{t|pre}} — функционал тега {{tago|pre}} с возможностью использования разметки
* {{шс|Параметр}}
 
{{шаблоны для документирования}}


<includeonly>
<includeonly>
<!-- Здесь следует размещать категории и интервики шаблона -->
[[Категория:Шаблоны:Для документирования шаблонов]]
[[Категория:Шаблоны форматирования]]
[[Категория:Шаблоны:Для облегчения набора]]
</includeonly>
</includeonly>

Текущая версия от 02:02, 9 апреля 2025

↱{{Шк}}
{{Tc}}

Шаблон {{[[Шаблон:{{{1}}}|{{{1}}}]]}} позволяет показать код включения шаблона. Он является лаконичной альтернативой конструкции <code><nowiki>...</nowiki></code>.

Разные способы привести код включения шаблона в документации:

Используя <code> + <nowiki> Результат
<code><nowiki>{{шаблон|параметр}}</nowiki></code> {{шаблон|параметр}}
<code><nowiki>{{шаблон|а=б}}</nowiki></code> {{шаблон|а=б}}
<code><nowiki>{{шаблон|параметр=значение|{{IPA|/tʃ/}}}}</nowiki></code> {{шаблон|параметр=значение|{{IPA|/tʃ/}}}}
Используя {{[[Шаблон:{{{1}}}|{{{1}}}]]}} Результат
{{шк|шаблон|параметр}} {{шаблон|параметр}}
{{шк|шаблон|а{{=}}б}} {{шаблон|а=б}}
{{шк|шаблон|параметр{{=}}значение|<nowiki>{{IPA|/tʃ/}}</nowiki>}} {{шаблон|параметр=значение|{{IPA|/tʃ/}}}}

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

  • {{код шаблона|шаблон|параметр}} → {{шаблон|параметр}}
  • {{код шаблона|шаблон|параметр=значение}} → {{шаблон|параметр=значение}}
  • {{код шаблона|шаблон|параметр 1|||параметр 4}} → {{шаблон|параметр 1|||параметр 4}}
  • {{код шаблона|подст:шаблон|параметр}} → {{подст:шаблон|параметр}}

Важно: хотя шаблон и способен отобразить параметры, которые переданы в него как именованные, то есть такие, где название параметра и значение разделены знаком «=» (благодаря использованию модуля ParamValue2Value), такие параметры в настоящий момент переносятся в конец списка, а их порядок искажается. Чтобы этого избежать, заменяйте знак «=» на {{=}} или забирайте параметры в <nowiki></nowiki>. Также это следует проделывать для параметров, имена которых начинаются со знака подчеркивания, иначе они не отобразятся.

В параметрах шаблона нельзя вписывать конструкции с фигурными скобками. Их можно заключать в <nowiki></nowiki>:

  • {{код шаблона|шаблон|<nowiki>{{IPA|/tʃ/}}</nowiki>}} → {{шаблон|{{IPA|/tʃ/}}}}

Первый параметр (или только часть с названием шаблона) можно опускать — тогда его заменит название текущей страницы со строчной первой буквы:

  • {{код шаблона||параметр}} → {{код шаблона|параметр}}
  • {{код шаблона|подст:|параметр}} → {{подст:код шаблона|параметр}}
  • {{код шаблона|subst:|параметр}} → {{subst:код шаблона|параметр}}

Настройки

  • _nobr: запретить перенос на следующую строку внутри кода (при непустом значении параметра).
  • _tag=kbd: использовать тег <kbd> вместо <code>.
  • _style: CSS для тега.
  • _spaced: отбить параметры шаблона пробелами (при непустом значении параметра):
    {{код шаблона|ш|параметр 1{{=}}значение|параметр 2{{=}}значение|_spaced=1}} → {{ш |параметр 1=значение |параметр 2=значение }}

В оформлении документации

Помимо примеров, с помощью шаблона можно изящно записывать синтаксис шаблонов в документации. При этом курсивом выделяются «плейсхолдеры» (англ.  placeholders, буквально — «держатели места») параметров шаблона, или их описания, чтобы не спутать их с непосредственным содержанием параметров. Шаблоном {{optp}}, в свою очередь, можно выделять необязательные параметры, которые отобразятся серым цветом.

Пример: 

{{шк|переход|''#Раздел или #якорь''{{optp|''тип значка''|''Название раздела''}}}}

{{optp/comment}}
↓
{{переход|#Раздел или #якорь|тип значка|Название раздела}}

Серым показаны необязательные параметры.

Обратите внимание, что в описании параметров здесь имитируется вид реального содержания параметров: в соответствии с ним выбирается заглавная или строчная буква, ставится или не ставится точка (в данном примере к названию раздела или якоря добавлен знак решётки). Это делается для того, чтобы по одному взгляду на синтаксис шаблона можно было понять, как его надо использовать.

Многострочные примеры использования шаблонов можно давать не только посредством тега <pre>, который не поддерживает разметку внутри себя, но и при помощи пробела в начале строк или (что менее удобно) шаблона {{pre}} (а также {{*pre}}, позволяющего использовать тег <pre> с маркерами списка при такой необходимости).

См. также

  • {{pre}} — функционал тега <pre> с возможностью использования разметки


Источник — https://station14.ru/index.php?title=Шаблон:Код_шаблона/doc&oldid=78747