Шаблон:Пример/doc

Шаблон:docpage Шаблон:onLua Шаблон:rellink Этот шаблон выводит вики-текст включения шаблона (в общем случае с параметрами) и само это включение. Он в основном предназначен для упрощения оформления примеров использования шаблонов в документациях.

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

Для вывода групп примеров пользуйтесь шаблонами Шаблон:t (списком) и Шаблон:t (таблицей).

Использование

• {{пример|t|t}} даст Шаблон:пример
• {{пример|replace|something|some|any}} даст Шаблон:пример
• {{пример|tlc|шаблон|параметр 1|||параметр 4}} даст Шаблон:пример
• {{пример|tl|:en:Template:Example|text=English Template:Example}} даст Шаблон:пример
• {{пример|replace|something|some|any|_comment=Заменить все вхождения «some» на «any».}} даст Шаблон:пример

Первый параметр можно опускать — тогда его заменит название базовой страницы со строчной первой буквы. Например, в документации шаблона Шаблон:t {{пример||слово}} даст:

Шаблон:пример

Это может быть особенно удобно для групп шаблонов, для которых пишется общая документация, размещаемая на каждой странице. А Шаблон:tc выведет пример включения шаблона, на странице которого этот код размещён, без параметров.

Для наглядности можно также указывать имя шаблона через параметр _template, при этом первый параметр больше не значит имя шаблона:

• {{пример|_template=t|пример}} даст Шаблон:пример

Ограничения и пути их обхода

При опускании первого параметра используется именно имя корневой страницы — Шаблон:mwmw, а не проверка на суффиксы Шаблон:code или иные, так что для шаблонов, которые являются подстраницами других шаблонов (например, юзербоксов), первый параметр опускать нельзя.

Модуль переносит все именованные параметры в конец, а также плохо сохраняет порядок следования именованных параметров, если их больше одного (из-за технического несовершенства ПО). Чтобы этого избежать, используйте Шаблон:tcl вместо =:

Файл:Red x.svg	{{пример|некий шаблон|parameter1=value|parameter2=value|parameter3=value}} даст: Шаблон:пример
Файл:Yes check.svg	{{пример|некий шаблон|parameter1{{=}}value|parameter2{{=}}value|parameter3{{=}}value}} даст: Шаблон:пример

Также нельзя записывать напрямую параметры, чьи имена начинаются со знака подчёркивания, — для предотвращения пересечения с параметрами, модифицирующими внешний вид результата. Поможет то же решение:

• {{пример|tp|шаблон|_text{{=}}текст ссылки}} даст Шаблон:пример

Чтобы вписать Шаблон:tago, используйте HTML-сущности для замены угловых скобок, например:

• {{пример|tp|шаблон|&lt;nowiki><nowiki>{{IPA|/tʃ/}}</nowiki>&lt;/nowiki>}} даст Шаблон:пример

Чтобы вписать Шаблон:tc, используйте {{((}}{{=}}{{))}} или HTML-сущности, например:

• {{пример|pre|текст {{((}}{{=}}{{))}} текст|_sep={{sp↓|||-0.5em}}}} даст

Шаблон:пример

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

Настройки

• _sep: поменять стрелочку на что угодно другое:

  {{пример|t|t|_sep=отображается как}} даст Шаблон:пример

• _tag: поменять обёртку <code>:

  {{пример|_template=t|_tag=tt|пример}} даст Шаблон:пример

• _link: включить отображение ссылки:

  {{пример|_template=флаг|_link=1|Россия}} даст Шаблон:пример

• _pre-text (_prefix) и _post-text (_postfix): указать текст до и после шаблона:

  {{пример|tr-en|слово|_pre-text=word (|_post-text=)}} даст Шаблон:пример

• _nobr: запретить перенос строки для кода примера.
• _nocat: запретить добавлять страницу в проставляемые шаблоном категории, если у него предусмотрен соответствующий параметр _nocat. При этом в коде включения шаблона этот параметр отображаться не будет. Так, например, в данном примере настоящая страница не добавляется в категорию Шаблон:cl:

  {{пример|NASDAQ|123|_nocat=1}} даст Шаблон:пример

• _spaced: отбить пробелом каждый параметр для лучшей читаемости:

  {{пример|MathWorld|urlname=GammaFunction|title=Gamma Function|author=John Doe|_spaced=1}} даст:

  Шаблон:пример

• _comment: снабдить пример комментарием:

  {{пример|replace|something|some|any|_comment=Заменить все вхождения «some» на «any».}} даст Шаблон:пример

Стили

С помощью параметра _style можно установить стиль, который будет устанавливать некоторые из вышеперечисленных параметров разом. Существующие на данный момент стили — pre, *pre и wikitable (а также pre↓):

• {{пример|проверить нейтральность|дата{{=}}1 января 2010|_style=pre}} даст:

Шаблон:пример

• {{пример|проверить нейтральность|дата{{=}}1 января 2010|_style=*pre}} даст:

Шаблон:пример

•  

  {| class="wikitable"
  ! Код !! Результат
  |-
  | {{пример|Атлас мира|1967|_style=wikitable|_nobr=1}}
  |-
  | {{пример|Атлас мира|1991|_style=wikitable|_nobr=1}}
  ...
  |}

даст

Код	Результат
Шаблон:пример
Шаблон:пример
…

(Для создания таблицы с примерами удобнее воспользоваться шаблоном Шаблон:t.)

См. также

• Шаблон:t
• Шаблон:t