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

Материал из Викимультии — энциклопедии мультипликации
Перейти к навигации Перейти к поиску
[непроверенная версия][отпатрулированная версия]
Новая страница: «<noinclude>{{docpage}}</noinclude> Шаблон предназначен для ссылок на шаблоны из текста обсуждений или с…»
 
Нет описания правки
 
Строка 1: Строка 1:
<noinclude>{{docpage}}</noinclude>
{{docpage}}
Шаблон предназначен для ссылок на шаблоны из текста обсуждений или справки ('''tl''': '''t'''emplate '''l'''ink). При необходимости указывать также и параметры есть шаблон {{tl|tlp}}.
{{используйте песочницу}}
{{onLua|Template call code|withoutParams}}
'''{{t}}''' — шаблон-комбайн для создания символической записи имён шаблонов или ссылок на них. С его помощью можно сослаться на шаблон (и не только) где угодно, с любым текстом ссылки или без неё.


'''Если ссылка не нужна (нужно создать символическую запись ''документируемого'' шаблона), пишите просто {{tp|t}}.'''
{{днш|t|ш|шаблон}}


{{днш|шаблон|сш|ш}}
{{TOC right}}


== Использование ==
== Использование ==
{{tp|tl|wikify}} {{tl|wikify}}
{{tc||''имя шаблона или страницы''|''флаги''|lang{{=}}''код языкового раздела''|sister{{=}}''код родственного проекта''|text{{=}}''текст ссылки''|comment{{=}}''всплывающая подсказка''}}
 
Все параметры являются необязательными.
 
Если использовать шаблон без параметров (или без первого параметра), то в фигурных скобках он выведет название текущей страницы (после двоеточия) со строчной первой буквы (это бывает полезно при упоминании шаблона в его собственной документации, особенно когда используется одна документация на несколько шаблонов).
 
Если использовать его с первым параметром, то он создаст ссылку на страницу, заданную в нём, за исключением случая, когда он уже находится на ней.
 
Флаги записываются через вертикальную черту, например <code>nl|s|u</code>, их может быть не больше четырёх. Список флагов:
* <code>nl</code> (<code>nolink</code>): подавить ссылку.
* <code>s</code> и <code>п</code>: вывести ключевое слово <nowiki>«subst:» и «подст:»</nowiki> соответственно перед именем шаблона.
* <code>g</code> (от {{lang-en|global}}): ссылаться по умолчанию на основное пространство имён вместо пространства шаблонов. Этот флаг включается автоматически, если первым символом в названии шаблона или страницы является двоеточие, например '':Страница'' или ''<nowiki>:Участник:Некий участник/подстраница</nowiki>'' (вики-движок интерпретирует начальное двоеточие в названии страницы в фигурных скобках как ссылку на корневое пространство).
* <code>nav</code>: при использовании шаблона в блоках навигации. Благодаря этому флагу, когда вы находитесь на той странице, на которую должна вести ссылка, название шаблона выделяется жирным. Работает только при указанном первом параметре. Доступен шаблон-обёртка {{t|tnav}}.
* <code>noredir</code>: если ссылка ведёт на перенаправление, не перенаправлять (параметр URL ''?redirect=no''; используется, например, в {{t|днш}}).
* <code>u</code>: вывести имя шаблона с заглавной буквы. Работает только при опущенном первом параметре.
* <code>b</code> (от ''black''): не использовать серый цвет текста для фигурных скобок (чтобы названия шаблонов смотрелись опрятно в коде).
 
Список кодов родственных проектов, записываемых в параметре {{para|sister}}.
 
== Примеры ==
=== Базовые ===
* {{tc|t}} → {{t}} &nbsp;(выводит название той страницы, на которой вы находитесь)
* {{tc||t}} → {{t|t}}
* {{tc||шаблон}} → {{t|шаблон}}
 
Внешний вид этих примеров [наличие ссылки] будет отличаться на основной странице шаблона и на странице документации, [[Шаблон:T/doc]].
 
=== Флаги ===
* {{tc||шаблон|nolink}} → {{t|шаблон|nolink}}
* {{tc||шаблон|п}} → {{t|шаблон|п}}
* {{tc||шаблон|noredir}} → {{t|шаблон|noredir}}
* {{tc|||u}} → {{t||u}}
* {{tc||шаблон|b}} → {{t|шаблон|b}}
 
