Help:Template (Русский)

From ArchWiki
Jump to: navigation, search

Tango-preferences-desktop-locale.pngЭта страница нуждается в сопроводителеTango-preferences-desktop-locale.png

Статья не гарантирует актуальность информации. Помогите русскоязычному сообществу поддержкой подобных страниц. См. Команда переводчиков ArchWiki

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

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

Шаблон можно включить в статью следующим кодом:

{{Template name}}

Большинство шаблонов принимают дополнительные параметры. На примере Template:Note (Русский):

{{Note (Русский)|Текст примечания.}}

что дает в результате:

Примечание: Текст примечания.

Некоторые шаблоны используют именованные параметры, например Template:hc:

{{hc|head=/etc/rc.local|output=exit 0}}

результат:

/etc/rc.local
exit 0

Общий формат следующий:

{{Имя шаблона|параметр1|параметр2|...|параметрN}}

Инструкции по использованию шаблонов как правило можно найти на их страницах.

Стиль

  • Следует указывать имя шаблона тем же регистром, что используется в примерах на их страницах. Например, {{Pkg|... и {{ic|... — правильно, а {{pkg|... и {{Ic|... — нет.
  • Вокруг имени шаблона не должно быть пробелов: {{Имя шаблона|... — правильно, однако, например {{ Имя шаблона |... — нет.
  • Шаблоны не должны быть включены в какую-либо категорию.

Экранирование недопустимых символов

Некоторые символы недопустимы внутри шаблонов, так как воспринимаются как часть вики-разметки. Обычно, это случается с "=" (знак равенства) и "|" (вертикальная черта). Решения этой проблемы указаны ниже.

Именованные параметры

Если проблема только лишь со знаками равенства, рекомендуемым решением является явным образом определить параметры шаблона, указав их имена либо порядковые номера. Это полезно, когда вы указываете URL-ссылку, содержащую параметры запроса, либо имя и значение переменной окружения. Имейте ввиду, что для других недопустимых символов, например "|" это работать не будет. Пример:

{{Tip (Русский)|1=https://www.archlinux.org/?foo=bar}}
Совет: https://www.archlinux.org/?foo=bar

Или, при использовании нескольких параметров:

{{hc|1=$ echo "="|2==}}
{{hc|head=$ echo "="|output==}}
$ echo "="
=

Теги nowiki

Если проблема вызвана другими символами кроме "=", например, "|", рекомендуемым решением является обернуть параметр целиком тегами <nowiki>. Этот способ позволяет экранировать все возможные недопустимые символы, однако он полностью отключает всю разметку внутри тегов. Например:

{{Tip (Русский)|<nowiki>= | }} https://www.archlinux.org/ {{ic|foo}}</nowiki>}}
Совет: = | }} https://www.archlinux.org/ {{ic|foo}}

Оборачивание только проблемных частей (единичных символов) в теги <nowiki> также, конечно, будет работать, однако это мешает восприятию кода страницы. Так следует делать только тогда, когда требуется обеспечить правильное отображение разметки, например, ссылок или других шаблонов:

{{Tip (Русский)|<nowiki>= | }}</nowiki> https://www.archlinux.org/ {{ic|foo}}}}
Совет: = | }} https://www.archlinux.org/ foo

HTML сущности

Замена проблемных символов их HTML-сущностями также работает, но это может заметно усложнить восприятие кода страницы. Рекомендуется воздержаться от их использования кроме тех случаев, когда вышеперечисленные приемы работают неудовлетворительно. Пример:

{{Tip (Русский)|&#61; &#124; &#125;&#125;}}
Совет: = | }}

Создание

Примечание:
  • Перед созданием шаблона обязательно обсудите свою идею на странице Help talk:Template.
  • Создавайте только шаблоны, уместные для использования в ArchWiki. Если вы собираетесь создать очень специфичный шаблон, который сможет быть использован лишь на ограниченном количестве страниц, скорее всего, это плохая идея.
  • Создавайте простые и понятные шаблоны. Помните главный принцип философии Arch: "будь проще, тупица"!

Следующий общий пример следует использовать в качестве основы при создании шаблонов для обеспечения единообразия и упрощения их использования и редактирования:

<noinclude>{{Template}}

Здесь краткое описание шаблона

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

 <nowiki>{{Имя шаблона|параметр1|параметр2|...|параметрN}}</nowiki>

== Пример ==

{{Имя шаблона|параметр1|параметр2|...|параметрN}}</noinclude><includeonly>Код шаблона располагается здесь...</includeonly>

Начать необходимо с создания страницы шаблона. Для этого просто перейдите по ссылке Template:Имя шаблона (разумеется, заменив Имя шаблона нужным вам именем) отредактируйте страницу, и добавьте соответствующий викитекст.

Список шаблонов

Шаблоны, которые можно напрямую использовать в русскоязычных статьях на ArchWiki перечислены ниже. По ссылкам вы найдете инструкции по использованию каждого из шаблонов. Полный список всех шаблонов вы найдете на страницах Special:AllPages/Template:, Special:PrefixIndex/Template: или Special:MostLinkedTemplates.

Важно: Не экспериментируйте с существующими шаблонами! Если вы хотите что-то исправить на шаблоне, страница которого не защищена от редактирования, скопируйте ее текст в шаблон-песочницу, отредактируйте его там как вам нужно и сразу протестируйте, и только затем скопируйте готовый код назад в исходный шаблон. Тем не менее, рекомендуется сначала обсуждать свои намерения на страницах обсуждения соответствующего шаблона.

Тестирование

Шаблоны состояния статьи

Только для страниц на английском:

Для страниц на русском:

Для устаревших страниц:

Шаблоны блока "Ссылки по теме"

Шаблоны форматирования кода

Шаблоны информационных блоков

Прочие шаблоны

Шаблоны пакетов

Шаблоны таблиц

Смотрите также