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

Материал из wikixw
Перейти к навигации Перейти к поиску

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

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

Для вывода групп примеров пользуйтесь шаблонами Ошибка скрипта: Модуля «Template call code» не существует. (списком) и Ошибка скрипта: Модуля «Template call code» не существует. (таблицей).

<templatestyles src="Шаблон:TOC right/styles.css" />

Использование[править код]

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

Первый параметр можно опускать — тогда его заменит название базовой страницы со строчной первой буквы. Например, в документации шаблона Ошибка скрипта: Модуля «Template call code» не существует. {{пример||слово}} даст:

Ошибка скрипта: Модуля «Example» не существует.

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

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

  • {{пример|_template=t|пример}} даст Ошибка скрипта: Модуля «Example» не существует.

Ограничения и пути их обхода[править код]

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

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

Red x.svg {{пример|некий шаблон|parameter1=value|parameter2=value|parameter3=value}} даст:
Ошибка скрипта: Модуля «Example» не существует.
Yes check.svg {{пример|некий шаблон|parameter1{{=}}value|parameter2{{=}}value|parameter3{{=}}value}} даст:
Ошибка скрипта: Модуля «Example» не существует.

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

  • {{пример|tp|шаблон|_text{{=}}текст ссылки}} даст Ошибка скрипта: Модуля «Example» не существует.

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

  • {{пример|tp|шаблон|&lt;nowiki><nowiki>{{IPA|/tʃ/}}</nowiki>&lt;/nowiki>}} даст Ошибка скрипта: Модуля «Example» не существует.

Чтобы вписать Ошибка скрипта: Модуля «Template call code» не существует., используйте {{((}}{{=}}{{))}} или HTML-сущности, например:

  • {{пример|pre|текст {{((}}{{=}}{{))}} текст|_sep={{sp↓|||-0.5em}}}} даст
Ошибка скрипта: Модуля «Example» не существует.

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

Настройки[править код]

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

Стили[править код]

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

  • {{пример|проверить нейтральность|дата{{=}}1 января 2010|_style=pre}} даст:
Ошибка скрипта: Модуля «Example» не существует.Шаблон:^
  • {{пример|проверить нейтральность|дата{{=}}1 января 2010|_style=*pre}} даст:
Ошибка скрипта: Модуля «Example» не существует.

Шаблон:*pre

даст
Код Результат
Ошибка скрипта: Модуля «Example» не существует.
Ошибка скрипта: Модуля «Example» не существует.
(Для создания таблицы с примерами удобнее воспользоваться шаблоном Ошибка скрипта: Модуля «Template call code» не существует..)

См. также[править код]

  • Ошибка скрипта: Модуля «Template call code» не существует.
  • Ошибка скрипта: Модуля «Template call code» не существует.