{{^|1em}}
Флаг <code>nav</code> / шаблон {{t|tnav}}:
<pre>{{tnav|t}}{{·}}{{tnav|tp}}{{·}}{{tnav|tc}}{{·}}{{tnav|tlc}}</pre>
{{sp↓}}
{{tnav|t}}{{·}}{{tnav|tp}}{{·}}{{tnav|tc}}{{·}}{{tnav|tlc}}
 
{{^|1em}}
Сразу несколько:
* {{tc|||nl|s|u|b}} → {{t||nl|s|u|b}}
 
=== Остальные параметры ===
* {{tc||lang|<nowiki>text=lang-''xx''</nowiki>}} → {{t|lang|text=lang-''xx''}}
* {{tc||template|<nowiki>lang=en|sister=q</nowiki>}} → {{t|template|lang=en|sister=q}}
 
=== Суперкомбо ===
Представим, что нам понадобилось сослаться на шаблон в китайском викисловаре, используемый с подстановкой, который некий участник хранит в своём личном пространстве, а текст ссылки заменить на свой:
* {{tc||User:Shizhao/Template:ru-sy名阴|g|s|<nowiki>lang=zh|sister=wikt|text=ru-sy名阴</nowiki>}} → {{t|User:Shizhao/Template:ru-sy名阴|g|s|lang=zh|sister=wikt|text=ru-sy名阴}}
 
== Детали ==
* Если шаблон используется без первого параметра, а в названии страницы есть слэш, то, что идёт после него, опускается.
* Шаблон понимает идентичность адресов ''<nowiki>Участник:Некий участник</nowiki>'' и ''<nowiki>Участник:Некий</nowiki>'''_'''участник'' и использует особые приёмы, чтобы обходить баги/особенности вики-движка, связанные с использованием символов «*», «:», «;» и т. п. на первом месте в названиях шаблонов или тексте ссылок. Не смутит его и замена символов их HTML-кодами, типа &amp;#47; для «&#47;».
* Если вы хотите поменять что-то в этом шаблоне, воспользуйтесь тестами на странице [[Шаблон:T/тесты]] для проверки его работоспособности после внесения изменений.
 
