Шаблон:Tc/doc

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

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

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

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

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

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

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

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

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

• {{tc||параметр}} → {{tc|параметр}}
• {{tc|подст:|параметр}} → {{подст:tc|параметр}}
• {{tc|subst:|параметр}} → {{subst:tc|параметр}}

Настройки

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

  {{tc|ш|параметр 1{{=}}значение|параметр 2{{=}}значение|_spaced=1}} → {{ш |параметр 1=значение |параметр 2=значение }}

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

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

Пример:

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

{{optp/comment}}

↓

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

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

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

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

См. также

• {{tlc}} — то же самое плюс ссылка на шаблон
• {{pre}} — функционал тега <pre> с возможностью использования разметки
• {{пример}} — код включения шаблона → результат
• {{tp}} — ссылка на шаблон с указанием параметров
• {{t}} — символическая запись имени шаблона или ссылка на шаблон