Шаблон:Tl/doc: различия между версиями
Перейти к навигации
Перейти к поиску
Andras (обсуждение | вклад) Нет описания правки |
Andras (обсуждение | вклад) Нет описания правки |
||
| Строка 9: | Строка 9: | ||
== Использование == | == Использование == | ||
{{ | {{Tc||''имя шаблона или страницы''|''флаги''|lang{{=}}''код языкового раздела''|sister{{=}}''код родственного проекта''|text{{=}}''текст ссылки''|comment{{=}}''всплывающая подсказка''}} | ||
Все параметры являются необязательными. | Все параметры являются необязательными. | ||
| Строка 20: | Строка 20: | ||
* <code>nl</code> (<code>nolink</code>): подавить ссылку. | * <code>nl</code> (<code>nolink</code>): подавить ссылку. | ||
* <code>s</code> и <code>п</code>: вывести ключевое слово [[ВП:Подстановка шаблонов|<nowiki>«subst:» и «подст:»</nowiki>]] соответственно перед именем шаблона. | * <code>s</code> и <code>п</code>: вывести ключевое слово [[ВП:Подстановка шаблонов|<nowiki>«subst:» и «подст:»</nowiki>]] соответственно перед именем шаблона. | ||
* <code>g</code> (от {{lang-en|global}}): ссылаться по умолчанию на основное [[Википедия:Пространства имён|пространство имён]] вместо пространства шаблонов. Этот флаг включается автоматически, если первым символом в названии шаблона или страницы является двоеточие, например '':Страница'' или ''<nowiki>:Участник:Некий участник/подстраница</nowiki>'' (вики-движок интерпретирует начальное двоеточие в названии страницы в фигурных скобках как ссылку на корневое пространство; так, {{ | * <code>g</code> (от {{lang-en|global}}): ссылаться по умолчанию на основное [[Википедия:Пространства имён|пространство имён]] вместо пространства шаблонов. Этот флаг включается автоматически, если первым символом в названии шаблона или страницы является двоеточие, например '':Страница'' или ''<nowiki>:Участник:Некий участник/подстраница</nowiki>'' (вики-движок интерпретирует начальное двоеточие в названии страницы в фигурных скобках как ссылку на корневое пространство; так, {{Tc|:Страница}} включит содержимое соответствующей страницы Википедии в текущую страницу). | ||
* <code>nav</code>: при использовании шаблона в блоках навигации. Благодаря этому флагу, когда вы находитесь на той странице, на которую должна вести ссылка, название шаблона выделяется жирным. Например, так сделано в навигационном шаблоне {{t|Языковые шаблоны}}. Работает только при указанном первом параметре. Доступен шаблон-обёртка {{t|tnav}}. | * <code>nav</code>: при использовании шаблона в блоках навигации. Благодаря этому флагу, когда вы находитесь на той странице, на которую должна вести ссылка, название шаблона выделяется жирным. Например, так сделано в навигационном шаблоне {{t|Языковые шаблоны}}. Работает только при указанном первом параметре. Доступен шаблон-обёртка {{t|tnav}}. | ||
* <code>noredir</code>: если ссылка ведёт на перенаправление, не перенаправлять (параметр URL ''?redirect=no''; используется, например, в {{t|днш}}). | * <code>noredir</code>: если ссылка ведёт на перенаправление, не перенаправлять (параметр URL ''?redirect=no''; используется, например, в {{t|днш}}). | ||
| Строка 32: | Строка 32: | ||
== Примеры == | == Примеры == | ||
=== Базовые === | === Базовые === | ||
* {{ | * {{Tc|t}} → {{t}} (выводит название той страницы, на которой вы находитесь) | ||
* {{ | * {{Tc||t}} → {{t|t}} | ||
* {{ | * {{Tc||шаблон}} → {{t|шаблон}} | ||
* {{ | * {{Tc||:Страница}} → {{t|:Страница}} | ||
Внешний вид этих примеров [наличие ссылки] будет отличаться на основной странице шаблона и на странице документации, [[Шаблон:T/doc]]. | Внешний вид этих примеров [наличие ссылки] будет отличаться на основной странице шаблона и на странице документации, [[Шаблон:T/doc]]. | ||
=== Флаги === | === Флаги === | ||
* {{ | * {{Tc||шаблон|nolink}} → {{t|шаблон|nolink}} | ||
* {{ | * {{Tc||шаблон|п}} → {{t|шаблон|п}} | ||
* {{ | * {{Tc||Участник:Jack who built the house/t|g}} → {{t|Участник:Jack who built the house/t|g}} | ||
* {{ | * {{Tc||шаблон|noredir}} → {{t|шаблон|noredir}} | ||
* {{ | * {{Tc|||u}} → {{t||u}} | ||
* {{ | * {{Tc||шаблон|b}} → {{t|шаблон|b}} | ||
{{^|1em}} | {{^|1em}} | ||
Флаг <code>nav</code> / шаблон {{t|tnav}}: | Флаг <code>nav</code> / шаблон {{t|tnav}}: | ||
<pre>{{tnav|t}}{{*}}{{tnav|tp}}{{*}}{{tnav| | <pre>{{tnav|t}}{{*}}{{tnav|tp}}{{*}}{{tnav|Tc}}{{*}}{{tnav|tlc}}</pre> | ||
{{sp↓}} | {{sp↓}} | ||
{{tnav|t}}{{*}}{{tnav|tp}}{{*}}{{tnav| | {{tnav|t}}{{*}}{{tnav|tp}}{{*}}{{tnav|Tc}}{{*}}{{tnav|tlc}} | ||
{{^|1em}} | {{^|1em}} | ||
Сразу несколько: | Сразу несколько: | ||
* {{ | * {{Tc|||nl|s|u|b}} → {{t||nl|s|u|b}} | ||
* {{ | * {{Tc||Участник:Jack who built the house/t|п|g|b}} → {{t|Участник:Jack who built the house/t|п|g|b}} | ||
=== Остальные параметры === | === Остальные параметры === | ||
* {{ | * {{Tc||lang|<nowiki>text=lang-''xx''</nowiki>}} → {{t|lang|text=lang-''xx''}} | ||
* {{Пример||Удалялось|comment{{=}}Статья удалялась, но была восстановлена или была оставлена страница обсуждения удалённой статьи}} | * {{Пример||Удалялось|comment{{=}}Статья удалялась, но была восстановлена или была оставлена страница обсуждения удалённой статьи}} | ||
* {{ | * {{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名阴}} | ||
== Детали == | == Детали == | ||
Версия от 10:41, 9 мая 2023
 | Прежде чем вносить какие-либо изменения в данный шаблон, просьба оттестировать их в /песочнице и проверить результат на странице с /контрольными примерами. Изменения могут быть внесены после этого в данный шаблон всего одной правкой. |
 | Этот шаблон реализован на основе Lua с использованием функции withoutParams() из модуля Template call code. |
Шаблон:t — шаблон-комбайн для создания символической записи имён шаблонов или ссылок на них. С его помощью можно сослаться на шаблон (и не только) где угодно, с любым текстом ссылки или без неё.
Использование
{{Tl|имя шаблона или страницы|флаги|lang=код языкового раздела|sister=код родственного проекта|text=текст ссылки|comment=всплывающая подсказка}}
Все параметры являются необязательными.
Если использовать шаблон без параметров (или без первого параметра), то в фигурных скобках он выведет название текущей страницы (после двоеточия) со строчной первой буквы (это бывает полезно при упоминании шаблона в его собственной документации, особенно когда используется одна документация на несколько шаблонов).
Если использовать его с первым параметром, то он создаст ссылку на страницу, заданную в нём, за исключением случая, когда он уже находится на ней.
Флаги записываются через вертикальную черту, например nl|s|u, их может быть не больше четырёх. Список флагов:
nl(nolink): подавить ссылку.sип: вывести ключевое слово «subst:» и «подст:» соответственно перед именем шаблона.g(от Шаблон:lang-en): ссылаться по умолчанию на основное пространство имён вместо пространства шаблонов. Этот флаг включается автоматически, если первым символом в названии шаблона или страницы является двоеточие, например :Страница или :Участник:Некий участник/подстраница (вики-движок интерпретирует начальное двоеточие в названии страницы в фигурных скобках как ссылку на корневое пространство; так,{{:Страница}}включит содержимое соответствующей страницы Википедии в текущую страницу).nav: при использовании шаблона в блоках навигации. Благодаря этому флагу, когда вы находитесь на той странице, на которую должна вести ссылка, название шаблона выделяется жирным. Например, так сделано в навигационном шаблоне Шаблон:t. Работает только при указанном первом параметре. Доступен шаблон-обёртка Шаблон:t.noredir: если ссылка ведёт на перенаправление, не перенаправлять (параметр URL ?redirect=no; используется, например, в Шаблон:t).u: вывести имя шаблона с заглавной буквы. Работает только при опущенном первом параметре.b(от black): не использовать серый цвет текста для фигурных скобок (чтобы названия шаблонов смотрелись опрятно в коде).
Список кодов родственных проектов, записываемых в параметре |sister =, см. на странице Википедия:Интервики.
Для ссылок на шаблоны в английском разделе доступен шаблон-обёртка Шаблон:t.
Примеры
Базовые
{{t}}→ Шаблон:t (выводит название той страницы, на которой вы находитесь){{Tl|t}}→ Шаблон:t{{Tl|шаблон}}→ Шаблон:t{{Tl|:Страница}}→ Шаблон:t
Внешний вид этих примеров [наличие ссылки] будет отличаться на основной странице шаблона и на странице документации, Шаблон:T/doc.
Флаги
{{Tl|шаблон|nolink}}→ Шаблон:t{{Tl|шаблон|п}}→ Шаблон:t{{Tl|Участник:Jack who built the house/t|g}}→ Шаблон:t{{Tl|шаблон|noredir}}→ Шаблон:t{{Tl||u}}→ Шаблон:t{{Tl|шаблон|b}}→ Шаблон:t
Флаг nav / шаблон Шаблон:t:
{{tnav|t}}{{*}}{{tnav|tp}}{{*}}{{tnav|Tc}}{{*}}{{tnav|tlc}}
Шаблон:sp↓ Шаблон:tnavШаблон:*Шаблон:tnavШаблон:*Шаблон:tnavШаблон:*Шаблон:tnav
Сразу несколько:
Остальные параметры
{{Tl|lang|text=lang-''xx''}}→ Шаблон:t{{Tl|Удалялось|comment=Статья удалялась, но была восстановлена или была оставлена страница обсуждения удалённой статьи}}→ {{Удалялось}}{{Tl|template|lang=en|sister=q}}→ Шаблон:t
Суперкомбо
Представим, что нам понадобилось сослаться на шаблон в китайском викисловаре, используемый с подстановкой, который некий участник хранит в своём личном пространстве, а текст ссылки заменить на свой:
{{Tl|User:Shizhao/Template:ru-sy名阴|g|s|lang=zh|sister=wikt|text=ru-sy名阴}}→ Шаблон:t
Детали
- Если шаблон используется без первого параметра, а в названии страницы есть слэш, то, что идёт после него, опускается.
- Шаблон понимает идентичность адресов Участник:Некий участник и Участник:Некий_участник и использует особые приёмы, чтобы обходить баги/особенности вики-движка, связанные с использованием символов «*», «:», «;» и т. п. на первом месте в названиях шаблонов или тексте ссылок. Не смутит его и замена символов их HTML-кодами, типа / для «/».
- Если вы хотите поменять что-то в этом шаблоне, воспользуйтесь тестами на странице Шаблон:T/тесты для проверки его работоспособности после внесения изменений.
Можно сделать
- При ссылках на страницы в пространстве «Участник» и других (см. маску
Шаблон\:(Media|Служебная|Special|…на MediaWiki:Titleblacklist) также можно автоматически включать флагg, после чего нужда в ручном его указании останется только для других разделов. - Шаблон сейчас не работает с опущенным первым параметром вне пространства «Шаблон» (но не факт, что за его пределами нужны документации).
См. также
- Ссылки на шаблоны
- {{tRef}} — для таблиц с описаниями
- {{cl}} — для категорий
| Шаблоны для документирования | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Шаблоны |
| |||||||||||||||||||||||||||||||||||||
| Параметры | ||||||||||||||||||||||||||||||||||||||
| Теги | ||||||||||||||||||||||||||||||||||||||
| Примеры |
| |||||||||||||||||||||||||||||||||||||
