Справка:Шаблоны

This page is a translated version of the page Help:Templates and the translation is 93% complete.
Outdated translations are marked like this.
Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Lëtzebuergesch • ‎Napulitano • ‎Nederlands • ‎Tagalog • ‎Tiếng Việt • ‎Türkçe • ‎Zazaki • ‎català • ‎dansk • ‎español • ‎français • ‎hrvatski • ‎italiano • ‎lietuvių • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎slovenčina • ‎suomi • ‎čeština • ‎беларуская (тарашкевіца)‎ • ‎български • ‎русский • ‎српски / srpski • ‎українська • ‎עברית • ‎اردو • ‎العربية • ‎سنڌي • ‎فارسی • ‎پښتو • ‎भोजपुरी • ‎हिन्दी • ‎বাংলা • ‎ಕನ್ನಡ • ‎ไทย • ‎中文 • ‎日本語 • ‎ꯃꯤꯇꯩ ꯂꯣꯟ • ‎한국어
PD Внимание: Когда вы редактируете эту страницу, вы соглашаетесь на передачу своего вклада по лицензии CC0. Узнать об этом подробнее можно на странице справки.
PD

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

Создание шаблонов

Шаблоны — это обычные вики-страницы, контент которых предназначен для того, чтобы его можно было включать (встраивать) в другие страницы. Имена шаблонов, следуя общему соглашению, начинаются с префикса «Шаблон:» («Template:»), привязывая его к этому пространству имён, поэтому их можно создавать так же, как обычные страницы.

Пример простейшего шаблона. Если Вы создадите страницу с названием "Template:Welcome" с содержимым:

Привет! Добро пожаловать в вики!

Вы создадите ваш первый шаблон! Если теперь используете код:

{{Welcome}}

на любой другой странице, то эта страница будет содержать текст "Привет! Добро пожаловать в вики!" в том месте, где вы использовали код {{Welcome}}. Таким образом, содержимое шаблона встроилось в другую страницу.

Вы можете вставить {{Welcome}} в любом месте любой страницы, когда захотите приветствовать кого-либо. Допустим, вы применили этот код на 100 страницах. Если теперь поменять содержимое шаблона на:

Привет всем! Добро пожаловать в этот замечательный вики-проект.

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

Это основной способ. Есть несколько дополнительных особенностей использования, которые дополняют этот способ и делают шаблоны очень полезными.

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

Шаблоны — это вики-страницы, используемые в других вики-страницах. Доступных способов использования три:

  • {{Name}} добавляет в страницу копию содержимого шаблона (страницы с именем [[Template:Name]]). Обращение к шаблону производится каждый раз, когда производится извлечение использующей его страницы. Таким образом, если изменить шаблон, то отображение использующих его страниц тоже изменится.
  • {{subst:Name}} заменяет данную строку содержимым шаблона в момент сохранения страницы. Таким образом, после сохранения в ней остается копия шаблона, которую можно будет изменять так же, как обычную вики-разметку. После сохранения шаблон и страница редактируются независимо: изменение страницы не влияет на шаблон, изменение шаблона не влияет на страницу. Замечание: не стоит пользоваться данным способом, если вы хотите, чтобы дальнейшие изменения шаблона отображались в использующих его страницах.
  • {{safesubst:Name}} — это понятие было введено, чтобы позволить замены без нарушения содержимого, см. w:en:Help:Substitution#The safesubst: modifier.
  • {{msgnw:Name}} включает шаблон в виде формы, отображающейся в использующей его странице, аналогично тому как действует тэг <nowiki>. Как и в первом случае, изменение шаблона изменяет то, что мы видим при отображении страницы.

На самом деле, обычная Вики-страница тоже может использоваться в качестве шаблона, просто укажите пространство имён, в которой она хранится, так:

  • {{Шаблон:Pagename}} содержит [[Шаблон:Pagename]]
  • {{Talk:ИмяСтраницы}} содержит [[Talk:ИмяСтраницы]]
  • {{:ИмяСтраницы}} содержит [[ИмяСтраницы]]
    • {{subst::ИмяСтраницы}} заменяет себя содержимым [[ИмяСтраницы]]

Если такого пространства имён не существует, то полное название предполагает, что это шаблон:

  • {{Foo:Bar}} содержит [[Шаблон:Foo:Bar]]

Параметры

Чтобы расширить механизм включения, Медиавики использует параметры, передаваемые в шаблон при его включении. Параметры шаблона позволяют генерировать различное содержание или менять модель поведения.

Предположим, вы хотите вставить маленькую благодарственную записку в странице обсуждения других пользователей, такую как:

Спасибо... за все ваши усилия. жму руку, Подпись

