Шаблон:Пример/doc: различия между версиями

Материал из wikixw
Перейти к навигации Перейти к поиску
Нет описания правки
(Полностью удалено содержимое страницы)
Метка: очистка
Строка 1: Строка 1:
{{docpage}}
{{onLua|Example}}
{{rellink|{{днш|example}}}}
Этот шаблон выводит вики-текст включения шаблона (в общем случае с параметрами) и само это включение. Он в основном предназначен для упрощения оформления примеров использования шаблонов в документациях.


В данный момент шаблон не может использоваться для оформления примеров шаблонов с многострочным кодом и содержащих шаблоны внутри шаблона. (Хотя это технически реализуемо, см. [[Обсуждение шаблона:Пример#Напутствие шаблонописателям|обсуждение]].)
Для вывода групп примеров пользуйтесь шаблонами } (списком) и
{{TOC right}}
== Использование ==
*
Первый параметр можно опускать — тогда его заменит название базовой страницы со строчной первой буквы. Например, в документации шаблона {{t|tr-en}} <code><nowiki></nowiki></code> даст:
:
Это может быть особенно удобно для групп шаблонов, для которых пишется общая документация, размещаемая на каждой странице. А {{tc|пример}} выведет пример включения шаблона, на странице которого этот код размещён, без параметров.
Для наглядности можно также указывать имя шаблона через параметр '''_template''', при этом первый параметр больше не значит имя шаблона:
* <code><nowiki></nowiki></code> даст
== Ограничения и пути их обхода ==
При опускании первого параметра используется именно имя корневой страницы — {{mwmw|ROOTPAGENAME}}, а не проверка на суффиксы {{code|/doc}} или иные, так что для шаблонов, которые являются подстраницами других шаблонов (например, [[Special:PrefixIndex/Template:Userbox/|юзербоксов]]), первый параметр опускать нельзя.
Модуль переносит все именованные параметры в конец, а также плохо сохраняет порядок следования именованных параметров, если их больше одного (из-за технического несовершенства ПО). Чтобы этого избежать, используйте {{tcl|=}} вместо <code>=</code>:
{|
| valign=top | [[Файл:Red x.svg|15px]] || <code><nowiki>></code> даст:<br
|/>
| valign=top | [[Файл:Yes_check.svg|15px]] || <code><nowiki>
/>
|}
Также нельзя записывать напрямую параметры, чьи имена начинаются со знака подчёркивания, — для предотвращения пересечения с параметрами, модифицирующими внешний вид результата. Поможет то же решение:
* <code><nowiki></nowiki></code> даст
Чтобы вписать {{tago|nowiki}}, используйте HTML-сущности для замены угловых скобок, например:
* <code><nowiki>}</nowiki></code> даст </nowiki>&lt;/nowiki>}}
Чтобы вписать {{tc|=}}, используйте <code><nowiki>{{((}}{{=}}{{))}}</nowiki></code> или HTML-сущности, например:
* <code><nowiki>></code> даст
<dl><dd>}</dd></dl>
В данный момент не поддерживается раскрытие вложенных шаблонов и других конструкций с фигурными скобками (их можно указывать внутри {{tago|nowiki}}, но они не раскроются). Многострочные шаблоны также не поддерживаются.
== Настройки ==
* '''_sep''': поменять стрелочку на что угодно другое:
*: <code><nowiki>}</nowiki></code> даст
* '''_tag''': поменять обёртку &lt;code>:
*: <code><nowiki>/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>}</nowiki></code> даст
=== Стили ===
С помощью параметра '''_style''' можно установить стиль, который будет устанавливать некоторые из вышеперечисленных параметров разом. Существующие на данный момент стили — <code>pre</code>, <code>*pre</code> и <code>wikitable</code> (а также <code>pre↓</code>):
* <code><nowiki>1 января 2010|_style=pre}}</nowiki></code> даст:
: 1 января 2010|_style=pre}}{{^}}
* <code><nowiki>}1 января 2010|_style=*pre}}</nowiki></code> даст:
: 1 января 2010|_style=*pre}}
{{*pre|<nowiki>{| class="wikitable"
! Код !! Результат
|-
| {
|-
|
...
|}</nowiki>}}
: даст
<dl><dd>
{| class=wikitable
! Код !! Результат
|-
|
|-
|
|-
| colspan=2 | …
|}</dd></dl>
: (Для создания таблицы с примерами удобнее воспользоваться шаблоном {{t|таблица примеров}}.)
== См. также ==
* {{t|TestCase}}
* {{t|sp↓}}
{{шаблоны для документирования}}
<includeonly>
[[Категория:Шаблоны:Для документирования шаблонов]]
</includeonly>

Версия от 13:43, 6 июня 2023

Источник — https://wikixw.ru/index.php?title=Шаблон:Пример/doc&oldid=68946