Help:Templates/ru

Шаблоны MediaWiki полезны для размещения одинаковых стандартных элементов (текста или форматирования) в других страницах. Unlike extensions and media files, there is no central repository for templates. Templates can be newly written or to save duplicating work already done, exported from another wiki e.g. Wikipedia, and then imported into the target wiki.

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

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

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

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

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

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

Hi there! Welcome to this wonderful wiki.

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

This is the basic mechanism. There are several additional features of transclusion that enrich this mechanism and make templates very useful.

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


 * добавляет в страницу копию содержимого шаблона (страницы с именем Template:Name ). Обращение к шаблону производится каждый раз, когда производится извлечение использующей его страницы. Таким образом, если изменить шаблон, то отображение использующих его страниц тоже изменится.
 * заменяет данную строку содержимым шаблона в момент сохранения страницы. Таким образом, после сохранения в ней остается копия шаблона, которую можно будет изменять так же, как обычную wiki-разметку. После сохранения шаблон и страница редактируются независимо: изменение страницы не влияет на шаблон, изменение шаблона не влияет на страницу. Note: не стоит пользоваться данным способом, если вы хотите, чтобы изменения шаблона отображались в использующих его страницах.
 * — this was introduced to allow for substitution that doesn't break transclusion, see w:en:Help:Substitution.
 * включает шаблон в виде формы, отображающейся в использующей его странице, аналогично тому как действует тэг . Как и в первом случае, изменение шаблона изменяет то, что мы видим при отображении страницы.

In fact, an ordinary wiki page can also be used as a template, simply by specifying the namespace it resides in, so:


 * includes
 * includes
 * includes
 * replaces itself with the contents of

If no such namespace exists, the full title is assumed to be a template:


 * includes

Параметры
To enrich the mechanism of transclusion, MediaWiki allows parameters to be passed to a template when it is transcluded. Parameters allow the template to produce different contents or have different behaviors.

Suppose you wish to insert a little thank you note in the talk page of other users, such as:

The thank you note will have a reason (in this case, "all your effort") and a signature ("Me"). Your objective is that any user be able to thank any other user, for any reason whatsoever.

So that the note will look similar everywhere it is used, you can define a template called Template:Thankyou, for example. Although the note should look similar whenever a user thanks another user, its specific contents (i.e. the reason and the signature) will be different. For that reason, you should pass them as parameters. If we ignore the remaining elements to format the box and place the image, the core content of the template will be this:

A little thank you... for. hugs,

Notice the use of  and. This is the way to identify, within templates, the parameters that will be passed in when the template is used. Note that, within the template, each parameter is surrounded by three braces:. This is different from normal template name usage.

When using the template on a page, you fill in the parameter values, separated by a "pipe" character. MediaWiki allows parameters to be passed to the template in three ways: Anonymously, Numbered, and Named.

Нумерованные (анонимные) параметры
To pass in anonymous parameters, list the values of those parameters sequentially:

In this case, the  template receives parameters   and , producing:

The order in which anonymous parameters are passed in is crucial to its behavior. Reversing the order of the parameters, like so:

would produce this result:

Note: identifying parameters by order (with, etc) works only with anonymous parameters. If your page identifies any parameter by number or name, as shown below, this method will no longer be available to the template which receives them.

Note: If an equal sign appears inside an anonymous template parameter, it may be interpreted as a named parameter, treating the text before the equal sign as the parameter name and the text after it as the value. This is a common problem when you need to include an external link, or an HTML element with attributes (see Task 16235) The workaround is to use named parameters instead, or even numbered parameters as explained in the following section.

Шаблон с нумерованными параметрами
To pass in parameters by number, identify each parameter when passing it:

This time, template  receives parameters   and , though they have been supplied in inverse order, and produces:

Шаблон с именованными параметрами
The third way of passing parameters is by name, instead of numbers. In this case, the template contents would be changed to:

A little thank you... for. hugs,

Within the template, we use  and   to identify each parameter, instead of a number. To pass these parameters by name, identify each parameter when passing it:

In this case, template  receives parameters   and   and produces:

The advantage of using named parameters in your template, besides also being flexible in the order parameters can be passed, is that it makes the template code much easier to understand if there are many parameters.

Значения по умолчанию
If you transclude a template that expects parameters, but do not provide them, in this way:

in the numbered parameters example above you would get the following:

Since no parameters were passed in, the template presents the parameters themselves, instead of their respective values. In these cases, it may be useful to define default values for the parameters, i.e. values that will be used if no value is passed in. For example, if the template contents are changed to:

A little thank you... for. hugs,