В благодарственном сообщении будет указана причина (в данном случае "все ваши усилия") и подпись ("Подпись"). Задача состоит в том, чтобы любой пользователь мог поблагодарить другого пользователя по любой причине.

Чтобы сообщение выглядело единообразно везде, где используется, можно создать шаблон под названием, например, Template:Thankyou. Несмотря на единый вид сообщения, каждый раз, когда один пользователь благодарит другого, конкретные его части (причина и подпись) будут различаться. Поэтому вы должны передать их в качестве параметров. Если пренебречь прочими элементами вроде оформления рамки и изображения, основа содержимого шаблона будет такой:

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

'''Спасибо...'''
за {{{1}}}.
Обнимаю, {{{2}}}

Обратите внимание на выражения {{{1}}} и {{{2}}}. Это способ задать в тексте шаблона параметры, которые будут ему передаваться при его использовании. Как можно видеть, каждый параметр заключён в три пары фигурных скобок: {{{ }}}. Это отличается от обычного использования имени шаблона.

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

Нумерованные (анонимные) параметры

Чтобы передать в параметры анонимно, перечислите их значения по порядку:

{{Thankyou|все ваши усилия|Подпись}}

В этом случае шаблон {{Thankyou}} принимает параметры {{{reason}}}=все ваши усилия и {{{signature}}}=Подпись и выдаёт:

Спасибо... за все ваши усилия. жму руку, Подпись

Порядок параметров при анонимной передаче важен. Например, передача их в обратном порядке:

{{Thankyou|Подпись|все ваши усилия}}

приведёт к следующему результату:

Спасибо... за Подпись. жму руку, все ваши усилия

идентификация параметров по порядковому номеру ({{{1}}}, и т.д.) работает только с анонимными параметрами. Любые параметры, идентифицированные по имени, как показано ниже, не будут доступны для шаблона при использовании порядковых номеров.
Если внутри аргумента для анонимного параметра шаблона появляется знак равенства, такой параметр может быть ошибочно принят за именованный параметр (рассматриваемый ниже в этом документе). При этом текст до знака равенства будет принят за имя параметра, а текст после — за значение аргумента. Это распространённая проблема, когда необходимо включить внешнюю ссылку или элемент HTML с атрибутами (см. Task 16235) Это можно обойти, используя вместо анонимного именованный параметр или даже нумерованный, как описано в следующем разделе.

Шаблон с нумерованными параметрами

Чтобы передать параметр по номеру, явно задайте ему таковой при передаче:

{{Thankyou|2=Подпись|1=ваше дружелюбие}}

В этом случае, шаблон {{Thankyou}} принимает параметры {{{1}}}=ваше дружелюбие и {{{2}}}=Подпись, хотя они были поставлены в обратном порядке, и получается: Спасибо... за ваше дружелюбие. жму руку, Подпись

This may also be useful when any of the numbered parameters contains an "=" sign.
Примеры
{{Thankyou|1=adding “=”|2=Me}}
produces
Спасибо...

за adding “=”. жму руку, Me

  Внимание: This also requires numbering each other parameter.

Шаблон с именованными параметрами

Третий способ передачи параметров — по имени вместо цифр. В этом случае содержимое шаблона нужно изменить:

'''Большое спасибо...'''
за {{{reason}}}.
Обнимаю, {{{signature}}}

Теперь мы используем {{{reason}}} и {{{signature}}} для вставки параметров вместо чисел. Для передачи параметров задайте соответствующие имена при вставке:

{{Thankyou|signature=Подпись|reason=за то, что ты есть}}

В этом случае шаблон {{Thankyou}} принимает параметры {{{reason}}}=все ваши усилия и {{{signature}}}=Подпись и выдаёт:

Спасибо... за ваши усилия. жму руку, Подпись Именованные параметры являются регистрозависимыми, т.о.:

Named parameters are case-sensitive, so:

{{Thankyou|signature=Я|Reason=за то, что ты есть|reason=чувствительность к регистру}}

Спасибо... за чувствительность к регистру. жму руку, Я

Преимущество использования именованных параметров в шаблоне, помимо гибкости в порядке их передачи — это делает код шаблона гораздо легче для понимания, особенно если параметров много.

Значения по умолчанию

Если вы включите в страницу шаблон, который ожидает параметры, но не передадите их аргументы (значения), например:

{{Thankyou}}

в нумерованных параметрах из примера выше вы получите следующее:

Спасибо... за {{{1}}}. жму руку, {{{2}}}

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

'''Большое спасибо...'''
за {{{reason|всё}}}.
обнимаю, {{{signature|Я}}}

