Модуль:Convert/документація

Цей модуль перетворює значення з однієї одиниці вимірювання в іншу. Наприклад:

• {{convert|123|lb|kg}} → 123 pounds (56 kg)

The module is called using a template—parameters passed to the template are used by this module to control how a conversion is performed. For example, units can be abbreviated (like kg), or displayed as names (like kilogram), and the output value can be rounded to a specified precision. For usage information, see Help:Convert.

Шаблон, що викликає цей модуль:

• Template:Convert

Наступні модулі є обов'язковими:

• Module:Convert — (цей модуль) код для перерахунку одиниць вимірювання
• Module:Convert/data — означення одиниць вимірювання
• Module:Convert/text — текстові повідомлення, і назви і значення параметрів

Наступні модулі є допоміжними і використовуються лише за потребою і я якщо існує такий модуль:

• Module:Convert/extra — extra (temporary) unit definitions; used if a unit is not found in Module:Convert/data
• Module:ConvertNumeric — code to spell an input value in words (only English is supported)

Є доступними наступні сторінки довідки:

• Help:Convert — загальний огляд
• Help:Convert messages — describes error and warning messages; messages link to this page so it is required when the module is copied to another wiki
• Help:Convert units — загальний огляд одиниць вимірювання

Сторінка, що містить помилку в конвертації (модуля Convert), додаються до однієї з нижче наведених категорій, за умови якщо сторінка належить до визначеного простору назв (по стандартно, цим простором є статті):

• Категорія:Помилки Convert

Одиниці вимірювання визначені у вікітексті головного списпку одиниць.

• Module:Convert/documentation/conversion data/doc — визначення головного списпку одиниць вимірювання
• Module:Convert/makeunits — перетворює вікітекст з головного списпку одиниць в код Lua
• Module talk:Convert/makeunits — результат роботи модуля makeunits; скопіюйте його до Module:Convert/data

Module:Convert/data is transcluded into every page using the convert module, so experimenting with a new unit in that module would involve a significant overhead. The Module:Convert/extra module is an alternative which is only transcluded on pages with a unit that is not defined in the main data module.

Пісочниця

При змін цього модуля, скопіюйте модулі на сторінки пісочниці, тоді відредагуйте спочатку ці копії в пісочниці:

• Модуль:Convert/пісочниця
• Модуль:Convert/data/пісочниця
• Модуль:Convert/text/пісочниця
• Модуль:Convert/extra/пісочниця

Використовуйте наступний шаблон для перевірки результатів (приклад {{convert/sandbox|123|lb|kg}}):

• Template:Convert/пісочниця

Template:Convert/пісочниця робить виклик модулю Module:Convert/пісочниця із параметром |sandbox=on, який вказує, що треба використовувати модулі пісочниці, а не нормальні модулі.

Для перевірки результатів редагування модулів convert, необхідно використовувати наступні модулі.

• Модуль:Convert/tester – модуль, який виконує тести із порівнянням результату роботи шаблону із зміненим текстом
• Модуль:Convert/пісочниця/testcases – шаблони, які будуть тестуватися, з очікуваними результатами (використовує модуль tester)
• Обговорення модуля:Convert/пісочниця/testcases – перегляд результатів тесту

Не обов'язково зберігати сторінку testcases для перегляду результатів тесту. Наприклад, можна відредагувати модуль Module:Convert/sandbox/testcases аби змінити тести. Під час редагування тієї сторінки, додайте "Module talk:Convert/sandbox/testcases" (без лапок) у полі заголовка сторінки під "Попередній перегляд сторінки з цим шаблоном", потім натисніть "Попередній перегляд".

Configuration

У шаблоні, що викликає цей модуль, можна зробити деякі налаштування.

Наприклад:

• {{#invoke:convert|convert|numdot=,|numsep=`}}

Встановити десятковий розділювач — кому, а розділювач груп розрядів — гравіс (розділювачем груп має бути нерозривний пробіл, але чи працюватиме?).

Інші налаштування (та їх значення за замовчуванням):

• |maxsigfig=14 – максимальна кількість значущих цифр
• |nscat=0 – простори назв ((англ. namespaces, розділені комою). У разі виникнення в шаблоні помилок чи попереджень сторінки з перелічених просторів автоматично додаватимуться у відповідну категорію (з помилками чи попередженнями; звісно, такі категорії спочатку мають бути створені).
  • вважається, що автоматично відстежувати помилки слід лише на сторінках основного простору;
• |warnings=0 – рівень попереджень, які буде показано:
  • 0 (нуль) — вимкнути всі попередження;
  • 1 — показувати лише важливі попередження;
  • 2 — показувати всі попередження.

Шаблон/модуль має можливість задати підсторінку, на якій роблять/перевіряють експериментальні зміни («пісочницю»). Вона задається значенням параметра |sandbox=. В англійській версії такі підсторінки зазвичай і називають sandbox, в українській локалізації їх зазвичай називають пісочниця.

• |sandbox=пісочниця (після доробки/перевірки цей параметр слід прибрати)

All text used for input parameters and for output messages and categories can be customized. For example, at enwiki the option |lk=on can be used to link each displayed unit to its article. The "lk" and "on" can be replaced with any desired text. In addition, input and output numbers can be formatted and can use digits in the local language. See the translation guide for more information.