Difference between revisions of "Template:Convert/doc"

Latest revision as of 23:44, 1 February 2014

This template uses Module:Convert, a script written in the Lua programming language. Please see Wikipedia:Lua if you want to learn more about Lua or help convert other templates.

Usage

See Help:Convert for up-to-date information.

This template shows measurement quantities as primary and converted secondary units (or ranges), with optional rounding, wikilinks, abbreviation, or US spellings, and various separators including: parentheses "( )", "or", hyphens, comma, "to" or dashes. It can help users by calculating correct conversions from one unit of measurement to another, particularly for more complex units. It's also useful by making the text adhere to the Manual of Style.

Styles include: distance "32 metres (105 ft)" and "32 metres or 105 feet"; temperature "18 °C (64 °F)"; mass "55.0 kg (121.3 lb)" or "65 to 80 kg (143 to 176 lb)"; etc. For units see: Convert/list of units.

Options include: lk=in, abbr=on, abbr=off, sp=us, adj=on, adj=mid, disp=x, disp=table and sortable=on (explained below). By default, output is rounded to match the precision of input; alternatives include: sigfig=3 or using the end parameter, such as "|1" to show tenths or "|-2" to show full 100's, etc.

Single value:

{{convert|value|in_unit|out_unit|round_to|...}}

Range of 2 values, or set of 3 or 4 (see below for list of range options):

{{convert|val1|range|val2 |in_unit|out_unit|round_to|...}}
{{convert/3 |val1|range|val2|words|val3|in_unit|out_unit|round_to|...}}
{{convert/4|val1|words|val2|words|val3|words|val4|in_unit|out_unit|...}}

Optional parameters, in examples below, allow abbreviated units (abbr=on), or U.S. spellings (sp=us for meter), or hyphenation (adj=on), etc.
This template may in some cases directly convert to other base units, for example {{convert|29.8|km/s|mi/h}} will directly convert the km/s to mph, as in 29.8 km/s (67,000 mph).
For this template many levels of substitution are possible, hence doing this fully, step by step, is cumbersome. Use Special:ExpandTemplates instead.
The template provides some dimensional analysis to check for compatible units. The user should be careful that input and output units are compatible. Do not, for example, attempt to convert barrels to tonnes (but see {{bbl to t}}). Also beware of units with similar names; the code oz, for example, is for the avoirdupois ounce (a unit of mass), do not use this if you want fluid ounces. Note also that the code lb gives pounds mass, for pounds force use lbf.
This documentation page tends to lag behind in terms of what the template can do. For more details, see the talk page and its archives.

Examples

Single value

Input	Displays as
{{convert\|3.21\|kg\|lb}}	3.21 kilograms (7.1 lb)
{{convert\|3.21\|kg\|lb\|0}}	3.21 kilograms (7 lb)
{{convert\|10\|kg\|lb\|disp=or}}	10 kilograms or 22 pounds
{{convert\|6\|ft\|5\|in\|m}}	6 feet 5 inches (1.96 m)
{{convert\|10\|mi}}	10 miles (16 km)
{{convert\|100\|mpgus}}	100 miles per US gallon (2.4 L/100 km; 120 mpg_-imp)
{{convert\|120\|km/h}}	120 kilometres per hour (75 mph)
{{convert\|18\|°C\|°F}}	18 °C (64 °F)
{{convert\|-15\|C\|F}}	−15 °C (5 °F)
{{convert\|9\|e6USgal\|abbr=off}}	9 million US gallons (34 megalitres) The "e6" scales the input to millions; the "abbr=off" yields the "mega" in the output. Scaling is only available for Single value conversions. Not all units are supported.
{{convert\|1250\|sqft\|m2\|lk=in\|sigfig=2}}	1,250 square feet (120 m²) Note 'lk=in' links only the input unit. This example is for illustration only, common units of measurement should not be linked. See: wp:overlink.
{{convert\|20.5\|m3\|cuyd\|lk=out\|abbr=on}}	20.5 m³ (26.8 cu yd) Note 'lk=out' links only the output unit, cu yd.
{{convert\|641\|acre\|ha sqmi\|lk=on}}	641 acres (259 ha; 1.002 sq mi) Note 'lk=on' links all units. Per guidelines, common units should not be linked. See: wp:overlink.
{{convert\|641\|acre\|ha sqmi\|2\|lk=on}}	641 acres (259.40 ha; 1.00 sq mi) Although 640 acres equals 1 square mile; 641 acres rounded to two decimal places equals 1.00 sq mi.

Range of 2 values

Note: not yet operational for all units and it may be necessary to enter as "convert/2" rather than simply "convert"

Input	Displays as
{{convert\|60\|and\|170\|kg\|lb}}	60 and 170 kilograms (130 and 370 lb)
{{convert\|60\|to\|170\|kg\|lb}}	60 to 170 kilograms (130 to 370 lb)
{{convert\|60\|to(-)\|170\|kg\|lb}}	60 to 170 kilograms (130–370 lb)
{{convert\|60\|-\|170\|kg\|lb}}	60–170 kilograms (130–370 lb)
{{convert\|41\|to\|50\|F\|C}}	41 to 50 °F (5 to 10 °C)
{{convert\|-10\|to\|-20\|C\|F}}	−10 to −20 °C (14 to −4 °F)
{{convert\|41\|-\|50\|F\|K}}	41–50 °F (278–283 K)
{{convert\|60\|by\|120\|ft}}	60 by 120 metres (200 by 390 ft)
{{convert\|60\|x\|120\|m\|ft\|abbr=on}}	60 m × 120 m (200 ft × 390 ft)
{{convert\|60\|+/-\|10\|m\|ft}}	60 ± 10 metres (197 ± 33 ft)
{{convert\|19\|to\|27\|L\|USgal}}	19 to 27 litres (5.0 to 7.1 US gal)
{{convert\|5\|to\|7\|L\|USgal}}	5 to 7 litres (1.3 to 1.8 US gal)
{{convert\|4\|-\|9\|L\|USgal\|abbr=off}}	4–9 litres (1.1–2.4 US gallons)

