Module:Convert/extra/doc

-- These are EXAMPLES on the documentation page. Scroll down to see the module content.
localextra_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/s2)
["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 m2)
-- 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 m2)
["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",
},
}