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

Материал из Народные сказки
Перейти к навигации Перейти к поиску
ВизуальныйВики-текст
м (Andras переименовал страницу Шаблон:пример/doc в Шаблон:Пример/doc)
Нет описания правки
Строка 11: Строка 11:


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


Первый параметр можно опускать — тогда его заменит название базовой страницы со строчной первой буквы. Например, в документации шаблона {{t|tr-en}} <code><nowiki>{{пример||слово}}</nowiki></code> даст:
Первый параметр можно опускать — тогда его заменит название базовой страницы со строчной первой буквы. Например, в документации шаблона {{t|tr-en}} <code><nowiki>{{Пример||слово}}</nowiki></code> даст:
: {{пример|tr-en|слово}}
: {{Пример|tr-en|слово}}
Это может быть особенно удобно для групп шаблонов, для которых пишется общая документация, размещаемая на каждой странице. А {{tc|пример}} выведет пример включения шаблона, на странице которого этот код размещён, без параметров.
Это может быть особенно удобно для групп шаблонов, для которых пишется общая документация, размещаемая на каждой странице. А {{tc|пример}} выведет пример включения шаблона, на странице которого этот код размещён, без параметров.


Для наглядности можно также указывать имя шаблона через параметр '''_template''', при этом первый параметр больше не значит имя шаблона:
Для наглядности можно также указывать имя шаблона через параметр '''_template''', при этом первый параметр больше не значит имя шаблона:
* <code><nowiki>{{пример|_template=t|пример}}</nowiki></code> даст {{пример|_template=t|пример}}
* <code><nowiki>{{Пример|_template=t|пример}}</nowiki></code> даст {{Пример|_template=t|пример}}


== Ограничения и пути их обхода ==
== Ограничения и пути их обхода ==
Строка 29: Строка 29:
Модуль переносит все именованные параметры в конец, а также плохо сохраняет порядок следования именованных параметров, если их больше одного (из-за технического несовершенства ПО). Чтобы этого избежать, используйте {{tcl|=}} вместо <code>=</code>:
Модуль переносит все именованные параметры в конец, а также плохо сохраняет порядок следования именованных параметров, если их больше одного (из-за технического несовершенства ПО). Чтобы этого избежать, используйте {{tcl|=}} вместо <code>=</code>:
{|
{|
| valign=top | [[Файл:Red x.svg|15px]] || <code><nowiki>{{пример|некий шаблон|parameter1=value|parameter2=value|parameter3=value}}</nowiki></code> даст:<br
| valign=top | [[Файл:Red x.svg|15px]] || <code><nowiki>{{Пример|некий шаблон|parameter1=value|parameter2=value|parameter3=value}}</nowiki></code> даст:<br
/>{{пример|некий шаблон|parameter1=value|parameter2=value|parameter3=value}}
/>{{Пример|некий шаблон|parameter1=value|parameter2=value|parameter3=value}}
|-
|-
| valign=top | [[Файл:Yes_check.svg|15px]] || <code><nowiki>{{пример|некий шаблон|parameter1{{=}}value|parameter2{{=}}value|parameter3{{=}}value}}</nowiki></code> даст:<br
| valign=top | [[Файл:Yes_check.svg|15px]] || <code><nowiki>{{Пример|некий шаблон|parameter1{{=}}value|parameter2{{=}}value|parameter3{{=}}value}}</nowiki></code> даст:<br
/>{{пример|некий шаблон|parameter1{{=}}value|parameter2{{=}}value|parameter3{{=}}value}}
/>{{Пример|некий шаблон|parameter1{{=}}value|parameter2{{=}}value|parameter3{{=}}value}}
|}
|}


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


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


Чтобы вписать {{tc|=}}, используйте <code><nowiki>{{((}}{{=}}{{))}}</nowiki></code> или HTML-сущности, например:
Чтобы вписать {{tc|=}}, используйте <code><nowiki>{{((}}{{=}}{{))}}</nowiki></code> или HTML-сущности, например:
* <code><nowiki>{{пример|pre|текст {{((}}{{=}}{{))}} текст|_sep={{sp↓|||-0.5em}}}}</nowiki></code> даст
* <code><nowiki>{{Пример|pre|текст {{((}}{{=}}{{))}} текст|_sep={{sp↓|||-0.5em}}}}</nowiki></code> даст
<dl><dd>{{пример|pre|текст {{((}}{{=}}{{))}} текст|_sep={{sp↓|||-0.5em}}}}</dd></dl>
<dl><dd>{{Пример|pre|текст {{((}}{{=}}{{))}} текст|_sep={{sp↓|||-0.5em}}}}</dd></dl>


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


