Шаблон:Tc/doc
{{#invoke:Message box|fmbox}} {{#invoke:Message box|ombox}} Шаблон {{[[Шаблон:{{{1}}}|{{{1}}}]]}} позволяет показать код включения шаблона. Он является лаконичной альтернативой конструкции Шаблон:Tag.
Разные способы привести код включения шаблона в документации:
Используя Шаблон:Tago + Шаблон:Tago | Результат |
---|---|
<code><nowiki>{{шаблон|параметр}}</nowiki></code>
|
{{шаблон|параметр}}
|
<code><nowiki>{{шаблон|а=б}}</nowiki></code>
|
{{шаблон|а=б}}
|
<code><nowiki>{{шаблон|параметр=значение|{{IPA|/tʃ/}}}}</nowiki></code>
|
{{шаблон|параметр=значение|{{IPA|/tʃ/}}}}
|
Используя {{[[Шаблон:{{{1}}}|{{{1}}}]]}} | Результат |
{{tc|шаблон|параметр}}
|
withParams | _tag = code }} |
{{tc|шаблон|а{{=}}б}}
|
withParams | _tag = code }} |
{{tc|шаблон|параметр{{=}}значение|<nowiki>{{IPA|/tʃ/}}</nowiki>}}
|
withParams | _tag = code }} |
Использование[править код]
- {{#invoke:Example|main}}
- {{#invoke:Example|main}}
- {{#invoke:Example|main}}
- {{#invoke:Example|main}}
В параметрах шаблона нельзя вписывать конструкции с фигурными скобками. Их можно заключать в Шаблон:Tag:
- {{safesubst:#invoke: Template call code | withParams | _tag = code }} → {{safesubst:#invoke: Template call code | withParams | _tag = code }}
Первый параметр (или только часть с названием шаблона) можно опускать — тогда его заменит название текущей страницы со строчной первой буквы:
- {{#invoke:Example|main}}
- {{#invoke:Example|main}}
- {{#invoke:Example|main}}
Настройки[править код]
_nobr
: запретить перенос на следующую строку внутри кода (при непустом значении параметра)._tag=kbd
: использовать тег Шаблон:Tago вместо Шаблон:Tago._style
: CSS для тега._spaced
: отбить параметры шаблона пробелами (при непустом значении параметра):- {{#invoke:Example|main}}
В оформлении документации[править код]
Помимо примеров, с помощью шаблона можно изящно записывать синтаксис шаблонов в документации. При этом курсивом выделяются «плейсхолдеры» (Шаблон:Lang-en, буквально — «держатели места») параметров шаблона, или их описания, чтобы не спутать их с непосредственным содержанием параметров. Шаблоном {{optp}}, в свою очередь, можно выделять необязательные параметры, которые отобразятся серым цветом.
Пример:
- Шаблон:Pre
- Шаблон:Sp↓
- {{safesubst:#invoke: Template call code | withParams | _tag = code }}Шаблон:PbШаблон:Optp/comment
Обратите внимание, что в описании параметров здесь имитируется вид реального содержания параметров: в соответствии с ним выбирается заглавная или строчная буква, ставится или не ставится точка (в данном примере к названию раздела или якоря добавлен знак решётки). Это делается для того, чтобы по одному взгляду на синтаксис шаблона можно было понять, как его надо использовать.
Многострочные примеры использования шаблонов можно давать не только посредством тега Шаблон:Tago, который не поддерживает разметку внутри себя, но и при помощи пробела в начале строк или (что менее удобно) шаблона {{pre}} (а также {{*pre}}, позволяющего использовать тег Шаблон:Tago с маркерами списка при такой необходимости).
См. также[править код]
- {{pre}} — функционал тега Шаблон:Tago с возможностью использования разметки
Шаблон:Шаблоны для документирования