то выражение {{{reason|всё}}} определяет, что если никакой аргумент для параметра {{{reason}}} не передан, используется значение всё. Соответственно, {{{signature|Я}}} задает для {{{signature}}} значение по умолчанию Я. Теперь вставка шаблона без аргументов приведёт к следующему результату: Спасибо... за за всё. жму руку, Я

Often default values are used to specify alternate names of parameters. For example, if you have {{{a|{{{b|}}} }}}, the template will first look for a parameter named "a". If it is not set, it will use the parameter named "b". If neither "a" nor "b" is set, it will output nothing.

Evaluation

This is an advanced topic which you can skip unless you need it

Generally speaking, template parameters are substituted into the template after tokenization, but as is. They are not evaluated until they are used.

This has a few consequences. First of all, if you have a Template:Start containing {{mytemplate, and a Template:End containing |foo=bar}}, and put {{start}}{{end}} on a page, mytemplate isn't transcluded, because tokens like "|" cannot be added by a template and keep their special meaning in templates. You can still use templates to control the name of a parameter or template, but you cannot split a template call amongst multiple templates.

The second consequence of this is dead-code elimination. If you make a template call like {{ #foreach: foo$n$_bar | foo$n$_bar = {{{foo$n$_bar}}}
}}
, and Template:Foo does not contain {{{1}}}, then the displaytitle is not used, since it is only evaluated when needed, and it there is no parameter to substitute it into, so it is never evaluated. This usually comes into play when using Extension:ParserFunctions, and can be especially noticed when used in combination with the int: magic word that varies by user language.

Template calls starting with the magic word subst: or safesubst: are evaluated in a separate first pass that only happens at save time, along with ~~~~ and links using the pipe trick. If they cannot be evaluated during the first pass, subst: calls are ignored, and safesubst: are treated as if a normal template.

Many but not all parser functions, parser tags and trancluded special pages are not directly included like templates but instead are replaced by a "strip marker". This means you cannot manipulate the results with parser functions like padleft: or similar functions from extensions, as they see the strip marker instead of the result of the parser function.

Рекурсия в шаблонах

Рекурсия - это вызов какого-либо шаблона внутри самого себя. Вызов шаблона сам по себе не бросит MediaWiki в бесконечную рекурсию. MediaWiki остановит рекурсию с именем шаблона, выделенным жирным шрифтом.

Например, если содержимое "Шаблона:Aaaa" - "{{Aaaa}}", то при вызове его на какой либо странице, будет показано "Template:Aaaa".

Управление включением шаблонов

По умолчанию содержимое шаблона отображается полностью, как при непосредственном просмотре, так и при добавлении на другую страницу. Однако вы можете управлять тем, какая часть шаблона будет включаться в страницу, с помощью тэгов <noinclude>, <includeonly> и <onlyinclude>.

Всё что находится между тегами <noinclude> и </noinclude> будет обрабатываться и отображаться только если страница шаблона просматривается сама по себе. Возможное применения данной возможности следующие:

Противоположным образом работает тэг <includeonly>. Текст, находящийся между тегами <includeonly> и </includeonly> будет обрабатываться и отображаться только когда страница шаблона включена в другую страницу. Это полезно в таких ситуациях как:

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

Весь текст шаблона, кроме частей, заключённых в теги <noinclude> и <includeonly>, обрабатывается и отображается как обычно; то есть как при непосредственном просмотре страницы шаблона, так и при добавлении шаблона на другую страницу. Основное внимание уделяется тому, что находится внутри этих двух тегов.

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

Вложение всех этих тегов также возможно.

Эти три тега частичного включения дают все возможные комбинации, того, что будет обрабатываться и отображаться. Коментарии также играют роль.

Систематизация шаблонов

Для эффективного использования шаблонов нужно их легко находить и применять. Легче всего это обеспечить, поместив на страницу шаблона пример его использования.

To find them, users can:

  1. Click Служебные страницы > Все страницы
  2. In the Пространство имён: list, choose Template and click Выполнить.

Например такой:

<noinclude>
== Использование ==
Добро пожаловать пользователи:
{{Thankyou|reason=ваша причина|signature=ваша  подпись}}
</noinclude>

Таким образом редактор сможет просто скопировать пример и модифицировать его для своих нужд.

Ссылки на шаблон

На страницу шаблона можно сослаться как на любую другую вики-страницу. Например, ссылка Template:Navbar создаётся викикодом [[Template:Navbar]].

На многих Вики может быть использован шаблон Template:Tl, чтобы предоставить ссылку на шаблон отформатированной с использованием Вики-разметки таким образом, что шаблон будет показываться в виде "двойных фигурных скобок" что в случае включения шаблона исключает необходимость фактического выполнения включения шаблона. Например, код {{tl|Navbar}} может использоваться для создания связи {{Navbar}}.