=== Стили ===
=== Стили ===
С помощью параметра '''_style''' можно установить стиль, который будет устанавливать некоторые из вышеперечисленных параметров разом. Существующие на данный момент стили — <code>pre</code>, <code>*pre</code> и <code>wikitable</code> (а также <code>pre↓</code>):
С помощью параметра '''_style''' можно установить стиль, который будет устанавливать некоторые из вышеперечисленных параметров разом. Существующие на данный момент стили — <code>pre</code>, <code>*pre</code> и <code>wikitable</code> (а также <code>pre↓</code>):
* <code><nowiki>{{пример|проверить нейтральность|дата{{=}}1 января 2010|_style=pre}}</nowiki></code> даст:
* <code><nowiki>{{Пример|проверить нейтральность|дата{{=}}1 января 2010|_style=pre}}</nowiki></code> даст:
: {{пример|проверить нейтральность|дата{{=}}1 января 2010|_style=pre}}{{^}}
: {{Пример|проверить нейтральность|дата{{=}}1 января 2010|_style=pre}}{{^}}


* <code><nowiki>{{пример|проверить нейтральность|дата{{=}}1 января 2010|_style=*pre}}</nowiki></code> даст:
* <code><nowiki>{{Пример|проверить нейтральность|дата{{=}}1 января 2010|_style=*pre}}</nowiki></code> даст:
: {{пример|проверить нейтральность|дата{{=}}1 января 2010|_style=*pre}}
: {{пример|проверить нейтральность|дата{{=}}1 января 2010|_style=*pre}}
{{*pre|<nowiki>{| class="wikitable"
{{*pre|<nowiki>{| class="wikitable"
! Код !! Результат
! Код !! Результат
|-
|-
| {{пример|Атлас мира|1967|_style=wikitable|_nobr=1}}
| {{Пример|Атлас мира|1967|_style=wikitable|_nobr=1}}
|-
|-
| {{пример|Атлас мира|1991|_style=wikitable|_nobr=1}}
| {{Пример|Атлас мира|1991|_style=wikitable|_nobr=1}}
...
...
|}</nowiki>}}
|}</nowiki>}}
Строка 86: Строка 86:
! Код !! Результат
! Код !! Результат
|-
|-
| {{пример|Атлас мира|1967|_style=wikitable|_nobr=1}}
| {{Пример|Атлас мира|1967|_style=wikitable|_nobr=1}}
|-
|-
| {{пример|Атлас мира|1991|_style=wikitable|_nobr=1}}
| {{Пример|Атлас мира|1991|_style=wikitable|_nobr=1}}
|-
|-
| colspan=2 | …
| colspan=2 | …

Версия от 19:44, 8 мая 2023

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

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

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

Использование

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

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

{{tr-en|слово}} →

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

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

  • {{Пример|_template=t|пример}} даст {{t|пример}} →

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

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

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

Файл:Red x.svg {{Пример|некий шаблон|parameter1=value|parameter2=value|parameter3=value}} даст:
{{некий шаблон|parameter1=value|parameter3=value|parameter2=value}} →
Файл:Yes check.svg {{Пример|некий шаблон|parameter1{{=}}value|parameter2{{=}}value|parameter3{{=}}value}} даст:
{{некий шаблон|parameter1=value|parameter2=value|parameter3=value}} →

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

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

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

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

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

  • {{Пример|pre|текст {{((}}{{=}}{{))}} текст|_sep={{sp↓|||-0.5em}}}} даст
{{pre|текст {{=}} текст}} Шаблон:sp↓

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

Настройки

  • _sep: поменять стрелочку на что угодно другое:
    {{Пример|t|t|_sep=отображается как}} даст {{t|t}} отображается как
  • _tag: поменять обёртку <code>:
    {{Пример|_template=t|_tag=tt|пример}} даст {{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. При этом в коде включения шаблона этот параметр отображаться не будет. Так, например, в данном примере настоящая страница не добавляется в категорию Шаблон:cl:
    {{Пример|NASDAQ|123|_nocat=1}} даст {{NASDAQ|123}} →
  • _spaced: отбить пробелом каждый параметр для лучшей читаемости:
    {{Пример|MathWorld|urlname=GammaFunction|title=Gamma Function|author=John Doe|_spaced=1}} даст:
    {{MathWorld |author=John Doe |urlname=GammaFunction |title=Gamma Function }} →
  • _comment: снабдить пример комментарием:
    {{Пример|replace|something|some|any|_comment=Заменить все вхождения «some» на «any».}} даст {{replace|something|some|any}} →  Заменить все вхождения «some» на «any».

Стили

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

  • {{Пример|проверить нейтральность|дата{{=}}1 января 2010|_style=pre}} даст:
{{проверить нейтральность|дата=1 января 2010}} →
  • {{Пример|проверить нейтральность|дата{{=}}1 января 2010|_style=*pre}} даст:
Шаблон:пример
  •  
    {| class="wikitable"
! Код !! Результат
|-
| {{Пример|Атлас мира|1967|_style=wikitable|_nobr=1}}
|-
| {{Пример|Атлас мира|1991|_style=wikitable|_nobr=1}}
...
|}
даст
Код Результат
{{Атлас мира|1967}}
{{Атлас мира|1991}}
…
(Для создания таблицы с примерами удобнее воспользоваться шаблоном Шаблон:t.)

См. также


Источник — http://new.ru-skazki.ru/index.php?title=Шаблон:Пример/doc&oldid=287