Калып:Мисалы/doc

Бул калыптын башка аталышы  — {{example}}.

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

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

Для вывода групп примеров пользуйтесь шаблонами

1. багытталды Калып:Tl (списком) и
2. багытталды Калып:Tl (таблицей).

Колдонуу

• {{мисалы|t|t}} берет {{t|t}} → #багытталды Калып:Tl
• {{мисалы|replace|something|some|any}} берет {{replace|something|some|any}} → anything
• {{мисалы|tlc|калып|көрсөтүч 1|||көрсөтүч 4}} берет {{tlc|калып|көрсөткүч 1|||көрсөткүч 4}} →
• {{мисалы|tl|:en:Template:Example|text=English Template:Example}} берет {{tl|:en:Template:Example|text=English Template:Example}} → {{[[Калып::en:Template:Example|:en:Template:Example]]}}
• {{мисалы|replace|something|some|any|_comment=Заменить все вхождения «some» на «any».}} берет {{replace|something|some|any}} → anything  Заменить все вхождения «some» на «any».

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

1. багытталды Калып:Tl {{мисалы||сөз}} берет:

{{tr-en|сөз}} →

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

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

• {{мисалы|_template=t|мисалы}} берет {{t|мисалы}} → #багытталды Калып:Tl

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

При опускании первого параметра используется именно имя корневой страницы — {{ROOTPAGENAME}}, а не проверка на суффиксы /doc или иные, так что для шаблонов, которые являются подстраницами других шаблонов (например, юзербоксов), первый параметр опускать нельзя.

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

	{{мисалы|некий шаблон|parameter1=value|parameter2=value|parameter3=value}} даст: Калып:Пример
	{{пример|некий шаблон|parameter1{{=}}value|parameter2{{=}}value|parameter3{{=}}value}} даст: Калып:Пример

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

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

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

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

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

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

Калып:Пример

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

Настройки

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

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

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

  {{пример|_template=t|_tag=samp|пример}} даст Калып:Пример

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

  {{пример|_template=флаг|_link=1|Россия}} даст Калып:Пример

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

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

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

  {{пример|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}} даст:

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

берет

Код	Жыйынтык
Калып:Пример
Калып:Пример
…

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

1. багытталды Калып:Tl.)

См. также

1. багытталды Калып:Tl

1. багытталды Калып:Tl