Меню

Главная
Случайная статья
Настройки
Шаблон:Пример
Материал из https://ru.wikipedia.org

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

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

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

Содержание

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


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


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

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


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

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

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


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


Чтобы вписать <nowiki>, используйте HTML-сущности для замены угловых скобок, например:
  • {{пример|tp|шаблон|&lt;nowiki><nowiki>{{IPA|/t/}}</nowiki>&lt;/nowiki>}} даст {{tp|шаблон|<nowiki>{{IPA|/t/}}</nowiki>}} {{шаблон|{{IPA|/t/}}}}


Чтобы вписать {{=}}, используйте {{((}}{{=}}{{))}} или HTML-сущности ({&#123;&#61;&#125;}), например:
  • {{пример|pre|текст {{((}}{{=}}{{))}} текст|_sep={{sp|||-0.5em}}}} даст
{{pre|текст {{=}} текст}} 
текст = текст


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

Настройки
  • _sep: поменять стрелочку на что угодно другое:
    {{пример|t|t|_sep=отображается как}} даст {{t|t}} отображается как {{t}}
  • _tag: поменять обёртку <code>:
    {{пример|_template=t|_tag=samp|пример}} даст {{t|пример}} {{пример}}
  • _link: включить отображение ссылки:
    {{пример|_template=флаг|_link=1|Россия}} даст {{флаг|Россия}}
  • _pre-text (_prefix) и _post-text (_postfix): указать текст до и после шаблона:
    {{пример|tr-en|слово|_pre-text=word (|_post-text=)}} даст word ({{tr-en|слово}}) word (с англ.—«слово»)
  • _nobr: запретить перенос строки для кода примера.
  • _nocat: запретить добавлять страницу в проставляемые шаблоном категории, если у него предусмотрен соответствующий параметр _nocat. При этом в коде включения шаблона этот параметр отображаться не будет. Так, например, в данном примере настоящая страница не добавляется в категорию Компании, имеющие листинг акций на NASDAQ:
    {{пример|NASDAQ|123|_nocat=1}} даст {{NASDAQ|123}} NASDAQ: 123
  • _spaced: отбить пробелом каждый параметр для лучшей читаемости:
    {{пример|MathWorld|urlname=GammaFunction|title=Gamma Function|author=John Doe|_spaced=1}} даст:
    {{MathWorld |title=Gamma Function |author=John Doe |urlname=GammaFunction }} John Doe. Gamma Function (англ.) на сайте Wolfram MathWorld.
  • _comment: снабдить пример комментарием:
    {{пример|replace|something|some|any|_comment=Заменить все вхождения «some» на «any».}} даст {{replace|something|some|any}} anything  Заменить все вхождения «some» на «any».


Стили

С помощью параметра _style можно установить стиль, который будет устанавливать некоторые из вышеперечисленных параметров разом. Существующие на данный момент стили — pre, *pre и wikitable (а также pre):
  • {{пример|проверить нейтральность|дата{{=}}1 января 2010|_style=pre}} даст:
{{проверить нейтральность|дата=1 января 2010}}
  • {{пример|проверить нейтральность|дата{{=}}1 января 2010|_style=*pre}} даст:
  •  
    {{проверить нейтральность|дата=1 января 2010}}
  •  
    {| class="wikitable"
! Код !! Результат
|-
| {{пример|Атлас мира|1967|_style=wikitable|_nobr=1}}
|-
| {{пример|Атлас мира|1991|_style=wikitable|_nobr=1}}
...
|}
даст
Код Результат
{{Атлас мира|1967}} Атлас мира / гл. ред. С. И. Шуров. — 2-е изд. — М. : Главное управление геодезии и картографии при Совете Министров СССР, 1967. — 25 000 экз.
{{Атлас мира|1991}} Атлас мира / сост. и подгот. к печати ПКО «Картография» в 1982 г. ; отв. ред. С. И. Сергеева, В. М. Антонов. — Испр. в 1991 г. — М. : Госгеодезия СССР, 1991. — 337 с.
…
(Для создания таблицы с примерами удобнее воспользоваться шаблоном {{таблица примеров}}.)


См. также

Во избежание поломок страниц, использующих этот шаблон, экспериментируйте в песочнице (создать | зеркало) или своём личном пространстве.
Пожалуйста, добавляйте категории на подстраницу /doc. Подстраницы этого шаблона.
Downgrade Counter