The following conversions are currently not available as a range of values:

Some imperial and US gallon-based units
Other fuel-consumption units, except "mpg" or "L100km" shown above.
Large scale units (e3, e6, e9)
Combination-based units (ft&in, st&lb, lb&oz) due to complexity of the conversion.

Range/set of 3 or 4 values

Note: not yet operational for all units

Input	Displays as
{{convert \|60\|by\|100\|by\|120\|m\|ft}}	60 by 100 by 120 metres (200 by 330 by 390 ft)
{{convert/3 \|60\|x\|100\|x\|120\|m\|ft\|abbr=mos}}	60 m × 100 m × 120 m (200 ft × 330 ft × 390 ft)
{{convert/3 \|60\|-\|70\|-\|80\|kg\|lb}}	60–70–80 kilograms (130–150–180 lb)
{{convert/4 \|60\|-\|70\|-\|80\|-\|90\|kg\|lb}}	60–70–80–90 kilograms (130–150–180–200 lb)
{{convert/3 \|60\|to\|80\|or\|85\|m\|ft}}	60 to 80 or 85 metres (200 to 260 or 279 ft)
{{convert/3 \|11\|by\|15\|rarely\|16\|ft\|m}}	11 by 15 rarely 16 feet (3.4 by 4.6 rarely 4.9 m)
{{convert/3 \|41\|to\|50\|to\|60\|F\|C}}	41 to 50 to 60 °F (5 to 10 to 16 °C)
{{convert/4 \|2\|to\|12\|, in summer\|25\|to\|36\|C\|F}}	2 to 12, in summer 25 to 36 °C (36 to 54, in summer 77 to 97 °F)
{{convert/3 \|41\|-\|50\|almost\|51\|F\|K}}	41–50 almost 51 °F (278–283 almost 284 K)

For {{convert/3}} or {{convert/4}}, the separator words can be any text.

Parameters

