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

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

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

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

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

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

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

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

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

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

  • даст

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

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

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

Red x.svg ></code> даст:<br |/> | valign=top | [[Файл:Yes_check.svg|15px]] || <code><nowiki> /> |} Также нельзя записывать напрямую параметры, чьи имена начинаются со знака подчёркивания, — для предотвращения пересечения с параметрами, модифицирующими внешний вид результата. Поможет то же решение: * <code><nowiki> даст

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

  • } даст </nowiki></nowiki>}}

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

  • ></code> даст <dl><dd>}</dd></dl> В данный момент не поддерживается раскрытие вложенных шаблонов и других конструкций с фигурными скобками (их можно указывать внутри {{tago|nowiki}}, но они не раскроются). Многострочные шаблоны также не поддерживаются. == Настройки == * '''_sep''': поменять стрелочку на что угодно другое: *: <code><nowiki>} даст
  • _tag: поменять обёртку <code>:
    /code> даст * '''_link''': включить отображение ссылки: *: <code><nowiki></code> даст * '''_pre-text''' ('''_prefix''') и '''_post-text''' ('''_postfix'''): указать текст до и после шаблона: *: <code><nowiki></code> даст * '''_nobr''': запретить перенос строки для кода примера. * '''_nocat''': запретить добавлять страницу в проставляемые шаблоном категории, если у него предусмотрен соответствующий параметр <code>_nocat</code>. При этом в коде включения шаблона этот параметр отображаться не будет. Так, например, в данном примере настоящая страница не добавляется в категорию {{cl|Компании, имеющие листинг акций на NASDAQ}}: *: <code><nowiki> * '''_spaced''': отбить пробелом каждый параметр для лучшей читаемости: *: <code><nowiki>{</code> даст: *: * '''_comment''': снабдить пример комментарием: *: <code><nowiki>} даст

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

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

  • 1 января 2010|_style=pre}} даст:
1 января 2010|_style=pre}}Шаблон:^
  • }1 января 2010|_style=*pre}} даст:
1 января 2010|_style=*pre}}

Шаблон:*pre

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

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


-