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

Це сторінка документації для Модуль:Convert/extra

Це підсторінка документації модуля Convert/extra.
Вона містить інформацію про використання, категорії та інший вміст, що не є частиною оригінальної сторінки модуля.

Цей модуль призначений для тимчасового швидкого додавання нових одиниць вимірювання у модуль {{Convert}}.
Коли нові одиниці запрацюють правильно, їх слід перенести до постійного списку одиниць вимірювання. Для цього призначено Обговорення модуля:Convert/data, куди слід написати прохання про перенесення.

Нижче наведено приклади визначення нових одиниць вимірювання, взяті з Модуль:Convert/data. Кількість прогалин (там, де вони проставлені) можна змінювати для наочності.

Examples for additions to Module:Convert/extra (For the actual module code see below)

-- These are EXAMPLES on the documentation page. Scroll down to see the module content.
local extra_units = {
    -- Similar to a redirect: "sqm" is an alias for "m2".
    -- {{convert|1.5|m2|sp=us}}  → 1.5 square meters (16 sq ft)
    -- {{convert|1.5|sqm|sp=us}} → 1.5 square meters (16 sq ft)
    ["sqm"] = {
        target   = "m2",
    },
    -- A simple unit, showing the minimum that is required.
    -- The "ha" is the unit code used to identify the unit:
    -- {{convert|1.5|ha}} → 1.5 hectares (3.7 acres)
    ["ha"] = {
        name1    = "hectare",
        symbol   = "ha",
        utype    = "area",
        scale    = 10000,
        default  = "acre",
    },
    -- A unit which accepts an SI prefix. There is no "name1" field because it
    -- has to be constructed (mJ gives "millijoule"; MJ gives "megajoule").
    -- {{convert|125|kJ}} → 125 kilojoules (30,000 cal)
    ["J"] = {
        _name1   = "joule",
        _symbol  = "J",
        utype    = "energy",
        scale    = 1,
        prefixes = 1,
        default  = "cal",
        link     = "Joule",
    },
    -- A unit where US and plural names are required.
    -- {{convert|125|cm/s2}} → 125 centimetres per second squared (4.1 ft/s²)
    ["cm/s2"] = {
        name1    = "centimetre per second squared",
        name1_us = "centimeter per second squared",
        name2    = "centimetres per second squared",
        name2_us = "centimeters per second squared",
        symbol   = "cm/s<sup>2</sup>",
        utype    = "acceleration",
        scale    = 0.01,
        default  = "ft/s2",
        link     = "Gal (unit)",
    },
    -- A "per" unit is defined as the ratio of two other units.
    -- {{convert|125|g/cm3}} → 125 grams per cubic centimetre (4.5 lb/cu in)
    ["g/cm3"] = {
        per      = { "g", "cm3" },
        utype    = "density",
        default  = "lb/cuin",
    },
    -- If the automatic "per" link is not wanted, a link can be specified.
    -- {{convert|125|g/cm3|lk=on|disp=unit}} → [[gram]]s per [[cubic centimetre]]
    -- {{convert|125|g/m3|lk=on|disp=unit}} → [[density|grams per cubic metre]]
    ["g/m3"] = {
 per  = { "g", "m3" },
 utype  = "density",
 default  = "lb/cuyd",
 link  = "density",
    },
    -- Characters "$" and "£" are recognized as currency symbols.
    -- {{convert|125|$/acre}} → $125 per acre ($310/ha)
    ["$/acre"] = {
        per      = { "$", "acre" },
        utype    = "cost $ per unit area",
        default  = "$/ha",
    },
    -- An output unit can be defined as a combination of existing units.
    -- {{convert|2|ha|ft2 m2}} → 2 hectares (220,000 sq ft; 20,000 m²)
    -- Any number of output units can be specified.
    -- NOTE: There may be no need to define a combination because a convert
    --       can specify the output by joining unit codes with "+":
    -- {{convert|1.2|acre|ft2+yd2+m2}} → 1.2 acres (52,000 sq ft; 5,800 sq yd; 4,900 m²)
    ["ft2 m2"] = {
        combination = { "ft2", "m2" },
        utype    = "area",
    },
    -- An output unit can be defined using subunits (from least to most significant).
    -- {{convert|90|in|ydftin}} → 90 inches (2 yd 1 ft 6 in)
    ["ydftin"] = {
        combination = { "in", "ft", "yd" },
        multiple = { 12, 3 },
        utype    = "length",
    },
}

Field	Description
`symbol`	Ідентифікатор одиниці вимірювання. Застосовується, коли задано скорочені позначення (`abbr=on`).
`name1`	Повна назва одиниці в однині. Застосовується, коли скорочення вимкнено (`abbr=off`).
`name2`	Повна назва одиниці в множині. Не обов'язково, якщо множина утворюється додаванням закінчення "s" до назви в однині (`name1`); так зазвичай в англійській. З українською складніше, бо для множини застосовують дві різні форми — порівняйте: два кілометри — п'ять кілометрів. Звісно, перенесений з англійської модуль такого не знає, потрібна його переробка. Тимчасовий вихід — відмовитися від повних назв у множині (для множини задавати лише скорочення).
`name1_us`	Американська назва одиниці (в однині). Для української локалізації взагалі не має сенсу. В оригіналі застосовується для позначень на американському діалекті англійської (коли задано параметр `sp=us` ); не обов'язково, якщо не відрізняється від `name1`;
`name2_us`	Американська назва одиниці в множині. Як і попередній параметр, призначено виключно для американського діалекту (`sp=us`) та не має сенсу в українській локалізації.
`utype`	Тип вимірюваної величини (маса, довжина, площа тощо); має бути таким же, як у базової одиниці.
`scale`	Кількість базових одиниць в одиниці, яка визначається.
`default`	Код одиниці, в яку відбуватиметься перетворення за замовчуванням (якщо не задано, в яку одиницю перетворювати).
`target`	Код уже визначеної одиниці, на яку нове визначення перенаправлятиметься.
`prefixes`	Степінь, у яку підносити префікси кратності одиниці вимірювання. Наприклад: для одиниць довжини буде 1 (у кілометрі 1000¹ метрів); для одиниць площі — 2 (у квадратному кілометрі 1000² =1000 000 квадратних метрів); для одиниць об'єму — 3 (у кубічному кілометрі 1000³ кубічних метрів).
`link`	Назва вікіпедійної статті, на яку буде посилання (коли ввімкнено формування посилань; `lk=on` чи `lk=in` або `lk=out`); не обов'язкове, якщо назва статті не відрізняється від повної назви одиниці (`name1`).