then  defines that if no parameter   is provided, then the value   will be used. Similarly,, defaults parameter   to value. Now, transcluding the template again without passing any parameter, results in the following:

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

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


 * отнесение шаблонов к категориям
 * межъязыковые ссылки на похожие шаблоны на других языках
 * пояснительный текст по использованию шаблона

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


 * Очевидным применением этого является добавление всех страниц, содержащих данный шаблон, к категории, без добавления самого шаблона в эту категорию. Замечание: Когда вы изменяете категории, добавляемые в страницу с использованием шаблонов, категоризация может не сработать сразу, так как она управляется.
 * Ensuring that the template's code is not executed when viewing the template page itself. Typically this is because it expects parameters, and its execution without parameters has an undesired result.

Everything outside  and   is processed and displayed normally; that is, both when the template page is being viewed directly and when the template is included in another page. The focus is on what is inside these two tags.

Everything outside  tags is discarded in the transclusion. Even sections tagged includeonly are discarded in the transclusion unless they are also tagged as onlyinclude. The focus is on what is outside this tag.

The three partial transclusion tags enable all possible combinations of what is processed and rendered. Comments also fill a role.

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

To find them, users can:
 * 1) Click ' > '
 * 2) In the ' list, choose Template and click '.

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

Использование
Позволяет давать ссылку на тему:

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

Linking to a template
To link to a template instead of including it, use the tl template. The name of the template the editor wants to link to goes after the vertical pipe. For example: links to the navbar template.

Copying from one wiki to another
Templates often require CSS or other templates, so users frequently have trouble copying templates from one wiki to another. The steps below should work for most templates.

Код MediaWiki
If you have import rights (Specifically importupload) on the new wiki:
 * 1) Go to Special:Export on the original wiki, and download an .xml file with the complete history of all necessary templates, as follows:
 * 2) * Enter the name of the template in the big text box, e.g. "Template:Welcome". Pay special attention to capitalization and special characters — if the template name isn't exactly correct, the export may still occur but the .xml file will not have the expected data.
 * 3) * Check the box "".
 * 4) * Uncheck the box "".
 * 5) * Click "".
 * 6) Go to Special:Import on the new wiki and upload the .xml file.

If you don't have import rights on the new wiki:


 * 1) Go to the template you want to copy from the original wiki. Go to the edit page, and copy all the wikitext
 * 2) On the new wiki, go to the page with the same name as the template you copied. Hit create/edit and paste the wikitext you copied. In the edit summary of each template, link to the original page for attribution.
 * 3) Back in the original wiki at the edit window, below the edit box, look at the list of "Templates used on this page". For each template listed follow these instructions. Also do that for any template used by any of these templates, and so on.

This will copy the entire code necessary, and will suffice for some templates. If it doesn't work also check for red links listed under "Pages transcluded onto the current version of this page:", below the edit box. If there are any repeat the above steps for these as well.

After sucessfully importing the template and all its linked templates from the other wiki, edit it to change customisations to suit your wiki. For example to change a logo, remove redundant categories or red links.

Расширения
An extension often used in templates is ParserFunctions. Visit page and check if any of the functions listed there are used in the templates you've copied. If so, you have to install the. To install it, you'll need system admin access to the server of your MediaWiki installation.

Another dependency that may be used in templates, especially those on Wikipedia, is Lua. Having  in template code is a good sign for it. In case it's used, you need to install the and system admin access is required too. See that page for more instructions about installing and using the extension.

CSS и JavaScript-код
Besides MediaWiki code, many templates make use of CSS and some rely on JavaScript to work fully. If the copied templates are not behaving as expected, this may be the cause. To copy the required CSS and JavaScript to your wiki you'll normally need to have admin privileges, because you'll be editing system messages in the "MediaWiki:" namespace.


 * 1) Look for the use of CSS classes (text like  ) in the template text. If those classes appear in "MediaWiki:Common.css" or "MediaWiki:Monobook.css" on the original wiki, copy those classes to "MediaWiki:Common.css" on the new wiki and check if the template is now fine.
 * 2) If the copied template is still not working as expected, check if there is code in "MediaWiki:Common.js" or "MediaWiki:Monobook.js" on the original wiki. If so, you can try copying it to "MediaWiki:Common.js" on the new wiki. Normally, it is a good idea to only copy code from trusted sources, and first browsing the code to identify and select the parts that are relevant. You may find comments that can serve as clues to identify the functionality of each part.

Note
Experiment shows that if you include a template in itself, it won't put MediaWiki into an infinite recursion. MediaWiki will find out, and stop with the template's name in bold. For example, if the content of "Template:Aaaa" is " ", it'll show as "Template:Aaaa".

См. также

 * – a template special use case example
 * — функциональные вещи («волшебные слова»), которые вы можете найти в некоторых шаблонах
 * m:Help:Template – contains a much more thorough manual on how exactly templates function
 * m:Help:Advanced templates – describes even more advanced techniques such as dynamic template calls and variable variables
 * m:Help:Embed page – embedding pages from namespaces other than.
 * Importing Wikipedia infoboxes tutorial
 * m:Help:Embed page – embedding pages from namespaces other than.
 * Importing Wikipedia infoboxes tutorial