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

Материал из Space Station 14 Вики
Новая страница: «{{docpage}} Реализация шаблона {{tl|Demo}}. <includeonly> Категория:Википедия:Модули </includeonly>»
 
Нет описания правки
 
(не показана 1 промежуточная версия этого же участника)
Строка 1: Строка 1:
{{docpage}}
{{docpage}}
Реализация шаблона {{tl|Demo}}.
{{onLua|Demo}}
Этот шаблон показывает вики-текст и то, что этот вики-текст производит. Он в основном предназначен для использования в документации. Главный параметр — вики-текст, заключённый в теги {{tag|nowiki|content=...}}.
 
{{TOC right}}
 
== Примеры ==
* {{Demo/1|br=<br>даст<br>|<nowiki>{{demo|<nowiki>[[Пушкин]]у</no</nowiki><nowiki>wiki>}}</nowiki>}}
 
* {{Demo/1|br=<br>даст<br>|<nowiki>{{demo|<nowiki>{{сделано}}</no</nowiki><nowiki>wiki>}}</nowiki>}}
 
* {{Demo/1|br=<br>даст<br>|<nowiki>{{demo|<nowiki><math>e^{2\pi i}=1</math></no</nowiki><nowiki>wiki>}}</nowiki>}}
 
== Разделитель ==
Вместо символа «→» в качестве разделителя вики-текста и его результата можно задать произвольный текст в параметре <code>br</code> (используйте в нём <code><nowiki><br></nowiki></code> для новой строки и <code><nowiki>{{sp}}</nowiki></code> для пробела). Если значение параметра <code>br</code> — это число, то между кодом и результатом будет вставлено такое число новых строк. Примеры:
* {{Demo/1|br={{sp}}даст<br>|<nowiki>{{demo|br=1|<nowiki>[[Пушкин]]у</no</nowiki><nowiki>wiki>}}</nowiki>}}
* {{Demo/1|br={{sp}}даст<br>|<nowiki>{{demo|br={{sp↓|||0}}|<nowiki>[[Пушкин]]у</no</nowiki><nowiki>wiki>}}</nowiki>}}
* {{Demo/1|br={{sp}}даст<br>|<nowiki>{{demo|br={{sp}}показывает{{sp}}|<nowiki>[[Пушкин]]у</no</nowiki><nowiki>wiki>}}</nowiki>}}
* {{Demo/1|br={{sp}}даст<br>|<nowiki>{{demo|br=<br>показывает<br>|<nowiki>[[Пушкин]]у</no</nowiki><nowiki>wiki>}}</nowiki>}}
 
Разделитель <code><nowiki>br=<td></nowiki></code> можно использовать в таблицах. Например, следующий код:
 
{{Demo/1|tag=pre|br=даст таблицу:|<nowiki>
{| class="wikitable"
|-
! Вики-текст !! Результат
|-
| {{demo|br=<td>|<nowiki><math>x^2</math></no</nowiki><nowiki>wiki>}}
|-
| {{demo|br=<td>|<nowiki><math>x_2</math></no</nowiki><nowiki>wiki>}}
|}</nowiki>
}}
 
== Категории ==
Шаблон demo подавляет добавление категорий. Например,
: {{Demo/1|br=<br>даст<br>|<nowiki>{{demo|<nowiki>{{нет в источнике}}</no</nowiki><nowiki>wiki>}}</nowiki>}},<br> при этом страница не будет добавляться в категорию для статей без источников.
Чтобы изменить такое поведение, добавьте параметр <code><nowiki>save_categories=1</nowiki></code>.
 
Однако этот шаблон не подавляет добавление [[:Категория:Отслеживающие категории|отслеживающих категорий]]. Например, при ошибке в формуле страница попадёт в категорию [[:Категория:Страницы с ошибками в формулах]]. Поэтому не следует при помощи этого шаблона показывать ошибочный код, приводящий к добавлению страницы в подобные категории.
 
== Стиль ==
Можно задавать стиль для кода при помощи параметра <code>style</code>. Например,
: {{Demo/1|br={{sp}}даст<br>|<nowiki>{{demo|style=background:transparent|<nowiki>[[Пушкин]]у</no</nowiki><nowiki>wiki>}}</nowiki>}}
 
По умолчанию викикод оборачивается тегами {{tag|code}}. Однако можно задать другой тег в параметре <code>tag</code>. Например, <code><nowiki>tag=pre</nowiki></code>:
: {{Demo/1|br={{sp}}даст<br>|<nowiki>{{demo|tag=pre|<nowiki>[[Пушкин]]у</no</nowiki><nowiki>wiki>}}</nowiki>}}
 
