Help:Templates/uk

Шаблони MediaWiki призначені для утримання певних стандартних текстів, які можна включати в інші сторінки. На відміну від розширень та медіафайлів, централізованого сховища для шаблонів не існує. Шаблони створюють заново чи беруть готовими із інших вікі-проектів та імпортують у свій вікі-проект.

Створення шаблону
Шаблони - це звичайні вікі-сторінки, вміст яких призначено для включення (вбудовування) в інші сторінки. Назві шаблону передує слово " ", яке відносить шаблон до простору імен. Знаючи це, ви можете створити шаблон так само, як і звичайну сторінку.

Найпростіший приклад застосування шаблону. Якщо створити сторінку "Template:Welcome", на якій записано:

Привіт! Ласкаво просимо до вікі.

то ця сторінка буде шаблоном. Тепер її включення за допомогою такого коду:

до будь-якої іншої сторінки приведе до того, що при перегляді цієї сторінки на місці коду  з'явиться текст "Привіт! Ласкаво просимо до вікі." Так вміст шаблону включається (інтегрується) до іншої сторінки.

Тепер ви можете вписати  в будь-якому місці кожної сторінки, де ви вважаєте доречним появу такого привітання. Нехай ви записали такий код на 100 сторінках. Якщо тепер ви зміните текст шаблону на такий:

Наші вітання! Ласкаво просимо до цієї чудової вікі.

і знову відвідаєте будь-яку з цих 100 сторінок, які використали цей шаблон, ви побачите вже модифікований текст. В такий спосіб ви можете змінити одразу 100 сторінок без редагування кожної з них, - змінивши шаблон, який ці сторінки включають.

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

Використання
Інші сторінки можуть використовувати сторінки шаблонів в такий спосіб:

- таке посилання буде раз і назавжди замінено поточним на момент збереження сторінки вмістом шаблону Template:Назва. Тобто, це посилання в вікі-тексті сторінки буде замінено вмістом шаблону. Внесений в такий спосіб текст не відрізняється від того, що ви набираєте звичайним способом, і його можна редагувати на сторінці вже незалежно від шаблону. Звичайно, тепер змінення шаблону не приведе до змінення цього тексту.
 * - як описано вище, таке посилання буде замінено поточним вмістом сторінки Template:Назва при кожному перегляді сторінки. Рушій MediaWiki залишає це посилання в вікі-тексті сторінки незмінним.
 * - ця конструкція поводить себе точно так, як і, різниця виникає лише коли вона зустрічається всередині іншого шаблону і цей шаблон або вставляють (за першою схемою), або прямо переглядають.
 * включає шаблон у формі без вікі-форматування (так само, як це робить ) при перегляді сторінки.

Насправді будь-яка сторінка вікі може бути використана як шаблон, для цього слід явно вказати простір імен, в якому вона знаходиться:


 * включає сторінку
 * включає сторінку
 * включає сторінку
 * заміщується вмістом

Якщо такого простору імен не існує, назву буде доповнено простором імен    :


 * включає сторінку

Параметри
Для збагачення механізму підставлення MediaWiki дозволяє передавати параметри шаблону. Ці параметри дозволяють одному й тому самому шаблону продукувати різні результати чи по-різному поводитися.

Нехай ви вставляєте коротку подяку на сторінку обговорення іншого користувача, приміром:

Ця подяка містить причину (в наведеному прикладі - за вашу працю) та підпис (Я). Зробити те ж за допомогою вашого шаблону Thankyou зможе будь-який користувач.

Подяка, висловлена за допомогою цього шаблону Template:Thankyou, матиме однаковий вигляд, але міститиме різні фрагменти тексту - ті самі, що при кожному використанні було передано шаблону як параметри. Знехтувавши кодом форматування рамки та зображення, звернемо увагу на змістовний в даному контексті фрагмент шаблону:

Спасибі... за. жму руку,

Зверніть увагу на використання  та. Нумерація - один із способів ідентифікувати параметри всередині шаблону. В шаблоні номер кожного параметру оточують три фігурних дужки:. Ця конвенція відрізняється від синтаксису використання назви шаблону.

Використовуючи цей шаблон на деякій сторінці, ви вказуєте значення параметрів, розділяючи їх символом вертикальної риски (|). MediaWiki дозволяє передавати параметри шаблону трьома способами: анонімні, нумеровані, названі.

Анонімні параметри
Анонімні (за програмістською термінологією, позиційні) параметри просто перелічують послідовно один за одним:

В цьому випадку шаблон  отримує для заміщення   та   і дає в результаті:

Послідовність, в якій перелічено параметри, критична для правильного функціонування. Якщо при включенні шаблону змінити порядок параметрів таким чином:

дістанемо такий результат:

Note: звернення всередині шаблону до його аргументів за порядковим номером ( і т.ін.) дозволено лише для анонімних (позиційних) та нумерованих параметрів.

Нумеровані параметри
Для того щоб передати параметри в нумерованому стилі, просто позначте кожен його номером:

Цього разу код шаблону  отримає параметри   та , незалежно від порядку їх запису при використанні шаблону, і дасть такий результат:

Названі параметри
Третій спосіб передавати параметри шаблону - це надати їм якісь особливі імена замість номерів. Для цього слід змінити сторінку шаблону так:

Спасибі... за. жму руку,

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.

Default values
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:

Control template inclusion
By default, a template's content is displayed in its entirety, both when viewed directly and when included in another page. However, you can control which parts of a template will be seen and included by the use of the  and   tags.

Anything between  and   will be seen only when the template's page is being viewed directly, but not when it is included in another page. This is useful when you want to include text or code in a template that you do not want to propagate to any pages which include it, such as:


 * Category links when categorizing the template itself
 * interlanguage links to similar templates in other languages
 * Explanatory text about how to use the template

Likewise, anything between  and   will be processed and displayed only when the page is being included, but not when the template page is being viewed directly, and is useful in situations such as:


 * Categorizing pages which include the template. Note: when changing the categories applied by a template in this fashion, the categorization of the pages which include that template may not be updated until some time later: this is handled by the . To force the re-categorization of a particular page, open that page for editing and save it without changes.
 * 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   tags 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.

Organizing templates
For templates to be effective, users need to find them, and find out how to use them.

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

To give usage information, include an example like this one on the template page:

Usage
Welcome users:

Then, an editor can simply copy and paste the example to use the 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 code
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.

Extensions
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 and JavaScript code
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.