Шаблон:Tlp/doc: различия между версиями
Andras (обсуждение | вклад) Нет описания правки |
Andras (обсуждение | вклад) мНет описания правки |
||
(не показаны 2 промежуточные версии этого же участника) | |||
Строка 1: | Строка 1: | ||
{{Docpage}} | {{Docpage}} | ||
{{OnLua|Template call code|withParams}}__NOTOC__ | {{OnLua|Template call code|withParams}}__NOTOC__ | ||
'''{{ | '''{{Tl|Tlp}}''' — шаблон для оформления ссылок на шаблоны с указанием параметров. | ||
== Использование == | == Использование == | ||
{{Tc||''имя шаблона''|''параметры''{{Optp|''настройки''|_lang{{=}}''код языкового раздела''|_sister{{=}}''код родственного проекта''|_text{{=}}''текст ссылки''}}}} | {{Tc|Tlp|''имя шаблона''|''параметры''{{Optp|''настройки''|_lang{{=}}''код языкового раздела''|_sister{{=}}''код родственного проекта''|_text{{=}}''текст ссылки''}}}} | ||
Все параметры являются необязательными. Чёрным цветом даны базовые параметры, серым — дополнительные{{Sp/}}редко используемые. | Все параметры являются необязательными. Чёрным цветом даны базовые параметры, серым — дополнительные{{Sp/}}редко используемые. | ||
Строка 19: | Строка 19: | ||
* <code>_u</code>''':''' вывести имя шаблона с заглавной буквы. Работает только при опущенном первом параметре. | * <code>_u</code>''':''' вывести имя шаблона с заглавной буквы. Работает только при опущенном первом параметре. | ||
* <code>_b</code> (от ''black'')''':''' не использовать оформление (серый цвет текста; чтобы названия шаблонов смотрелись опрятно в коде). | * <code>_b</code> (от ''black'')''':''' не использовать оформление (серый цвет текста; чтобы названия шаблонов смотрелись опрятно в коде). | ||
* <code>_nav</code>''':''' при использовании шаблона в рамках блока навигации. Благодаря этой | * <code>_nav</code>''':''' при использовании шаблона в рамках блока навигации. Благодаря этой настройке, когда вы находитесь на той странице, на которую должна вести ссылка, название шаблона выделяется курсивом, что удобно для восприятия блоков навигации. Например, так сделано в навигационном шаблоне {{Tl|Языковые шаблоны}} для шаблонов {{Tl|Tl}}. Работает только при указанном первом параметре. | ||
* <code>_nobr</code>''':''' запретить перенос на следующую строку в середине кода. | * <code>_nobr</code>''':''' запретить перенос на следующую строку в середине кода. | ||
== Примеры == | == Примеры == | ||
'''Базовые''' | '''Базовые''' | ||
* {{Пример|| | * {{Пример||Шаблон|параметр|_u=1}} | ||
* {{Пример|| | * {{Пример||Шаблон|параметр=значение|_u=1}} | ||
* {{Пример|| | * {{Пример||Шаблон|параметр 1|||параметр 4|_u=1}} | ||
* {{Пример|| | * {{Пример||Шаблон|<nowiki><nowiki>{{IPA|/tʃ/}}</nowiki></nowiki>|_u=1}} | ||
* {{Пример|||параметр}} (в качестве названия шаблона выводит название той страницы, на которой вы находитесь) | * {{Пример|||параметр|_u=1}} (в качестве названия шаблона выводит название той страницы, на которой вы находитесь) | ||
{{^}} | {{^}} | ||
'''Настройки''' | '''Настройки''' | ||
* {{Пример|| | * {{Пример||Шаблон|параметр|_nolink{{=}}1|_u=1}} | ||
* {{Пример|| | * {{Пример||Шаблон|параметр|_п{{=}}1|_u=1}} | ||
* {{Пример|||параметр|_u{{=}}1}} | * {{Пример|||параметр|_u{{=}}1|_u=1}} | ||
* {{Пример|| | * {{Пример||Шаблон|параметр|_b{{=}}1|_u=1}} | ||
{{^}} | {{^}} | ||
Параметр {{Cn| | Параметр {{Cn|_Nav}}''':''' | ||
* {{Пример|Tlp|Tl|''шаблон''|_nav{{=}}1}} | |||
* {{Пример|Tlp|Tlp|''шаблон''|''параметры''|_nav{{=}}1}} | |||
{{ | * {{Пример|Tlp|Tc|''шаблон''|''параметры''|_nav{{=}}1}} | ||
* {{Пример|Tlp|Tcl|''шаблон''|''параметры''|_nav{{=}}1}} | |||
{{^}} | {{^}} | ||
'''Остальные параметры''' | '''Остальные параметры''' | ||
* {{Пример|| | * {{Пример||Lang|''слово на иностранном языке''|_text{{=}}Lang-''xx''|_u=1}} | ||
* {{Пример|| | * {{Пример||Template|parameter|_lang{{=}}en|_sister{{=}}q|_u=1}} | ||
== Детали == | == Детали == | ||
* Если шаблон используется без первого параметра, а в названии страницы есть слэш, то, что идёт после него, опускается. | * Если шаблон используется без первого параметра, а в названии страницы есть слэш, то, что идёт после него, опускается. | ||
* Шаблон понимает идентичность адресов ''Участник:Некий участник'' и ''Участник:Некий'''_'''участник'' и использует особые приёмы, чтобы обходить баги/особенности вики-движка, связанные с использованием символов «*», «:», «;» и т. п. на первом месте в названиях шаблонов или тексте ссылок. Не смутит его и замена символов их [[мнемоники в HTML|HTML-кодами]], типа {{Amp|#47}} для «/». | * Шаблон понимает идентичность адресов ''Участник:Некий участник'' и ''Участник:Некий'''_'''участник'' и использует особые приёмы, чтобы обходить баги/особенности вики-движка, связанные с использованием символов «*», «:», «;» и т. п. на первом месте в названиях шаблонов или тексте ссылок. Не смутит его и замена символов их [[мнемоники в HTML|HTML-кодами]], типа {{Amp|#47}} для «/». | ||
* Код шаблона устроен подобно коду {{ | * Код шаблона устроен подобно коду {{Tl|Tl}}. | ||
{{Шаблоны для документирования}} | {{Шаблоны для документирования}} |
Текущая версия от 18:07, 27 февраля 2024
![]() |
![]() | Этот шаблон реализован на основе Lua с использованием функции withParams() из модуля Template call code. |
{{Tlp}} — шаблон для оформления ссылок на шаблоны с указанием параметров.
Использование
{{Tlp|имя шаблона|параметры|настройки|_lang=код языкового раздела|_sister=код родственного проекта|_text=текст ссылки}}
Все параметры являются необязательными. Чёрным цветом даны базовые параметры, серым — дополнительные / редко используемые.
Важно: хотя шаблон и способен отобразить параметры, которые переданы в него как именованные, то есть такие, где название параметра и значение разделены знаком «=» (благодаря использованию модуля ParamValue2Value), такие параметры в настоящий момент переносятся в конец списка, а их порядок искажается. Чтобы этого избежать, заменяйте знак «=» на {{=}}
или забирайте параметры в <Nowiki></Nowiki>
. Также это следует проделывать для параметров, имена которых начинаются со знака подчеркивания, иначе они не отобразятся.
В параметрах шаблона нельзя вписывать конструкции с фигурными скобками. Их можно заключать в <Nowiki></Nowiki>
; см. Примеры.
Если использовать шаблон без первого параметра, то в качестве названия шаблона он выведет название текущей страницы (после двоеточия) со строчной первой буквы (это бывает полезно при упоминании шаблона в его собственной документации, особенно когда используется одна документация на несколько шаблонов).
Настройки записываются как булевы значения («истина» / «ложь») параметров-переключателей, например _u=1
— «истина» (подойдёт любое непустое значение). Параметры-переключатели включают в себя:
_nl
(_nolink
): подавить ссылку._s
и_п
: вывести ключевое слово «subst:» и «подст:» соответственно перед именем шаблона (можно просто дописать «subst:» или «подст:» в название шаблона)._u
: вывести имя шаблона с заглавной буквы. Работает только при опущенном первом параметре._b
(от black): не использовать оформление (серый цвет текста; чтобы названия шаблонов смотрелись опрятно в коде)._nav
: при использовании шаблона в рамках блока навигации. Благодаря этой настройке, когда вы находитесь на той странице, на которую должна вести ссылка, название шаблона выделяется курсивом, что удобно для восприятия блоков навигации. Например, так сделано в навигационном шаблоне {{Языковые шаблоны}} для шаблонов {{Tl}}. Работает только при указанном первом параметре._nobr
: запретить перенос на следующую строку в середине кода.
Примеры
Базовые
{{Tlp|Шаблон|параметр}}
→ {{Шаблон|параметр}}{{Tlp|Шаблон|параметр=значение}}
→ {{Шаблон|параметр=значение}}{{Tlp|Шаблон|параметр 1|||параметр 4}}
→ {{Шаблон|параметр 1|||параметр 4}}{{Tlp|Шаблон|<nowiki>{{IPA|/tʃ/}}</nowiki>}}
→ {{Шаблон|{{IPA|/tʃ/}}}}{{Tlp||параметр}}
→ {{Tlp|параметр}} (в качестве названия шаблона выводит название той страницы, на которой вы находитесь)
Настройки
{{Tlp|Шаблон|параметр|_nolink=1}}
→ {{Шаблон|параметр}}{{Tlp|Шаблон|параметр|_п=1}}
→ {{подст:Шаблон|параметр}}{{Tlp||параметр|_u=1}}
→ {{Tlp|параметр}}{{Tlp|Шаблон|параметр|_b=1}}
→ {{Шаблон|параметр}}
Параметр _Nav
:
{{Tlp|Tl|''шаблон''|_nav=1}}
→ {{Tl|шаблон}}{{Tlp|Tlp|''шаблон''|''параметры''|_nav=1}}
→ {{Tlp|шаблон|параметры}}{{Tlp|Tc|''шаблон''|''параметры''|_nav=1}}
→ {{Tc|шаблон|параметры}}{{Tlp|Tcl|''шаблон''|''параметры''|_nav=1}}
→ {{Tcl|шаблон|параметры}}
Остальные параметры
{{Tlp|Lang|''слово на иностранном языке''|_text=Lang-''xx''}}
→ {{Lang-xx|слово на иностранном языке}}{{Tlp|Template|parameter|_lang=en|_sister=q}}
→ {{Template|parameter}}
Детали
- Если шаблон используется без первого параметра, а в названии страницы есть слэш, то, что идёт после него, опускается.
- Шаблон понимает идентичность адресов Участник:Некий участник и Участник:Некий_участник и использует особые приёмы, чтобы обходить баги/особенности вики-движка, связанные с использованием символов «*», «:», «;» и т. п. на первом месте в названиях шаблонов или тексте ссылок. Не смутит его и замена символов их HTML-кодами, типа
/
для «/». - Код шаблона устроен подобно коду {{Tl}}.