== Обратный порядок ==
Используйте параметр <code>reverse</code>, чтобы поменять местами код и результат. Например, в документации шаблонов-карточек удобно использовать
<pre>{{demo|reverse=1|br=|<no<nowiki>wiki>{{Карточка...}}</no</nowiki>wiki>}}</pre>
 
== Код в скрываемом блоке ==
Викикод можно поместить в скрываемый блок. Например
: {{Demo/1|br=<br><br>даст<br><br>|<nowiki>{{demo|tag=pre|class=mw-collapsible mw-collapsed|reverse=1|style=width:400px|<nowiki>[[Пушкин]]у</no</nowiki><nowiki>wiki>}}</nowiki>}}
 
== Внимание! ==
Не забывайте заключать вики-код в теги {{tag|nowiki|content=...}}.
 
== См. также ==
* {{t|sp↓}}
 
{{шаблоны для документирования}}


<includeonly>
<includeonly>
[[Категория:Википедия:Модули]]
[[Категория:Шаблоны:Для документирования шаблонов]]
</includeonly>
</includeonly>

Текущая версия от 12:42, 8 ноября 2025

Этот шаблон показывает вики-текст и то, что этот вики-текст производит. Он в основном предназначен для использования в документации. Главный параметр — вики-текст, заключённый в теги <nowiki>...</nowiki>.

Примеры

{{demo|<nowiki>[[Пушкин]]у</nowiki>}}
даст
[[Пушкин]]уПушкину

{{demo|<nowiki>{{сделано}}</nowiki>}}
даст
{{сделано}}✔ Сделано

{{demo|<nowiki><math>e^{2\pi i}=1</math></nowiki>}}
даст
<math>e^{2\pi i}=1</math>e2πi=1

Разделитель

Вместо символа «→» в качестве разделителя вики-текста и его результата можно задать произвольный текст в параметре br (используйте в нём <br> для новой строки и {{sp}} для пробела). Если значение параметра br — это число, то между кодом и результатом будет вставлено такое число новых строк. Примеры:

{{demo|br=1|<nowiki>[[Пушкин]]у</nowiki>}} даст
[[Пушкин]]у
Пушкину

{{demo|br={{sp↓|||0}}|<nowiki>[[Пушкин]]у</nowiki>}} даст
[[Пушкин]]у

Пушкину

{{demo|br={{sp}}показывает{{sp}}|<nowiki>[[Пушкин]]у</nowiki>}} даст
[[Пушкин]]у показывает Пушкину

{{demo|br=<br>показывает<br>|<nowiki>[[Пушкин]]у</nowiki>}} даст
[[Пушкин]]у
показывает
Пушкину

Разделитель br=<td> можно использовать в таблицах. Например, следующий код:


{| class="wikitable"
|-
! Вики-текст !! Результат
|-
| {{demo|br=<td>|<nowiki><math>x^2</math></nowiki>}}
|-
| {{demo|br=<td>|<nowiki><math>x_2</math></nowiki>}}
|}

даст таблицу:

Вики-текст Результат
<math>x^2</math>x2
<math>x_2</math>x2


Категории

Шаблон demo подавляет добавление категорий. Например,

{{demo|<nowiki>{{нет в источнике}}</nowiki>}}
даст
{{нет в источнике}}Шаблон:Нет в источнике,
при этом страница не будет добавляться в категорию для статей без источников. Чтобы изменить такое поведение, добавьте параметр save_categories=1.

Однако этот шаблон не подавляет добавление отслеживающих категорий. Например, при ошибке в формуле страница попадёт в категорию Категория:Страницы с ошибками в формулах. Поэтому не следует при помощи этого шаблона показывать ошибочный код, приводящий к добавлению страницы в подобные категории.

Стиль

Можно задавать стиль для кода при помощи параметра style. Например,

{{demo|style=background:transparent|<nowiki>[[Пушкин]]у</nowiki>}} даст
[[Пушкин]]уПушкину

По умолчанию викикод оборачивается тегами <code></code>. Однако можно задать другой тег в параметре tag. Например, tag=pre:

{{demo|tag=pre|<nowiki>[[Пушкин]]у</nowiki>}} даст

[[Пушкин]]у

Пушкину

Обратный порядок

Используйте параметр reverse, чтобы поменять местами код и результат. Например, в документации шаблонов-карточек удобно использовать

{{demo|reverse=1|br=|<nowiki>{{Карточка...}}</nowiki>}}

Код в скрываемом блоке

Викикод можно поместить в скрываемый блок. Например

{{demo|tag=pre|class=mw-collapsible mw-collapsed|reverse=1|style=width:400px|<nowiki>[[Пушкин]]у</nowiki>}}

даст

Пушкину

[[Пушкин]]у

Внимание!

Не забывайте заключать вики-код в теги <nowiki>...</nowiki>.

См. также