Ло:Tc

Кечал я укхазара: Википеди
Перейти к навигации Перейти к поиску

{{tc}}

(i) Документация

Шаблон {{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ʃ/}}}}

Можно заключать в <nowiki></nowiki> и сразу все параметры, кроме первого:

  • {{tc|шаблон|<nowiki>параметр=значение|{{IPA|/tʃ/}}</nowiki>}}{{шаблон|параметр=значение|{{IPA|/tʃ/}}}}

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

  • {{tc||параметр}}{{tc|параметр}}

Настройки

Чтобы запретить перенос на следующую строку в середине кода, используйте непустое значение параметра |_nobr=.

Чтобы вместо тега <code> использовать <tt>, используйте |_tag=tt.

Если задать непустое значение параметру |_spaced=, параметры шаблона будут отбиты пробелами:

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

Если задать непустое значение параметру |_fullspaced=, параметры шаблона будут отбиты пробелами с обеих сторон:

  • {{tc|ш|параметр 1{{=}}значение|параметр 2{{=}}значение|_fullspaced=x}}{{ш | параметр 1=значение | параметр 2=значение }}

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

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

Пример:

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

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

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

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

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

Дело вкуса, но, если документируемый шаблон обычно занимает полную строку в вики-тексте (например, шаблоны-предупреждения), автор данного шаблона рекомендует использовать оформление, которое даёт тег <pre> / пробел в начале строки / шаблон {{pre}} (последние два случая — если нужно вставить разметку), а не то, которое даёт этот шаблон или комбинация <code> + <nowiki>.

См. также

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


Категория:Шаблоны:Ссылки на шаблоны Категория:Шаблоны:Для документирования шаблонов

Укх лерах пайда эцаш йола оагIонаш толхаергйоацаш хувцам бича мишта хул хьожаш тохкам бе хьай белха моттиге.