Эта конструкция обычно используется в документации по шаблонам, на страницах справки и на страницах обсуждения при обращении к шаблонам. Такого же эффекта можно добиться и при использовании <code>{{[[Template:Navbar|Navbar]]}}</code>, но {{tl}} подход предполагает гораздо меньшую типизацию. На любой данной вики-странице шаблон Tl, если он существует, может отображать или не отображать текст в элементе "код", как показано здесь. Если нет, то это может сделать другой шаблон с аналогичным именем. См., например, раздел "см. также" документации по en:Template:Tl в английской Википедии.

Копирование из одной вики в другую

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

Код MediaWiki

Если у вас есть права на импорт (в частности, импорт загрузки) в новую вики-страницу:

  1. Перейти к $экспорт оригинальной Вики, и скачать .xml-файл с полной историей всех необходимых шаблонов, а именно:
    • Введите имя шаблона в большой текстовый блок, например "Template:Welcome". Обратите особое внимание на заглавные буквы и специальные символы — если имя шаблона не совсем правильно, экспорт все равно может произойти, но.xml-файл не будет содержать ожидаемых данных.
    • Проверьте блок "$экспорт".
    • Снимите отметку на блоке "$экспорт2".
    • Нажмите "Экспортировать".
  2. Перейдите к Special:Import на новой вики и выгрузите .xml файл.

Если у вас нет прав на импорт в новую вики-страницу:

  1. Перейдите к шаблону, который вы хотите скопировать из исходной вики-страницы. Перейдите на страницу редактирования и скопируйте весь викитекст.
  2. На новой вики-странице перейдите на страницу с тем же именем, что и скопированный шаблон. Нажмите на Создать/Отредактировать и вставьте скопированный вами викитекст. В сводке редактирования каждого шаблона укажите ссылку на исходную страницу для атрибуции.
  3. Вернувшись в исходную вики-страницу в окне редактирования, под полем редактирования, посмотрите на список "Шаблоны, используемые на этой странице". Для каждого из перечисленных шаблонов следуйте этим инструкциям. Также сделайте это для любого шаблона, используемого любым из этих шаблонов, и так далее.

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

После успешного импорта шаблона и всех связанных с ним шаблонов из другой Вики отредактируйте его, чтобы изменить настройки в соответствии с вашей Вики. Например, измените логотип, удалите избыточные категории или красные ссылки.

Расширения

Расширение, часто используемое в шаблонах, это ParserFunctions. Посетите страницу Справка:Расширение:Функции Парсера и проверьте, используются ли какие-либо из перечисленных там функций в скопированных вами шаблонах. Если это так, Вы должны установить расширение Расширение:ParserFunctions . Чтобы установить его, Вам понадобится доступ системного администратора к серверу вашей установки MediaWiki.

Еще одна зависимость, которая может быть использована в шаблонах, особенно в Википедии, это Lua. Хорошим признаком для этого является наличие {{#invoke: }} в коде шаблона. В случае, если он используется, вам нужно установить расширение Расширение:Scribunto , а также потребуется доступ системного администратора. На этой странице можно найти дополнительные инструкции по установке и использованию расширения.

CSS и JavaScript-код

Помимо кода MediaWiki, многие шаблоны используют CSS, а некоторым для полной работы потребуется JavaScript. Если скопированные шаблоны ведут себя не так, как ожидалось, причина может быть в этом. Чтобы скопировать необходимые CSS и JavaScript в вашу вики, Вам, обычно, нужно иметь права администратора, потому что вы будете редактировать системные сообщения в пространстве имен "MediaWiki:".

  1. Ищите использование CSS-классов (текст типа class="foobar") в тексте шаблона. Если эти классы появятся в разделе "MediaWiki:Common.css"" или "MediaWiki:Monobook.css" на оригинальной вики-странице скопируйте эти классы в "MediaWiki:Common.css" на новой вики-странице и проверьте, все ли в порядке с шаблоном.
  2. Если скопированный шаблон все еще не работает должным образом, проверьте, есть ли код в MediaWiki:Common.js" или "MediaWiki:Monobook.js" на оригинальной вики-странице. Если это так, вы можете попробовать скопировать его в "MediaWiki:Common.js" на новой вики-странице. Обычно рекомендуется копировать код только из надежных источников и сначала просмотреть код, чтобы определить и выбрать соответствующие части. Вы можете найти комментарии, которые могут служить подсказками для определения функциональности каждой части.

См. также


Внешние ссылки