Редактирование: Шаблон:Пример/doc

{{Docpage}}<noinclude>{{К улучшению|2023-07-07}}</noinclude>
{{OnLua|Example}}
{{Hatnote}}
Этот шаблон выводит вики-текст включения шаблона (в общем случае с параметрами) и само это включение. Он в основном предназначен для упрощения оформления примеров использования шаблонов в документациях.

В данный момент шаблон не может использоваться для оформления примеров шаблонов с многострочным кодом и содержащих шаблоны внутри шаблона. (Хотя это технически реализуемо, см. [[Обсуждение шаблона:Пример#Напутствие шаблонописателям|обсуждение]].)

Для вывода групп примеров пользуйтесь шаблонами {{T|Стопка примеров}} (списком) и {{T|Таблица примеров}} (таблицей).

{{TOC right}}

== Использование ==
* <code><nowiki>{{Пример|Tl|Tl}}</nowiki></code> даст {{Пример|Tl|Tl}}
* <code><nowiki>{{Пример|Replace|something|some|any}}</nowiki></code> даст {{Пример|Replace|something|some|any}}
* <code><nowiki>{{Пример|Tcl|шаблон|параметр 1|||параметр 4}}</nowiki></code> даст {{Пример|Tcl|Шаблон|параметр 1|||параметр 4}}
* <code><nowiki>{{Пример|Tl|:en:Template:Example|text=English Template:Example}}</nowiki></code> даст {{Пример|Tl|:en:Template:Example|text=English Template:Example}}
* <code><nowiki>{{Пример|Replace|something|some|any|_comment=Заменить все вхождения «some» на «any».}}</nowiki></code> даст {{Пример|Replace|something|some|any|_comment=Заменить все вхождения «some» на «any».}}

Первый параметр можно опускать — тогда его заменит название базовой страницы со строчной первой буквы. Например, в документации шаблона {{T|Tr-en}} <code><nowiki>{{Пример||слово}}</nowiki></code> даст:
: {{Пример|Tr-en|слово}}
Это может быть особенно удобно для групп шаблонов, для которых пишется общая документация, размещаемая на каждой странице. А {{Tc|Пример}} выведет пример включения шаблона, на странице которого этот код размещён, без параметров.

Для наглядности можно также указывать имя шаблона через параметр '''_template''', при этом первый параметр больше не значит имя шаблона:
* <code><nowiki>{{Пример|_template=T|Пример}}</nowiki></code> даст {{Пример|_template=T|Пример}}

== Ограничения и пути их обхода ==
При опускании первого параметра используется именно имя корневой страницы — {{Mwmw|ROOTPAGENAME}}, а не проверка на суффиксы {{Code|/doc}} или иные, так что для шаблонов, которые являются подстраницами других шаблонов (например, [[Special:PrefixIndex/Template:Userbox/|юзербоксов]]), первый параметр опускать нельзя. 

Модуль переносит все именованные параметры в конец, а также плохо сохраняет порядок следования именованных параметров, если их больше одного (из-за технического несовершенства ПО). Чтобы этого избежать, используйте {{Tcl|=}} вместо <code>=</code>:
{|
| valign=top | [[Файл:Red x.svg|15px]] || <code><nowiki>{{Пример|Некий шаблон|parameter1=value|parameter2=value|parameter3=value}}</nowiki></code> даст:<br
/>{{Пример|Некий шаблон|parameter1=value|parameter2=value|parameter3=value}}
|-
| valign=top | [[Файл:Yes_check.svg|15px]] || <code><nowiki>{{Пример|Некий шаблон|parameter1{{=}}value|parameter2{{=}}value|parameter3{{=}}value}}</nowiki></code> даст:<br
/>{{Пример|Некий шаблон|parameter1{{=}}value|parameter2{{=}}value|parameter3{{=}}value}}
|}

Также нельзя записывать напрямую параметры, чьи имена начинаются со знака подчёркивания, — для предотвращения пересечения с параметрами, модифицирующими внешний вид результата. Поможет то же решение:
* <code><nowiki>{{Пример|Tlp|Шаблон|_text{{=}}текст ссылки}}</nowiki></code> даст {{Пример|Tlp|Шаблон|_text{{=}}Текст ссылки}}

Чтобы вписать {{Tago|nowiki}}, используйте HTML-сущности для замены угловых скобок, например:
* <code><nowiki>{{Пример|Tlp|Шаблон|&amp;lt;nowiki>&lt;nowiki>{{IPA|/tʃ/}}&lt;/nowiki>&amp;lt;/nowiki>}}</nowiki></code> даст {{Пример|Tlp|Шаблон|&lt;nowiki><nowiki>{{IPA|/tʃ/}}</nowiki>&lt;/nowiki>}}

Чтобы вписать {{Tc|=}}, используйте <code><nowiki>{{((}}{{=}}{{))}}</nowiki></code> или HTML-сущности, например:
* <code><nowiki>{{Пример|Pre|текст {{((}}{{=}}{{))}} текст|_sep={{Sp-down|||-0.5em}}}}</nowiki></code> даст
<dl><dd>{{Пример|Pre|текст {{((}}{{=}}{{))}} текст|_sep={{Sp-down|||-0.5em}}}}</dd></dl>

В данный момент не поддерживается раскрытие вложенных шаблонов и других конструкций с фигурными скобками (их можно указывать внутри {{Tago|Nowiki}}, но они не раскроются). Многострочные шаблоны также не поддерживаются.

== Настройки ==
* '''_sep''': поменять стрелочку на что угодно другое:
*: <code><nowiki>{{Пример|T|T|_sep=отображается как}}</nowiki></code> даст {{Пример|T|T|_sep=отображается как}}
* '''_tag''': поменять обёртку &lt;code>:
*: <code><nowiki>{{Пример|_template=T|_tag=tt|Пример}}</nowiki></code> даст {{Пример|_template=T|_tag=tt|Пример}}
* '''_link''': включить отображение ссылки:
*: <code><nowiki>{{Пример|_template=Флаг|_link=1|Россия}}</nowiki></code> даст {{Пример|_template=Флаг|_link=1|Россия}}
* '''_pre-text''' ('''_prefix''') и '''_post-text''' ('''_postfix'''): указать текст до и после шаблона:
*: <code><nowiki>{{Пример|Tr-en|слово|_pre-text=word (|_post-text=)}}</nowiki></code> даст {{Пример|Tr-en|слово|_pre-text=word (|_post-text=)}}
* '''_nobr''': запретить перенос строки для кода примера.
* '''_nocat''': запретить добавлять страницу в проставляемые шаблоном категории, если у него предусмотрен соответствующий параметр <code>_nocat</code>. При этом в коде включения шаблона этот параметр отображаться не будет. Так, например, в данном примере настоящая страница не добавляется в категорию {{Cl|Компании, имеющие листинг акций на NASDAQ}}:
*: <code><nowiki>{{Пример|NASDAQ|123|_nocat=1}}</nowiki></code> даст {{Пример|NASDAQ|123|_nocat=1}}
* '''_spaced''': отбить пробелом каждый параметр для лучшей читаемости:
*: <code><nowiki>{{Пример|MathWorld|urlname=GammaFunction|title=Gamma Function|author=John Doe|_spaced=1}}</nowiki></code> даст:
*: {{Пример|MathWorld|urlname=GammaFunction|title=Gamma Function|author=John Doe|_spaced=1}}
* '''_comment''': снабдить пример комментарием:
*: <code><nowiki>{{Пример|Replace|something|some|any|_comment=Заменить все вхождения «some» на «any».}}</nowiki></code> даст {{Пример|Replace|something|some|any|_comment=Заменить все вхождения «some» на «any».}}

=== Стили ===
С помощью параметра '''_style''' можно установить стиль, который будет устанавливать некоторые из вышеперечисленных параметров разом. Существующие на данный момент стили — <code>Pre</code>, <code>*pre</code> и <code>Wikitable</code> (а также <code>Pre↓</code>):
* <code><nowiki>{{Пример|Проверить нейтральность|дата{{=}}1 января 2010|_style=Pre}}</nowiki></code> даст:
: {{Пример|Проверить нейтральность|дата{{=}}1 января 2010|_style=Pre}}{{^}}

* <code><nowiki>{{Пример|Проверить нейтральность|дата{{=}}1 января 2010|_style=*pre}}</nowiki></code> даст:
: {{Пример|Проверить нейтральность|дата{{=}}1 января 2010|_style=*pre}}
{{*pre|<nowiki>{| class="wikitable"
! Код !! Результат
|-
| {{Пример|Атлас мира|1967|_style=Wikitable|_nobr=1}}
|-
| {{Пример|Атлас мира|1991|_style=Wikitable|_nobr=1}}
...
|}</nowiki>}}
: даст
<dl><dd>
{| class=wikitable
! Код !! Результат
|-
| {{Пример|Атлас мира|1967|_style=Wikitable|_nobr=1}}
|-
| {{Пример|Атлас мира|1991|_style=Wikitable|_nobr=1}}
|-
| colspan=2 | …
|}</dd></dl>
: (Для создания таблицы с примерами удобнее воспользоваться шаблоном {{T|Таблица примеров}}.)

== См. также ==
* {{T|TestCase}}
* {{T|Sp-down}}

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

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