== Можно сделать ==
* При ссылках на страницы в пространстве «Участник» и других (см. маску <code>Шаблон\:(Media|Служебная|Special|…</code> на [[MediaWiki:Titleblacklist]]) также можно автоматически включать флаг <code>g</code>, после чего нужда в ручном его указании останется только для других разделов.
* Шаблон сейчас не работает с опущенным первым параметром вне пространства «Шаблон» (но не факт, что за его пределами нужны документации).
 
== См. также ==
* {{tl|tRef}} — для таблиц с описаниями
* {{tl|cl}} — для категорий


<includeonly>
<includeonly>
[[Категория:Викимультия:Шаблоны:Внутренние ссылки|{{PAGENAME}}]]
[[Категория:Шаблоны/модули, нуждающиеся в усовершенствовании]]
[[Категория:Шаблоны:Ссылки на шаблоны]]
[[Категория:Шаблоны:Для документирования шаблонов]]
</includeonly>
</includeonly>

Текущая версия от 14:45, 17 мая 2022

{{tl}} — шаблон-комбайн для создания символической записи имён шаблонов или ссылок на них. С его помощью можно сослаться на шаблон (и не только) где угодно, с любым текстом ссылки или без неё.

Другие названия этого шаблона: {{t}}, {{ш}}, {{шаблон}}.

Использование[править код]

{{tl|имя шаблона или страницы|флаги|lang=код языкового раздела|sister=код родственного проекта|text=текст ссылки|comment=всплывающая подсказка}}

Все параметры являются необязательными.

Если использовать шаблон без параметров (или без первого параметра), то в фигурных скобках он выведет название текущей страницы (после двоеточия) со строчной первой буквы (это бывает полезно при упоминании шаблона в его собственной документации, особенно когда используется одна документация на несколько шаблонов).

Если использовать его с первым параметром, то он создаст ссылку на страницу, заданную в нём, за исключением случая, когда он уже находится на ней.

Флаги записываются через вертикальную черту, например nl|s|u, их может быть не больше четырёх. Список флагов:

  • nl (nolink): подавить ссылку.
  • s и п: вывести ключевое слово «subst:» и «подст:» соответственно перед именем шаблона.
  • g (от англ. global): ссылаться по умолчанию на основное пространство имён вместо пространства шаблонов. Этот флаг включается автоматически, если первым символом в названии шаблона или страницы является двоеточие, например :Страница или :Участник:Некий участник/подстраница (вики-движок интерпретирует начальное двоеточие в названии страницы в фигурных скобках как ссылку на корневое пространство).
  • nav: при использовании шаблона в блоках навигации. Благодаря этому флагу, когда вы находитесь на той странице, на которую должна вести ссылка, название шаблона выделяется жирным. Работает только при указанном первом параметре. Доступен шаблон-обёртка {{tnav}}.
  • noredir: если ссылка ведёт на перенаправление, не перенаправлять (параметр URL ?redirect=no; используется, например, в {{днш}}).
  • u: вывести имя шаблона с заглавной буквы. Работает только при опущенном первом параметре.
  • b (от black): не использовать серый цвет текста для фигурных скобок (чтобы названия шаблонов смотрелись опрятно в коде).

Список кодов родственных проектов, записываемых в параметре |sister=.

Примеры[править код]

Базовые[править код]

  • {{t}}{{tl}}  (выводит название той страницы, на которой вы находитесь)
  • {{tl|t}}{{t}}
  • {{tl|шаблон}}{{шаблон}}

Внешний вид этих примеров [наличие ссылки] будет отличаться на основной странице шаблона и на странице документации, Шаблон:T/doc.

Флаги[править код]

  • {{tl|шаблон|nolink}}{{шаблон}}
  • {{tl|шаблон|п}}{{подст:шаблон}}
  • {{tl|шаблон|noredir}}{{шаблон}}
  • {{tl||u}}{{Tl}}
  • {{tl|шаблон|b}} → {{шаблон}}

Флаг nav / шаблон {{tnav}}:

{{tnav|t}}{{·}}{{tnav|tp}}{{·}}{{tnav|tc}}{{·}}{{tnav|tlc}}

{{t}} · {{tp}} · {{tc}} · {{tlc}}

Сразу несколько:

  • {{tl||nl|s|u|b}} → {{subst:Tl}}

Остальные параметры[править код]

  • {{tl|lang|text=lang-''xx''}}{{lang-xx}}
  • {{tl|template|lang=en|sister=q}}{{template}}

Суперкомбо[править код]

Представим, что нам понадобилось сослаться на шаблон в китайском викисловаре, используемый с подстановкой, который некий участник хранит в своём личном пространстве, а текст ссылки заменить на свой:

  • {{tl|User:Shizhao/Template:ru-sy名阴|g|s|lang=zh|sister=wikt|text=ru-sy名阴}}{{subst:ru-sy名阴}}

Детали[править код]

  • Если шаблон используется без первого параметра, а в названии страницы есть слэш, то, что идёт после него, опускается.
  • Шаблон понимает идентичность адресов Участник:Некий участник и Участник:Некий_участник и использует особые приёмы, чтобы обходить баги/особенности вики-движка, связанные с использованием символов «*», «:», «;» и т. п. на первом месте в названиях шаблонов или тексте ссылок. Не смутит его и замена символов их HTML-кодами, типа / для «/».
  • Если вы хотите поменять что-то в этом шаблоне, воспользуйтесь тестами на странице Шаблон:T/тесты для проверки его работоспособности после внесения изменений.

Можно сделать[править код]

  • При ссылках на страницы в пространстве «Участник» и других (см. маску Шаблон\:(Media|Служебная|Special|… на MediaWiki:Titleblacklist) также можно автоматически включать флаг g, после чего нужда в ручном его указании останется только для других разделов.
  • Шаблон сейчас не работает с опущенным первым параметром вне пространства «Шаблон» (но не факт, что за его пределами нужны документации).

См. также[править код]

  • {{tRef}} — для таблиц с описаниями
  • {{cl}} — для категорий