Шаблон:Tc/doc - История изменений

Pok: Перенаправление на Шаблон:Код шаблона/doc

2025-04-08T23:03:26Z

Перенаправление на Шаблон:Код шаблона/doc

← Предыдущая версия		Версия от 02:03, 9 апреля 2025
Строка 1:		Строка 1:
	~~{{docpage}}~~		#перенаправление [[Шаблон:Код шаблона/doc]]
	~~{{onLua\|Template call code\|withParams}}~~
	Шаблон '''{{t}}''' позволяет показать код включения шаблона. Он является лаконичной альтернативой конструкции {{tag\|code\|content=<nowiki>...</nowiki>}}.

	~~Разные способы привести код включения шаблона в документации:~~

	{\|
	~~! Используя {{tago\|code}} + {{tago\|nowiki}} !! Результат~~
	\|-
	~~\| <code><nowiki><code><nowiki>{{шаблон\|параметр}}</nowiki></code></nowiki></code>~~
	~~\| <code><nowiki>{{шаблон\|параметр}}</nowiki></code>~~
	\|-
	~~\| <code><nowiki><code><nowiki>{{шаблон\|а=б}}</nowiki></code></nowiki></code>~~
	~~\| <code><nowiki>{{шаблон\|а=б}}</nowiki></code>~~
	\|-
	~~\| <code><nowiki><code><nowiki>{{шаблон\|параметр=значение\|{{IPA\|/tʃ/}}}}</nowiki></code></nowiki></code>~~
	~~\| <code><nowiki>{{шаблон\|параметр=значение\|{{IPA\|/tʃ/}}}}</nowiki></code>~~
	\|-
	~~! Используя {{t}} !! Результат~~
	\|-
	~~\| <code><nowiki>{{tc\|шаблон\|параметр}}</nowiki></code>~~
	~~\| {{tc\|шаблон\|параметр}}~~
	\|-
	~~\| <code><nowiki>{{tc\|шаблон\|а{{=}}б}}</nowiki></code>~~
	~~\| {{tc\|шаблон\|а{{=}}б}}~~
	\|-
	~~\| <code><nowiki>{{tc\|шаблон\|параметр{{=}}значение\|<nowiki>{{IPA\|/tʃ/}}</nowiki>}}</nowiki></code>~~
	~~\| {{tc\|шаблон\|параметр{{=}}значение\|<nowiki>{{IPA\|/tʃ/}}</nowiki>}}~~
	\|}

	~~{{TOC right}}~~

	~~== Использование ==~~
	* {{пример\|\|шаблон\|параметр}}
	* {{пример\|\|шаблон\|параметр=значение}}
	* {{пример\|\|шаблон\|параметр 1\|\|\|параметр 4}}
	* {{пример\|\|подст:шаблон\|параметр}}

	'''Важно:''' хотя шаблон и способен отобразить параметры, которые переданы в него как именованные, то есть такие, где название параметра и значение разделены знаком «=» (благодаря использованию модуля [[Модуль:ParamValue2Value\|ParamValue2Value]]), такие параметры в настоящий момент переносятся в конец списка, а их порядок искажается. Чтобы этого избежать, заменяйте знак «=» на {{tcl\|=}} или забирайте параметры в {{tag\|nowiki}}. Также это следует проделывать для параметров, имена которых начинаются со знака подчеркивания, иначе они не отобразятся.

	~~В параметрах шаблона нельзя вписывать конструкции с фигурными скобками. Их можно заключать в {{tag\|nowiki}}:~~
	* {{tc\|\|<nowiki>шаблон\|<nowiki>{{IPA\|/tʃ/}}</nowiki></nowiki>}} → {{tc\|шаблон\|<nowiki>{{IPA\|/tʃ/}}</nowiki>}}

	Первый параметр (или только часть с названием шаблона) можно опускать — тогда его заменит название текущей страницы со строчной первой буквы:
	* {{пример\|\|\|параметр}}
	* {{пример\|\|подст:\|параметр}}
	* {{пример\|\|subst:\|параметр}}

	~~=== Настройки ===~~
	* <code>_nobr</code>: запретить перенос на следующую строку внутри кода (при непустом значении параметра).
	* <code>_tag=kbd</code>: использовать тег {{tago\|kbd}} вместо {{tago\|code}}.
	* <code>_style</code>: ~~[[CSS]] для тега.~~
	* <code>_spaced</code>: отбить параметры шаблона ~~пробелами (при непустом значении параметра):~~
	*: {{пример\|\|ш\|параметр 1{{((}}{{=}}{{))}}значение\|параметр 2{{((}}{{=}}{{))}}значение\|_spaced{{=}}1}}

	=== <!-- На этот раздел есть ссылки на страницах t:optp, t:tlc, t:pre, при переименовании измените и их --> В оформлении документации ===
	Помимо примеров, с помощью шаблона можно изящно записывать синтаксис шаблонов в документации. При этом курсивом выделяются «плейсхолдеры» ({{lang-en\|placeholders}}, буквально — «держатели места») параметров шаблона, или их описания, чтобы не спутать их с непосредственным содержанием параметров. Шаблоном {{t\|optp}}, в свою очередь, можно выделять необязательные параметры, которые отобразятся серым цветом.

	~~Пример:~~
	~~: {{pre\|<nowiki>{{tc\|</nowiki>[[Шаблон:Переход\|переход]]<nowiki>\|''#Раздел или #якорь''{{optp\|''тип значка''\|''Название раздела''}}}}~~

	~~{{optp/comment}}<~~/~~nowiki>}}~~
	~~: {{sp↓}}~~
	~~: {{tc\|переход\|''#Раздел или #якорь''{{optp\|''тип значка''\|''Название раздела''}}}}{{optp/comment}}~~

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

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

	~~== См. также ==~~
	* {{t\|pre}} — функционал тега {{tago\|pre}} с возможностью использования разметки

	~~{{шаблоны для документирования}}~~

	~~<includeonly>~~
	~~[[Категория:Шаблоны:Для документирования шаблонов~~]]
	~~[[Категория:Шаблоны:Для облегчения набора]]~~
	~~</includeonly>~~

Pok в 14:37, 5 апреля 2025

2025-04-05T14:37:11Z

← Предыдущая версия		Версия от 17:37, 5 апреля 2025
Строка 37:		Строка 37:
	* {{пример\|\|подст:шаблон\|параметр}}		* {{пример\|\|подст:шаблон\|параметр}}

	{{~~tc/~~=}}		'''Важно:''' хотя шаблон и способен отобразить параметры, которые переданы в него как именованные, то есть такие, где название параметра и значение разделены знаком «=» (благодаря использованию модуля [[Модуль:ParamValue2Value\|ParamValue2Value]]), такие параметры в настоящий момент переносятся в конец списка, а их порядок искажается. Чтобы этого избежать, заменяйте знак «=» на {{tcl\|=}} или забирайте параметры в {{tag\|nowiki}}. Также это следует проделывать для параметров, имена которых начинаются со знака подчеркивания, иначе они не отобразятся.

	В параметрах шаблона нельзя вписывать конструкции с фигурными скобками. Их можно заключать в {{tag\|nowiki}}:		В параметрах шаблона нельзя вписывать конструкции с фигурными скобками. Их можно заключать в {{tag\|nowiki}}:

Pok: Новая страница: «{{docpage}} {{onLua|Template call code|withParams}} Шаблон '''{{t}}''' позволяет показать код включения шаблона. Он является лаконичной альтернативой конструкции {{tag|code|content=<nowiki>...</nowiki>}}. Разные способы привести код включения шаблона в документации: {| ! Используя {{tago|code}} + {{tago|n...»

2025-04-05T14:35:27Z

Новая страница: «{{docpage}} {{onLua|Template call code|withParams}} Шаблон '''{{t}}''' позволяет показать код включения шаблона. Он является лаконичной альтернативой конструкции {{tag|code|content=<nowiki>...</nowiki>}}. Разные способы привести код включения шаблона в документации: {| ! Используя {{tago|code}} + {{tago|n...»

Новая страница

{{docpage}}
{{onLua|Template call code|withParams}}
Шаблон '''{{t}}''' позволяет показать код включения шаблона. Он является лаконичной альтернативой конструкции {{tag|code|content=<nowiki>...</nowiki>}}.

Разные способы привести код включения шаблона в документации:

{|
! Используя {{tago|code}} + {{tago|nowiki}} !! Результат
|-
| <code><nowiki><code><nowiki>{{шаблон|параметр}}</nowiki></code></nowiki></code>
| <code><nowiki>{{шаблон|параметр}}</nowiki></code>
|-
| <code><nowiki><code><nowiki>{{шаблон|а=б}}</nowiki></code></nowiki></code>
| <code><nowiki>{{шаблон|а=б}}</nowiki></code>
|-
| <code><nowiki><code><nowiki>{{шаблон|параметр=значение|{{IPA|/tʃ/}}}}</nowiki></code></nowiki></code>
| <code><nowiki>{{шаблон|параметр=значение|{{IPA|/tʃ/}}}}</nowiki></code>
|-
! Используя {{t}} !! Результат
|-
| <code><nowiki>{{tc|шаблон|параметр}}</nowiki></code>
| {{tc|шаблон|параметр}}
|-
| <code><nowiki>{{tc|шаблон|а{{=}}б}}</nowiki></code>
| {{tc|шаблон|а{{=}}б}}
|-
| <code><nowiki>{{tc|шаблон|параметр{{=}}значение|<nowiki>{{IPA|/tʃ/}}</nowiki>}}</nowiki></code>
| {{tc|шаблон|параметр{{=}}значение|<nowiki>{{IPA|/tʃ/}}</nowiki>}}
|}

{{TOC right}}

== Использование ==
* {{пример||шаблон|параметр}}
* {{пример||шаблон|параметр=значение}}
* {{пример||шаблон|параметр 1|||параметр 4}}
* {{пример||подст:шаблон|параметр}}

{{tc/=}}

В параметрах шаблона нельзя вписывать конструкции с фигурными скобками. Их можно заключать в {{tag|nowiki}}:
* {{tc||<nowiki>шаблон|<nowiki>{{IPA|/tʃ/}}</nowiki></nowiki>}} → {{tc|шаблон|<nowiki>{{IPA|/tʃ/}}</nowiki>}}

Первый параметр (или только часть с названием шаблона) можно опускать — тогда его заменит название текущей страницы со строчной первой буквы:
* {{пример|||параметр}}
* {{пример||подст:|параметр}}
* {{пример||subst:|параметр}}

=== Настройки ===
* <code>_nobr</code>: запретить перенос на следующую строку внутри кода (при непустом значении параметра).
* <code>_tag=kbd</code>: использовать тег {{tago|kbd}} вместо {{tago|code}}.
* <code>_style</code>: [[CSS]] для тега.
* <code>_spaced</code>: отбить параметры шаблона пробелами (при непустом значении параметра):
*: {{пример||ш|параметр 1{{((}}{{=}}{{))}}значение|параметр 2{{((}}{{=}}{{))}}значение|_spaced{{=}}1}}

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

Пример:
: {{pre|<nowiki>{{tc|</nowiki>[[Шаблон:Переход|переход]]<nowiki>|''#Раздел или #якорь''{{optp|''тип значка''|''Название раздела''}}}}

{{optp/comment}}</nowiki>}}
: {{sp↓}}
: {{tc|переход|''#Раздел или #якорь''{{optp|''тип значка''|''Название раздела''}}}}{{optp/comment}}

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

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

== См. также ==
* {{t|pre}} — функционал тега {{tago|pre}} с возможностью использования разметки

{{шаблоны для документирования}}

<includeonly>
[[Категория:Шаблоны:Для документирования шаблонов]]
[[Категория:Шаблоны:Для облегчения набора]]
</includeonly>