Parameters
Use US spelling	attach `\|sp=us` to show "meter" rather than "metre" (etc.)
Make units linked	attach `\|lk=on` to link all units (default: `lk=off`) attach `\|lk=in` to link only the input units attach `\|lk=out` to link only the output units (The manual of style suggests that you should not link common units of measurement).
Use the adjective form, or insert mid-text words	attach `\|adj=on` (e.g. "190-foot (58 m) bridge" instead of "190 feet..."). This produces the adjective form, as the unit name in the singular with a hyphen (according to the Manual of Style). attach `\|adj=mid` (e.g. "190-foot bridge (58 m)" as: \|adj=mid\|bridge or "190-foot-long bridge (58 m)" as: \|adj=mid\|-long bridge Note 1: Any rounding-parameter should follow the mid-text: "text\|0". Note 2: For adj=mid, must specify both input & output unit-codes. For example, to convert feet, use "ft\|m" or "ft\|0": • {{convert\|9\|ft\|m\|adj=mid\|-long}} → 9-foot-long (2.7 m) To default the output unit-code, set parameter 3 to: 0.
Abbreviate units, or not	attach `\|abbr=on` to show unit symbols attach `\|abbr=off` to show all unit names in full words attach `\|abbr=in` to abbreviate input units attach `\|abbr=out` to abbreviate output units attach `\|abbr=~` to show input unit symbol in result attach `\|abbr=values` to suppress unit names & show only values. So, {{convert\|6\|mi\|abbr=values}} gives: 6 (9.7).
Change "( )" to display other separators	attach `\|disp=or` to put "or" between units. The default value is: disp=b for brackets/parentheses.
Change "( )" to customized separators	attach `\|disp=x\| (begin \| end)` to show "xx (begin yy end)" See example 1 attach `\|disp=x\|;` to show "xx; yy" See example 2 attach `\|disp=x\| (same as \|)` to show "xx (same as yy)". See example 3 Example 1: {{convert\|9\|km\|mi\|disp=x\| [\|]}}→9 kilometres [5.6 mi] (note space before [\|) Example 2: {{convert\|9\|km\|mi\|disp=x\|; }}→9 kilometres; 5.6 mi Example 3: {{convert\|10\|km\|mi\|disp=x\| (about \|)}}→10 kilometres (about 6.2 mi) (note spaces used within the code).
Display output only	attach `\|disp=output only` to show result number & unit attach `\|disp=output number only` to show just number Note when using "disp=output only" then the unit name can still be shown as full words by abbr=off or linked by lk=on. Example: {{convert\|7500\|acre\|m2\|disp=output only }} → 30,000,000 m²
Display units inverted as reverse order	attach `\|disp=flip` to reverse the order & show output unit first. So, {{convert\|6\|km\|disp=flip}} shows "3.7 miles (6 km)". To get symbol "mi" use abbr=in, to abbreviate the input unit (left-side unit).
Display unit name (only)	attach `\|disp=unit` to show the unit name for a symbol The unit name will be plural when the amount is not 1, or hyphenated when adj=on. So, {{convert\|2\|cuyd\|disp=unit}} shows "cubic yards" plural.
Display amounts as table cells	attach `\|disp=table` (or `\|disp=tablecen`) Note: For use in tables, the template must start on a new line after a pipe. Only the number will be displayed unless you set `\|abbr=on`, `\|lk=on`, `\|lk=in` or `\|lk=out`. Example: here
Round to a specified number of significant figures	attach `\|sigfig={some integer greater than zero}`. In the case of temperatures Celsius or Fahrenheit this refers to the difference with the absolute-zero temperature. For example, at room temperature two significant digits means rounded to tens of degrees.
Round by 5	attach `\|disp=5` to round the output amount to the nearest 5 units. Not supported for all options.
Let Convert decide the unit to convert to	skip the precision parameter (the 3rd or 4th unnamed parameter) e.g. `{{convert\|100\|km\|ft}}` gives 100 kilometres (330,000 ft) and `{{convert\|100\|km}}` gives 100 kilometres (62 mi).
Display input value with a fraction	{{convert\|3/8\|in\|mm\|3\|abbr=on}} → ³⁄₈ in (9.525 mm) or {{convert\|11+1/4\|in\|cm\|2\|abbr=on}} → 11 ¹⁄₄ in (28.58 cm) For negative amounts, use two minus signs (hyphens): -11-1/4.
Generate a hidden sort key for use with a sortable table	attach `\|sortable=on` to generate a hidden sort key so that sortable tables will sort correctly. This uses {{ntsh}} to generate a sort key from the first numeric value. It ignores any additional values, ie, if you use `6\|ft\|2\|in` as the value, it will only use the 6 for the sort key. This will cause numeric values to sort in numeric order, ie: 5, 10, 15 instead of 10, 15, 5.

Parameters still under construction

Parameters still under construction. May not work in all situations
disp=5^{[note 1]}	The output will be rounded to the nearest 5 units. Might not work when linking unit names.
disp=tablecen^{[note 1]}	Similar to disp=table except that the values with be centered within the column. See the tables at La Nouvelle branch, BM-21 Grad for in use examples.
abbr=in	Abbreviates only the input unit.
abbr=out	Abbreviates only the output unit.
disp=br	This separates input and output units with a forced line break. This can be useful in tables with limited horizontal space.
disp=sqbr	Shows square brackets "[ ]" instead of parentheses "( )" in output. Example: 55 miles [89 km]. This option can be used in direct quotes, to show conversions in editorial brackets. See: attach `\|disp=x\|[\|]`, above, as another way of showing brackets "[ ]".

↑ ^1.0 ^1.1 This is a limited, temporary option, until an alternative can be implemented.

Rounding

Convert supports four types of rounding:

Rounding to a given precision: Specify the desired precision with the fourth unnamed parameter (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest power of ¹⁄₁₀ this number. For instance, if the result is 8621 and the round number is '-2', the result will be 8600. If the result is '234.0283043' and the round number is '0', the result will be 234.

Rounding to a given number of significant figures: Specify the desired number of significant figures using |sigfig={some integer greater than zero} as noted above.

Default rounding: If neither the desired precision nor the desired number of significant figures is specified, the conversion will be rounded either to precision comparable to that of the input value (the number of digits after the decimal point—or the negative of the number of non-significant zeroes before the point—is increased by one if the conversion is a multiplication by a number between 0.02 and 0.2, remains the same if the factor is between 0.2 and 2, is decreased by 1 if it is between 2 and 20, and so on) or to two significant figures, whichever is more precise. An exception to this is temperature, wherein the conversion will be rounded either to precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.

Examples of default rounding
Input	Displays as	Note
{{convert\|550\|ft\|m\|0}}	550 feet (168 m)	Approximate value is 167.64 m
{{convert\|550\|ft\|m}}	550 feet (170 m)	Rounds to 170, when approximate value is 167.64 m
{{convert\|500\|ft\|m\|0}}	500 feet (152 m)	Approximate value is 152.4 m
{{convert\|500\|ft\|m}}	500 feet (150 m)	Rounds to 150, when approximate value is 152.4 m

Units supported

See also: Convert/list of units

The table below lists units supported by this template. It is divided up according to the quantity being measured. Not all supported units are listed here; there are links to more complete lists for each quantity.

The codes listed in the code column (column 3) are accepted as input by the template. These can be used as the second or third unnamed parameter. For some units there exist alternative codes. These are listed in brackets and have been incorporated to make the code more flexible for editors, e.g. °F or F may be entered.

The codes listed in the combinations column (column 7) can be used to produce multiple conversions. They can only be used as the third unnamed parameter, e.g. {{convert|55|nmi|km mi}} produces "55 nautical miles (102 km; 63 mi)".

Abridged list of units supported by {{Convert}}
Explanation
system	unit	unit- code	symbol or abbrev.	notes	sample default conversion	combination output units
the system(s) to which the unit belongs	units listed by name	unit-code to use in template	symbols shown in output	other notes about the units	sample of the default conversion for the unit	output codes for multiple conversions
LENGTH (Full list)
system	unit	unit- code	abbrev- iation	notes	sample default conversion	combination output units
SI	megametre	Mm	Mm	US spelling: megameter	1.0 Mm (620 mi)
	kilometre	km	km	US spelling: kilometer	1.0 km (0.62 mi)	km mi
	metre	m	m	US spelling: meter	1.0 m (3 ft 3 in)	m ft m ftin
	centimetre	cm	cm	US spelling: centimeter	1.0 cm (0.39 in)	cm in
	millimetre	mm	mm	US spelling: millimeter	1.0 mm (0.039 in)	mm in
	micrometre	μm (um)	µm	US spelling: micrometer	1.0 µm (3.9×10⁻⁵ in)
	nanometre	nm	nm	US spelling: nanometer	1.0 nm (3.9×10⁻⁸ in)
non-SI metric	ångström	Å (angstrom)	Å		1.0 Å (3.9×10⁻⁹ in)
Imperial & US customary	mile	mi	mi		1.0 mi (1.6 km)	mi km
	furlong	furlong	(none)		1.0 furlong (660 ft; 200 m)
	chain	chain	(none)		1.0 chain (66 ft; 20 m)
	rod	rd	rd	For other names of this unit see the full list.	1.0 rd (17 ft; 5.0 m)
	fathom	fathom	(none)	assumes 1 fathom ≡ 6 ft	1.0 fathom (6.0 ft; 1.8 m)
	yard	yd	yd	assumes the international definition	1.0 yd (0.91 m)
	foot	ft (foot)	ft	code "foot" will show "foot" if plural. code "ft" will show "foot" or "feet" depending on value.	1.0 ft (0.30 m)	ftin (feet and inches) ft m (foot m)
	inch	in	in		1.0 in (25 mm)	in cm in mm
Other	nautical mile	nmi	nmi	the international standard nautical mile For other nautical miles see the full list.	1.0 nmi (1.9 km; 1.2 mi)
	parsec	pc	pc		1.0 pc (3.3 ly)
	light-year	ly	ly		1.0 ly (63,000 AU)
	astronomical unit	AU	AU		1.0 AU (150,000,000 km; 93,000,000 mi)
AREA (Full list)
system	unit	unit- code	abbrev- iation	notes	sample default conversion	combination output units
SI	square kilometre	km2	km²	US spelling: square kilometer	1.0 km² (0.39 sq mi)	km2 sqmi
	square metre	m2	m²	US spelling: square meter	1.0 m² (11 sq ft)	m2 sqft
	square centimetre	cm2	cm²	US spelling: square centimeter	1.0 cm² (0.16 sq in)	cm2 sqin
	square millimetre	mm2	mm²	US spelling: square millimeter	1.0 mm² (0.0016 sq in)	mm2 sqin
non-SI metric	hectare	ha	ha		1.0 ha (2.5 acres)
Imperial & US customary	square mile	sqmi	sq mi		1.0 sq mi (2.6 km²)	sqmi km2
	acre	acre	(none)		1.0 acre (0.40 ha)
	square yard	sqyd	sq yd		1.0 sq yd (0.84 m²)
	square foot	sqft (sqfoot)	sq ft	code "sqfoot" will show "square foot" if plural. code "sqfoot" will show "foot" or "feet" depending on value.	1.0 sq ft (0.093 m²)	sqft m2 (sqfoot m2)
	square inch	sqin	sq in		1.0 sq in (6.5 cm²)	sqin cm2
Other	square nautical mile	sqnmi	sq nmi		1.0 sq nmi (3.4 km²; 1.3 sq mi)
	dunam	dunam	(none)	For alternative spellings and definitions see the full list	1.0 dunam (0.0010 km²; 0.00039 sq mi)
	tsubo	tsubo	(none)		1.0 tsubo (3.3 m²)
VOLUME (Full list)
system	unit	unit- code	abbrev- iation	notes	sample default conversion	combination output units
SI	cubic metre	m3	m³	US spelling: cubic meter one kilolitre	1.0 m³ (35 cu ft)
	cubic centimetre	cm3	cm³	US spelling: cubic centimeter one millilitre	1.0 cm³ (0.061 cu in)
	cubic centimetre	cc	cc	US spelling: cubic centimeter one millilitre	1.0 cm³ (0.061 cu in)
	cubic millimetre	mm3	mm³	US spelling: cubic millimeter	1.0 mm³ (6.1×10⁻⁵ cu in)
non-SI metric	kilolitre	kl	kl	US spelling: kiloliter one cubic metre	1.0 kl (35 cu ft)
	kilolitre	kL	kL	US spelling: kiloliter one cubic metre	1.0 kl (35 cu ft)
	litre	l	l	US spelling: liter one cubic decimetre Allows triple output units. See: full list.	1.0 l (0.22 imp gal; 0.26 US gal)	l impgal l USgal l U.S.gal l USdrygal l U.S.drygal
	litre	L	L		1.0 l (0.22 imp gal; 0.26 US gal)	L impgal L impqt L USgal L U.S.gal L USdrygal L U.S.drygal
	centilitre	cl	cl	US spelling: centiliter	1.0 cl (0.35 imp fl oz; 0.34 US fl oz)
	centilitre	cL	cL	US spelling: centiliter	1.0 cl (0.35 imp fl oz; 0.34 US fl oz)
	millilitre	ml	ml	US spelling: milliliter one cubic centimetre	1.0 ml (0.035 imp fl oz; 0.034 US fl oz)	ml impoz ml USoz ml U.S.oz
	millilitre	mL	mL	US spelling: milliliter one cubic centimetre	1.0 ml (0.035 imp fl oz; 0.034 US fl oz)	mL impoz mL USoz mL U.S.oz
Imperial & US customary	cubic yard	cuyd	cu yd		1.0 cu yd (0.76 m³)
	cubic foot	cuft (cufoot)	cu ft	code "cufoot" will show "cubic foot" if plural. code "cufoot" will show "foot" or "feet" depending on value.	1.0 cu ft (0.028 m³)
	cubic inch	cuin	cu in		1.0 cu in (16 cm³)
Imperial	imperial barrel	impbbl	imp bbl	36 imp gal	1.0 imp bbl (160 l; 36 imp gal; 43 US gal)
	imperial bushel	impbsh	imp bsh	8 imp gal	1.0 imp bsh (36 l; 8.0 imp gal; 8.3 US dry gal)
	imperial bushel	impbu	imp bu	8 imp gal	1.0 imp bsh (36 l; 8.0 imp gal; 8.3 US dry gal)
	imperial gallon	impgal	imp gal	4.54609 litres by definition, also 4 imp qt or 8 imp pt or 160 imp fl oz Allows triple output units. See: full list.	1.0 imp gal (4.5 l; 1.2 US gal)	impgal l impgal L impgal USgal impgal U.S.gal impgal USdrygal impgal U.S.drygal
	imperial quart	impqt	imp qt	1/4 imp gal or 40 imp fl oz	1.0 imp qt (1,100 ml; 38 US fl oz)
	imperial pint	imppt	imp pt	1/8 imp gal or 20 imp fl oz	1.0 imp pt (0.57 l)
	imperial fluid ounce	impoz (impfloz)	imp fl oz	1/160 imp gal	1.0 imp fl oz (28 ml; 0.96 US fl oz)	impoz USoz impoz U.S.oz impoz ml impoz mL
US customary liquid measure	US barrel	USbbl	US bbl	31½ US gal used for liquids except for oil and beer (see the full list)	1.0 US bbl (120 l; 32 US gal; 26 imp gal)
	US barrel	U.S.bbl	U.S. bbl		1.0 US bbl (120 l; 32 US gal; 26 imp gal)
	barrel	oilbbl	bbl	42 US gal	1.0 bbl (0.16 m³)
	US beer barrel	USbeerbbl (usbeerbbl)	US bbl		1.0 US bbl (120 l; 31 US gal; 26 imp gal)
	US beer barrel	U.S.beerbbl (usbeerbbl)	U.S. bbl		1.0 US bbl (120 l; 31 US gal; 26 imp gal)
	US gallon	USgal	US gal	231 cubic inches by definition, also 4 US qt or 8 US pt or 128 US fl oz Allows triple output units. See: full list.	1.0 US gal (3.8 l; 0.83 imp gal)	USgal l USgal L USgal impgal
	US gallon	U.S.gal	U.S. gal		1.0 US gal (3.8 l; 0.83 imp gal)	USgal l USgal L USgal impgal
	US quart	USqt	US qt	1/4 US gal or 32 US fl oz	1.0 US qt (950 ml)
	US quart	U.S.qt	U.S. qt	1/4 US gal or 32 US fl oz	1.0 US qt (950 ml)
	US pint	USpt	US pt	1/8 US gal or 16 US fl oz	1.0 US pt (0.47 l; 0.83 imp pt)
	US pint	U.S.pt	U.S. pt	1/8 US gal or 16 US fl oz	1.0 US pt (0.47 l; 0.83 imp pt)
	US fluid ounce	USoz (USfloz)	US fl oz	1/128 US gal	1.0 US fl oz (30 ml)	USoz ml USoz mL USoz impoz
	US fluid ounce	U.S.oz (U.S.floz)	U.S. fl oz	1/128 US gal	1.0 US fl oz (30 ml)	U.S.oz ml U.S.oz mL U.S.oz impoz
US customary dry measure	US dry barrel	USdrybbl	US dry bbl	105/32 US bsh	1.0 US dry bbl (0.12 m³)
	US dry barrel	U.S.drybbl	U.S. dry bbl	105/32 US bsh	1.0 US dry bbl (0.12 m³)
	US bushel	USbsh	US bsh	2150.42 cubic inches by definition	1.0 US bsh (35 l; 8.0 US dry gal; 7.8 imp gal)
	US bushel	U.S.bsh	U.S. bsh	2150.42 cubic inches by definition	1.0 US bsh (35 l; 8.0 US dry gal; 7.8 imp gal)
	US bushel	USbu	US bu	2150.42 cubic inches by definition	1.0 US bu (35 l; 8.0 US dry gal; 7.8 imp gal)
	US bushel	U.S.bu	U.S. bu	2150.42 cubic inches by definition	1.0 US bu (35 l; 8.0 US dry gal; 7.8 imp gal)
	US dry gallon	USdrygal	US dry gal	1/8 US bsh Allows triple output units. See: full list.	1.0 US dry gal (4.4 l)	USdrygal l USdrygal L USdrygal impgal
	US dry gallon	U.S.drygal	U.S. dry gal	1/8 US bsh Allows triple output units. See: full list.	1.0 US dry gal (4.4 l)	U.S.drygal l U.S.drygal L U.S.drygal impgal
	US dry quart	USdryqt	US dry qt	1/32 US bsh	1.0 US dry qt (1,100 ml)
	US dry quart	U.S.dryqt	U.S. dry qt	1/32 US bsh	1.0 US dry qt (1,100 ml)
	US dry pint	USdrypt	US dry pt	1/32 US bsh	1.0 US dry pt (550 ml)
	US dry pint	U.S.drypt	U.S. dry pt	1/32 US bsh	1.0 US dry pt (550 ml)
SPEED (Full list)
system	unit	unit- code	abbrev- iation	notes	sample default conversion	combination output units
SI	metre per second	m/s	m/s	US spelling: meter per second	1.0 m/s (3.3 ft/s)	m/s ft/s (m/s foot/s)
non-SI metric	kilometre per hour	km/h	km/h	US spelling: kilometer per hour	1.0 km/h (0.62 mph)	km/h mph
Imperial & US customary	mile per hour	mph	mph		1.0 mph (1.6 km/h)	mph km/h mph kn
Imperial & US customary	foot per second	ft/s (foot/s)	ft/s	code "foot/s" will show "foot per second" if plural. code "foot/s" will show "foot" or "feet" depending on value.	1.0 ft/s (0.30 m/s)	ft/s m/s
Maritime units	knot	kn (knot)	kn		1.0 kn (1.9 km/h; 1.2 mph)	kn mph
FORCE (Full list)
system	unit	unit- code	abbrev- iation	notes	sample default conversion	combination output units
SI	giganewton	GN	GN	Allows triple output units. See: full list.	1.0 GN (220,000,000 lb_f)	GN LT-f GN LTf GN ST-f GN STf
	meganewton	MN	MN	Allows triple output units. See: full list.	1.0 MN (220,000 lb_f)	MN LT-f MN LTf MN ST-f MN STf
	kilonewton	kN	Script error	Allows triple output units. See: full list.	Script error	kN LT-f kN LTf kN ST-f kN STf
	Script error	N	Script error		Script error	N lb-f N lbf N oz-f N ozf
	Script error	mN	Script error		Script error	mN oz-f mN ozf mN gr-f mN grf
	Script error	μN (uN)	Script error		Script error	μN gr-f μN grf
	Script error	nN	Script error		Script error	nN gr-f nN grf
cgs	Script error	Mdyn	Script error		Script error
	Script error	kdyn	Script error		Script error
	Script error	dyn (dyne)	Script error		Script error
	Script error	mdyn	Script error		Script error
Metric gravitational units	Script error	t-f	Script error		Script error
	Script error	tf	Script error		Script error
	Script error	kg-f	Script error		Script error
	Script error	kgf	Script error		Script error
	Script error	g-f	Script error		Script error
	Script error	gf	Script error		Script error
	Script error	mg-f	Script error		Script error
	Script error	mgf	Script error		Script error
Avoirdupois-based units	Script error	pdl	Script error		Script error
	Script error	LT-f	Script error		Script error	LT-f ST-f
	Script error	LTf	Script error		Script error	LTf STf
	Script error	ST-f	Script error		Script error	ST-f LT-f
	Script error	STf	Script error		Script error	STf LTf
	Script error	lb-f	Script error		Script error
	Script error	lbf	Script error		Script error
	Script error	gr-f	Script error		Script error
	Script error	grf	Script error		Script error
ENERGY (Full list)
system	unit	unit- code	abbrev- iation	notes	sample default conversion	combination output units
SI	Script error	GJ	Script error		Script error
	Script error	MJ	Script error		Script error
	Script error	kJ	Script error		Script error
	Script error	hJ	Script error		Script error
	Script error	daJ	Script error		Script error
	Script error	J	Script error		Script error
	Script error	dJ	Script error		Script error
	Script error	cJ	Script error		Script error
	Script error	mJ	Script error		Script error
	Script error	μJ (uJ)	Script error		Script error
	Script error	nJ	Script error		Script error
cgs	Script error	Merg	Script error		Script error
	Script error	kerg	Script error		Script error
	Script error	erg	Script error		Script error
Watt-hour multiples	Script error	TWh	Script error		Script error
	Script error	TW.h	Script error		Script error
	Script error	GWh	Script error		Script error
	Script error	GW.h	Script error		Script error
	Script error	MWh	Script error		Script error
	Script error	MW.h	Script error		Script error
	Script error	kWh	Script error		Script error
	Script error	kW.h	Script error		Script error
	Script error	Wh	Script error		Script error
	Script error	W.h	Script error		Script error
Electron- volt multiples
	Script error	GeV	Script error		Script error
	Script error	MeV	Script error		Script error
	Script error	keV	Script error		Script error
	Script error	eV	Script error		Script error
	Script error	meV	Script error		Script error
Calorie multiples	Script error	Cal	Script error	The thermo-chemical calorie is the default definition. For others, see the full list.	Script error
	Script error	Mcal	Script error		Script error
	Script error	kcal	Script error		Script error
	Script error	cal	Script error		Script error
	Script error	mcal	Script error		Script error
pound/ ounce-foot/ inch-hour-minute-second	Script error	ftpdl	Script error		Script error
	Script error	ftlbf	Script error		Script error
	Script error	ftlb-f	Script error		Script error
	Script error	inlbf	Script error		Script error
	Script error	inlb-f	Script error		Script error
	Script error	inozf	Script error		Script error
	Script error	inoz-f	Script error		Script error
	Script error	hph	Script error		Script error
British thermal unit	Script error	Btu	Script error	The International Steam Table British thermal unit is used. For others, see the full list.	Script error
British thermal unit	Script error	BTU	Script error
TNT-based units	Script error	GtTNT	Script error		Script error
	Script error	GtonTNT	Script error		Script error
	Script error	MtTNT	Script error		Script error
	Script error	MtonTNT	Script error		Script error
	Script error	ktTNT	Script error		Script error
	Script error	ktonTNT	Script error		Script error
	Script error	tTNT	Script error		Script error
	Script error	tonTNT	Script error		Script error
Other
	Script error	Eh	Script error		Script error
	Script error	Ry	Script error		Script error
	Script error	toe	Script error		Script error
	Script error	BOE	Script error		Script error
	cubic foot of natural gas	cuftnaturalgas (cufootnaturalgas)		Unit-code cufootnaturalgas will show "cubic foot of natural gas" if plural.	Script error
	Script error	latm	Script error		Script error
	Script error	Latm	Script error		Script error
	Script error	impgalatm	Script error		Script error
	Script error	USgalatm (usgalatm)	Script error		Script error
	Script error	U.S.galatm (usgalatm)	Script error		Script error
TEMPERATURE (Full list)
system	unit	unit- code	abbrev- iation	notes	sample default conversion	combination output units
SI	Script error	K	Script error	Allows triple output units. See: full list.	Script error	K °C (K C) K °R (K R) K °F (K F)
SI	Script error	°C (C)	Script error		Script error	°C K (C K) °C °R (C R) °C °F (C F)
Imperial & US customary	Script error	°R (R)	Script error		Script error	°R K (R K) °R °C (R C) °R °F (R F)
Imperial & US customary	Script error	°F (F)	Script error		Script error	°F K (F K) °F °C (F C) °F °R (F R)
	Celsius change	C-change		Used for temperature intervals instead of absolute temperatures Example: {{convert\|5\|C-change\|0}} warmer Result: Script error warmer
	Fahrenheit change	F-change		Used for temperature intervals instead of absolute temperatures Example: {{convert\|10\|F-change\|0}} colder Result: Script error colder
MASS (Full list)
system	unit	unit- code	abbrev- iation	notes	sample default conversion	combination output units
SI	Script error	kg	Script error	Allows triple output units. See: full list.	Script error	kg lb kg st
	Script error	g	Script error		Script error	g oz
	Script error	mg	Script error		Script error	mg gr
	Script error	μg (ug)	Script error		Script error
non-SI metric	Script error	t	Script error	Allows triple output units. See: full list.	Script error	t LT t ST
non-SI metric	Script error	MT	Script error	Allows triple output units. See: full list.	Script error	MT LT MT ST
Avoirdupois	Script error	LT	Script error	2,240 lb used mostly in the British Commonwealth. Allows triple output units. See: full list.	Script error	LT t LT MT LT ST
	Script error	long ton	Script error		Script error
	Script error	ST	Script error	2,000 lb used mostly in the US. Allows triple output units. See: full list.	Script error	ST t ST MT ST LT
	Script error	short ton	Script error		Script error
	Script error	st	Script error	14 lb used mostly in the British Commonwealth except Canada. Allows triple output units. See: full list.	Script error	st kg st lb
	Script error	lb	Script error	Allows triple output units. See: full list.	Script error	lb kg lb st
	Script error	oz	Script error		Script error	oz g
	Script error	drachm	Script error		Script error
	Script error	dram	Script error		Script error
	Script error	gr	Script error	equivalent to the troy grain	Script error
Troy	Script error	ozt	Script error		Script error
other	Script error	carat	Script error		Script error
TORQUE (Full list)
system	unit	unit- code	abbrev- iation	notes	sample default conversion	combination output units
Industrial
SI	Script error	Nm	Script error	Triple combinations are also possible. See the full list.	Script error	Nm kg.m Nm lb.ft
Non-SI metric	Script error	kg.m	Script error		Script error	kg.m Nm kg.m lb.ft
Imperial & US customary	Script error	lb.ft	Script error		Script error	lb.ft Nm lb.ft kg-m
Scientific
SI	Script error	N.m	Script error	Triple combinations are also possible. See the full list.	Script error	N.m kgf.m N.m lbf.ft
Non-SI metric	Script error	kgf.m	Script error		Script error	kgf.m N.m kgf.m lbf.ft
Imperial & US customary	Script error	lbf.ft	Script error		Script error	lbf.ft N.m lbf.ft kgf.m
DENSITY (Full list)
system	unit	unit- code	abbrev- iation	notes	sample default conversion	combination output units
Metric	Script error	kg/m3	Script error		Script error	kg/m3 lb/ft3 (kg/m3 lb/cuft) kg/m3 lb/yd3 (kg/m3 lb/cuyd)
Metric	Script error	g/m3	Script error		Script error	g/m3 kg/m3 g/m3 lb/ft3 (g/cm3 lb/cuft) g/m3 lb/yd3 (g/cm3 lb/cuyd)
Imperial & US customary	Script error	lb/ft3	Script error		Script error	lb/ft3 kg/m3 (lb/cu ft g/m3) lb/ft3 g/m3 (lb/cu ft g/m3)
Imperial & US customary	Script error	lb/yd3	Script error		Script error	lb/yd3 kg/m3 (lb/cuyd kg/m3) lb/yd3 g/m3 (lb/cuyd g/m3)
PRESSURE
	unit	unit- code	abbrev- iation		sample default conversion
	Script error	GPa	Script error		Script error
	Script error	MPa	Script error		Script error
	Script error	kPa	Script error		Script error
	Script error	hPa	Script error		Script error
	Script error	Pa	Script error		Script error
	Script error	mPa	Script error		Script error
	Script error	mbar	Script error		Script error
	Script error	mb	Script error		Script error
	Script error	dbar	Script error		Script error
	Script error	bar	Script error		Script error
	Script error	kBa	Script error		Script error
	Script error	Ba	Script error		Script error
	Script error	atm	Script error		Script error
	Script error	Torr	Script error		Script error
	Script error	mmHg	Script error		Script error
	Script error	inHg	Script error		Script error
	Script error	psi	Script error		Script error
FUEL EFFICIENCY
	unit	unit- code		notes		combinations
	kilometres per litre	km/l (km/L)		Use `km/L` to get "km/L"		km/l mpgimp km/l mpgus
	litres per 100 kilometres	l/100 km (L/100 km)		Use `L/100 km` to get "L/100 km"		l/100 km mpgimp l/100 km mpgus
	litres per kilometre	l/km (L/km)		Use `L/km` to get "L/km"		l/km impgal/mi l/km usgal/mi
	miles per imperial gallon	mpgimp				mpgimp mpgus
	miles per US gallon	mpgus (mpgUS, mpgU.S.)		Use `mpgUS` to get "US" Use `mpgU.S.` to get "U.S." `mpgus` will give "U.S." if spelling is set to US & "US" otherwise		mpgus mpgimp
	imperial gallons per mile	impgal/mi				impgal/mi
	US gallons per mile	usgal/mi (USgal/mi, U.S.gal/mi)		As above with the `us` vs `US` vs `U.S.`		usgal/mi
The `mpgUS`, `mpgU.S.`, `USgal/mi` vs `U.S.gal/mi`, `km/L`, `L/100 km` and `L/km` variants work within combinations also (making 36 combinations in total).
POWER
Watts, kilowatts, milliwatts, etc. are supported. As is horsepower (English & metric). Use standard abbreviations as input code (lowercase hp for horsepower, for example)
POPULATION DENSITY
	unit	unit- code		notes		combinations
	inhabitants per square kilometre	PD/sqkm		`PD` stands for population density, i.e. humans (inhabitants)		PD/sqkm PD/sqmi
	per square kilometre	/sqkm		Used when the word 'inhabitants' would be inappropriate.		/sqkm /sqmi
	inhabitants per hectare	PD/ha				PD/ha PD/acre
	per hectare	/ha				/ha /acre
	inhabitants per square mile	PD/sqmi		`PD` stands for population density, i.e. humans (inhabitants)		PD/sqmi PD/sqkm
	per square mile	/sqmi		Used when the word 'inhabitants' would be inappropriate.		/sqmi /sqkm
	inhabitants per acre	PD/acre				PD/acre PD/ha
	per acre	/acre				/acre /ha
COST PER UNIT MASS
	unit	unit- code		notes		combinations
	dollars per pound	$/lb		"$" can mean US$, HK$, etc.		(none)
	dollars per kilogram	$/kg				(none)
	dollars per troy ounce	$/ozt		12 troy ounces in 1 troy pound		(none)

Examples

Monitor quality or look at examples at {{Convert/check}}.

TemplateData

This is the TemplateData documentation for the template used by the new VisualEditor.

Convert/doc

Converts measurements to other units.

Template parameters
Parameter		Description	Type	Default	Status
value	`1`	the value to convert	`number`	empty	optional
from unit	`2`		`string/line`	empty	optional
to units	`3`		`string/line`	empty	optional
precision or suffix	`4`	significant digits after decimal dot or, if negative, exponent of ten	`number`	empty	optional
link units	`lk`	“on” all, “in” input, “out” output or “off” no units	`string/line`	off	optional
abbreviation	`abbr`	show “on” unit symbols, “off” all unit names in full words, “in” abbreviated input units, “out” abbreviated output units or “values” no unit names	`string/line`	empty	optional
spelling	`sp`	“us” US	`string/line`	empty	optional
adjective	`adj`	adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end	`string/line`	empty	optional
conversion	`disp`	show conversion … “or” after ‘or’, “b” in parentheses, “x” with custom prefix and suffix, “table”/“tablecen”, “output only” alone, “output number only” alone and without unit, “flip” first, “unit” not at all but input unit; if the value is a number it is used as precision	`string/line`	b	optional
significant figures	`sigfig`	number that sets the number of significant figures	`number`	empty	optional
sort key	`sortable`	“on” generate a hidden sort key	`string/line`	empty	optional

Difference between revisions of "Template:Convert/doc"

Latest revision as of 23:44, 1 February 2014

Contents

Usage

Examples

Single value

Range of 2 values

Range/set of 3 or 4 values

Parameters

Parameters still under construction

Rounding

Units supported

Examples

TemplateData

See also

Navigation menu

Personal tools

Namespaces

Variants

Views

Actions

Search

Navigation

Tools

Revision as of 13:10, 28 January 2014 (view source) DePiep (Talk) (→‎See also: Convert error categories)	Latest revision as of 23:44, 1 February 2014 (view source) AlexNik (Talk \| contribs) m (1 revision)
(No difference)