Template:Convert/doc

From Vanatas

Template:High-use Template:For Template:Transwiki guide Template:Lua Template {{convert}} calculates a measurement value (number × unit) into the same measurement by a different unit, and then presents the results, formatted. The complete list of unit symbols recognized by the template is here.

For example:

{{convert|2|km|mi}} → 2 kilometres (1.2 mi) (km entered, converted into miles)
{{convert|7|mi|km}} → 7 miles (11 km) (mi entered, converted into km)

Numbers can be rounded, units can be abbreviated into symbols:

{{convert|2|km|mi|2|abbr=on}} → 2 km (1.24 mi)
{{convert|7|mi|km|2|abbr=on}} → 7 mi (11.27 km)

Value ranges can be entered using |to|... or |-|...:

{{convert|2|to|5|km|mi}} → 2 to 5 kilometres (1.2 to 3.1 mi)
{{convert|2|-|5|km|mi}} → 2–5 kilometres (1.2–3.1 mi)

Combined effect example:

{{convert|2|-|5|km|mi|2|abbr=on}} → 2–5 km (1.24–3.11 mi)
{{convert|2|and|5|km|mi|sigfig=3|abbr=off}} → 2 and 5 kilometres (1.24 and 3.11 miles)

Units to convert[edit source]

Enter units to convert from into:

  • {{convert|1|lb|kg}} → 1 pound (0.45 kg)
SI units generally accept prefixes, like "m" for milli (10−3), and "M" for mega (106)
For "per" units, use "/" (slash): kg/ha (see § 'per' units: kg/ha and § Currency per unit: $/km)
For three-unit units, etc., see Template:Cl

Unit name or symbol (abbreviation): 1 pound or 1 lb?[edit source]

By default, the first quantity shows the unit name, the second shows the symbol (or abbreviation):

  • {{convert|1|lb|kg}} → 1 pound (0.45 kg)

Using Template:Para shows the symbol for first (left-hand side) unit, and the name instead of the symbol for the second unit:

  • {{convert|1|lb|kg|abbr=in}} → 1 lb (0.45 kilograms)

To abbreviate both or neither:

  • {{convert|1|lb|kg|abbr=on}} → 1 lb (0.45 kg)
  • {{convert|1|lb|kg|abbr=off}} → 1 pound (0.45 kilograms)

Convenience: Template:Tlf has Template:Para by default[edit source]

Template {{cvt}} is the same as Template:Tlf, except that it has Template:Para as the default behavior. In Template:Tlf, all other options are available. So:

{{cvt|1|lb|kg}} → 1 lb (0.45 kg)

is equivalent to:

{{convert|1|lb|kg|abbr=on}} → 1 lb (0.45 kg)

Adjective: a 10-mile distance[edit source]

Use Template:Para to produce the adjectival (hyphenated) form:

  • A {{convert|10|mi|km|adj=on}} distance → A 10-mile (16 km) distance.

Default behavior, for comparison:

  • {{convert|10|mi|km}} to go → 10 miles (16 km) to go.

Template:Para does not produce hyphens with unit symbols, as per Manual of Style:

  • A {{convert|9|in|cm|adj=on|abbr=on}} nail → A 9 in (23 cm) nail.

Rounding: 100 ft is 30 m or 30.5 m or 30.48 m?[edit source]

By definition, 100 ft equals 30.48 m. In practical use, it is common to round the calculated metric number. With that, there are several possibilities.

Default rounding[edit source]

By Template:Tlf default, the conversion result 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 digits, whichever is more precise. An exception to this is rounding temperatures (see below).

Examples of rounding
Input Displays as Note
{{convert|123|ft|m|-1}} 123 feet (40 m)
{{convert|123|ft|m}} 123 feet (37 m) same output as with 0 (below)
{{convert|123|ft|m|0}} 123 feet (37 m)
{{convert|123|ft|m|1}} 123 feet (37.5 m)
{{convert|123|ft|m|2}} 123 feet (37.49 m) 123 feet is exactly 37.4904 m which is rounded to 37 m if this parameter is not specified at all
{{convert|500|ft|m|-1}} 500 feet (150 m)
{{convert|500|ft|m}} 500 feet (150 m) same output as with -1 (above), because the conversion factor is between 0.2 and 2 (hence, it should produce same double-zero precision (−2) as in the input value), but the conversion must produce two significant digits at a minimum (hence, a higher single-zero precision (−1) is used)
{{convert|500|ft|m|0}} 500 feet (152 m)
{{convert|500|ft|m|1}} 500 feet (152.4 m)
{{convert|500|ft|m|2}} 500 feet (152.40 m) exact value is 152.4 m
{{convert|500|ft|cm|-3}} 500 feet (15,000 cm)
{{convert|500|ft|cm}} 500 feet (15,000 cm) same output as with -3 (above), because the conversion factor is between 20 and 200 (hence, it should decrease input value's double-zero precision (−2) by 2), but the conversion must produce two significant digits at a minimum (hence, a higher triple-zero precision (−3) is used)
{{convert|500|ft|cm|0}} 500 feet (15,240 cm)

Convert supports four types of rounding:

Round to a given precision: use a precision number[edit source]

Specify the desired precision with an integer as 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 multiple of Template:Frac to the power of this integer. For instance, if the result is 8621 and the rounding parameter is "−2", 8600 will be displayed. If the result is "123.456" and the parameter is "0", 123 will be displayed. Essentially a positive or zero rounding parameter specifies the number of decimal places; a negative value specifies the number of trailing zeroes.

Round to a given number of significant figures: Template:Para[edit source]

To specify the output number to be with n significant figures use Template:Para:

  • {{convert|1200|ft|m|sigfig=4}} → 1,200 feet (365.8 m)
  • {{convert|1200|ft|m|sigfig=3}} → 1,200 feet (366 m)
  • {{convert|1200|ft|m|sigfig=2}} → 1,200 feet (370 m)
  • {{convert|1200|ft|m|sigfig=1}} → 1,200 feet (400 m)

Default behavior, for comparison:

  • {{convert|1200|ft|m}} → 1,200 feet (370 m)

Setting Template:Para to a value less than 1 is meaningless:

  • {{convert|1200|ft|m|sigfig=0}} → 1,200 feet (370 m)* Template:Nay

Round to a multiple of 5: 15, 20, 25, ...[edit source]

Using Template:Para rounds the outcome to a multiple of 5.

  • {{convert|10|m|ft}} → 10 metres (33 ft)
  • {{convert|10|m|ft|round=5}} → 10 metres (35 ft)

Similar: using Template:Para rounds the outcome to a multiple of 25.

  • {{convert|10|m|ft}} → 10 metres (33 ft)
  • {{convert|10|m|ft|round=25}} → 10 metres (25 ft)

Default behavior, for comparison:

  • {{convert|10|m|ft|sigfig=4}} → 10 metres (32.81 ft)

In a range, one can round each value individually to the default. Use Template:Para:

  • {{convert|10 x 200 x 3000|m|ft}} → 10 by 200 by 3,000 metres (33 ft × 656 ft × 9,843 ft)
  • {{convert|10 x 200 x 3000|m|ft|round=each}} → 10 by 200 by 3,000 metres (33 ft × 660 ft × 9,800 ft)

Round to a multiple of a given fraction: Template:Frac inch[edit source]

Specify the desired denominator using Template:Para. (Denominator is the below-the-slash number, for example the 3 in Template:Frac).

  • {{convert|5.56|cm|in|frac=16}}5.56 centimetres (2+316 in)
  • {{convert|8|cm|in|frac=4}}8 centimetres (3+14 in)

The fraction is reduced when possible:

  • {{convert|8|cm|in|frac=100}}8 centimetres (3+320 in)

Default behavior uses decimal notation:

  • {{convert|5.56|cm|in}} → 5.56 centimetres (2.19 in)

Rounding temperatures: °C, °F and K[edit source]

In temperatures, the conversion will be rounded either to the 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.

  1. {{convert|10,000|C|F K}} → 10,000 °C (18,000 °F; 10,300 K)
  2. {{convert|10,000.1|C|F K}} → 10,000.1 °C (18,032.2 °F; 10,273.2 K)
  3. {{convert|-272|C|F K}} → −272 °C (−457.60 °F; 1.15 K)
  4. {{convert|-272|C}} → −272 °C (−457.60 °F)
  5. {{convert|100|C|F K}} → 100 °C (212 °F; 373 K)
  6. {{convert|0|C|F K}} → 0 °C (32 °F; 273 K)

The precision of the input number in example (1) is one digit, but the precision of its kelvins expression is three, so the precision of the Fahrenheit conversion is made three (made 180...) . (1) and (2) seem to belie the fact that a 0.1 degrees Celsius change is a 0.18 degrees Fahrenheit change, and make the 32 degrees difference shown in (1) begin to seem off somehow. Result (1) seems off until you set the significant figures yourself with Template:Para:

{{convert|10000|C|sigfig=5}} → 10,000 °C (18,032 °F)

or you set the precision positionally, relative to the decimal point (zero being at the decimal point):

{{convert|10000|C|0}} → 10,000 °C (18,032 °F)

The precision of the input number in example (2) is six, so the precision of the Fahrenheit output is six now, whereas before kelvins had determined it to be three. Examples (3) and (4) show how this can be hidden and generate questions, but it occurs there because the kelvins conversion generated the fractional parts. (Before it was the input number that generated the fractional part.) In example (3) the three input digits converted into five significant output digits because of the two digits after the decimal point, generated by the kelvins conversion. This happened again in (5), but in (6) decimal fractions were neither given as input nor induced by the kelvins conversion.

Rounding input[edit source]

There is limited support for rounding the displayed input number. The rounding takes place after conversion, so the output is based on the full-precision input. This is useful when the input is produced by Template:Tlc or otherwise available to a higher precision than is usefully displayed, and it's desirable to avoid double-rounding.

To round the input to a specified number of digits after the decimal point, use one of the parameters:

Note that it is not possible to round above the decimal place (Template:ParaTemplate:Nay). Neither is there support for significant figures, multiples of 5, or any other output-rounding feature.

The default precision is computed based on the input, so an explicit output precision must usually be supplied:

In this case, if the input were rounded before conversion, a different result would be obtained:

Into multiple units: 10 °C (50 °F; 283 K)[edit source]

Separate the multiple output units by a space:

  • {{convert|10|C|F K}} → 10 °C (50 °F; 283 K)
  • {{convert|5|km|mi nmi}} → 5 kilometres (3.1 mi; 2.7 nmi)

If the output unit names contain spaces, use + as the separator.

See also:

Ranges of values[edit source]

Template:For A range converts two values and separates them by your choice of words and punctuation.

A range: 6 to 17 kg (13 to 37 lb)[edit source]

Range indicators are entered as the second parameter (between the values). Range separators can be:

Template:Navbar-header
Separator Convert Result Notes
- {{convert|3|-|6|ft}} 3–6 feet (0.91–1.83 m) Input can be hyphen (-) or en dash (–), output uses en dash
 – (en dash) {{convert|3|–|6|ft}} 3–6 feet (0.91–1.83 m)
and {{convert|3|and|6|ft}} 3 and 6 feet (0.91 and 1.83 m)
and(-) {{convert|3|and(-)|6|ft}} 3 and 6 feet (0.91–1.83 m) Template:Para abbreviates the first unit
Template:Nowrap Template:Nowrap 3 and 6 ft (0.91–1.83 m)
or {{convert|3|or|6|ft}} 3 or 6 feet (0.91 or 1.83 m)
to {{convert|3|to|6|ft}} 3 to 6 feet (0.91 to 1.83 m)
to(-) {{convert|3|to(-)|6|ft}} 3 to 6 feet (0.91–1.83 m) Template:Para abbreviates the first unit
to(-)|abbr=on {{convert|3|to(-)|6|ft|abbr=on}} 3 to 6 ft (0.91–1.83 m)
to about {{convert|3|to about|6|ft}} Template:Nowrap
+/- {{convert|3|+/-|6|ft}} 3 ± 6 feet (0.91 ± 1.83 m)
± ± {{convert|3|±|6|ft}} 3 ± 6 feet (0.91 ± 1.83 m)
+ {{convert|3|+|6|ft}} 3 + 6 feet (0.91 + 1.83 m)
, {{convert|3|,|6|ft}} 3, 6 feet (0.91, 1.83 m)
, and {{convert|3|, and|6|ft}} Template:Nowrap
, or {{convert|3|, or|6|ft}} 3, or 6 feet (0.91, or 1.83 m)
by {{convert|3|by|6|ft}} 3 by 6 feet (0.91 by 1.83 m)
x {{convert|3|x|6|ft}} 3 by 6 feet (0.91 m × 1.83 m) Template:Para abbreviates and repeats the first unit
× × {{convert|3|×|6|ft}} 3 by 6 feet (0.91 m × 1.83 m)
x|abbr=on {{convert|3|x|6|ft|abbr=on}} 3 ft × 6 ft (0.91 m × 1.83 m)
xx Template:!mxt is deprecated. Use Template:Mxt instead
* Template:!mxt is deprecated. Use Template:Mxt instead

Multiple dimensions: 6 m × 12 m (20 ft × 39 ft)[edit source]

Use by:

  • {{convert|6|by|12|ft|m}} → 6 by 12 feet (1.8 by 3.7 m)

Use ×, multiplication sign, or x, letter:

  • {{convert|6|x|12|m|ft}} → 6 by 12 metres (20 ft × 39 ft)

In science, the formal way is to set |x| and Template:Para (keeping dimensions right, like in area = x km2):

  • {{convert|6|x|12|m|ft|abbr=on}} → 6 m × 12 m (20 ft × 39 ft)

Lists of values: 20, 40, or 60 miles[edit source]

{{convert|20|,|40|, or|60|mi}} → 20, 40, or 60 miles (32, 64, or 97 km)

About feet, inch in ranges and multiples[edit source]

While it is possible to enter feet, inch in a simple conversion, this is not possible for ranges:

Default behavior, for comparison:

  • {{convert|1|ft|3|in|mm}} → 1 foot 3 inches (380 mm)

However, converting metric units into feet and inches with Template:Para can produce the desired output:

  • {{convert|380|x|1040|mm|ftin|order=flip}} → 1 foot 3 inches by 3 feet 5 inches (380 mm × 1,040 mm)

Words[edit source]

Spelling of unit name: international metre or US meter?[edit source]

Default spelling of units is in the en (generic) locale. To show en-US spelling, use Template:Para:

{{convert|1|m|ft}} → 1 metre (3.3 ft)—default
{{convert|1|m|ft|sp=us}} → 1 meter (3.3 ft)

Spell out numbers: ten miles[edit source]

To write a number in words, use Template:Para:

  • {{convert|10|mi|m|spell=in}} → ten miles (16,000 m)

To spell out both in and out values, use Template:Para:

  • {{convert|10|mi|m|spell=on}} → ten miles (sixteen thousand metres)

To make first letter a capital, use Template:Para, Template:Para

  • {{convert|10|mi|m|spell=In}} → Ten miles (16,000 m)
  • {{convert|10|mi|m|spell=On}} → Ten miles (sixteen thousand metres)

Remember that the spelling of the units (ft, m) is independently set by Template:Para. To the extreme:

  • {{convert|10|mi|m|spell=on|abbr=off|sp=us}} → ten miles (sixteen thousand meters)

Inserted before units: 4 planted acres[edit source]

  • {{convert|4|acre||adj=pre|planted}} → 4 planted acres (1.6 ha)

disp=preunit is similar, but has no separator after the specified text, and can have different text for the output value:

  • {{convert|4|acre||disp=preunit|planted }} → 4 planted acres (1.6 planted ha)
  • {{convert|4|acre||disp=preunit|planted |reforested-}} → 4 planted acres (1.6 reforested-ha)

After adjective unit: A 10-foot-long corridor[edit source]

Note that two units (in this case, ft and m) are required. Use with just one unit will generate an error message.

{{convert|10|ft|m|adj=mid|-long}} → 10-foot-long (3.0 m)

Plurals: 1 inch, 2 inches[edit source]

The unit symbol is singular always. Depending on the preceding number only, a unit name can be shown plural.

  • {{convert|1|metre}} → 1 metre (3 ft 3 in)
  • {{convert|2|metre}} → 2 metres (6 ft 7 in)
  • {{convert|2|metre|abbr=on}} → 2 m (6 ft 7 in)
Exception

Entering the unit "foot" instead of "ft" forces singular output "foot", whatever the number is.

  • {{convert|100|foot|abbr=off}} → 100 foot (30 metres)

Fractions: one-eighth of an imperial pint[edit source]

The convert template also supports spelling out fractions.

  • {{convert|3+1/2|oz|g|spell=in}} → three and a half ounces (99 g)

Any additional words needed for the fraction can also be added at the end of the template.

  • {{convert|1/8|imppt|ml|spell=in|adj=pre|of an}} → one-eighth of an imperial pint (71 ml)

Wrapping and line breaking[edit source]

See Template:Section link

Spelling out "thousands", "millions", etc.[edit source]

Most unit codes accept a prefix of e3 (thousand) or e6 (million) or e9 (billion).

  • {{convert|100|e6mi|e6km}} → 100 million miles (160×10^6 km)
  • {{convert|120|e6acre}} → 120 million acres (490,000 km2)
  • {{convert|120|e6acre|e3km2}} → 120 million acres (490×10^3 km2)

To display both input and output in scientific notation, use Template:Para

  • {{convert|100|e6mi|e6km|abbr=on}} → 100×10^6 mi (160×10^6 km)

To spell out "thousands", "millions", etc., Template:Para abbreviates the unit; Template:Para displays both full unit names.

  • {{convert|100|e6mi|e6km|abbr=unit}} → 100 million mi (160 million km)
  • {{convert|100|e6mi|e6km|abbr=off}} → 100 million miles (160 million kilometres)

Numbers[edit source]

Using an SI prefix: gigametre (Gm), or micrometre (μm)[edit source]

Template:Sidebar metric prefixes (small) Units can have an SI prefix like G before the unit: Gm, and giga before the name: gigametre. These are plain multiplication factors.

To illustrate, these are trivial calculations (from metre to metre), showing the multiplication factor:

  • 12 Gm (1.2×1010 m)
  • 12 μm (1.2×10−5 m)

The prefix can be added before the SI unit (here: unit m for metre):

  • {{convert|12|Gm|mi|abbr=on}} → 12 Gm (7,500,000 mi)
  • Mm: 12 Mm (7,500 mi)
  • km: 12 km (39,000 ft)
  • mm: 12 mm (0.47 in)
  • μm: 12 μm (0.012 mm)
  • um: 12 μm (0.012 mm) (letter "u" can be used for "μ" here)

The prefix can be used in the output unit:

  • {{convert|12000|mi|Mm|abbr=on}} → 12,000 mi (19 Mm)
  • {{convert|12|in|μm|abbr=on}} → 12 in (300,000 μm)

As an exception, the non-SI unit "inch" can have the "μ" prefix too:

  • {{convert|12|μm|μin|abbr=on}} → 12 μm (470 μin)

Template:Further

Engineering notation: 7 × 106 m[edit source]

In the unit: e6m[edit source]

Engineering notation can be entered as a "prefix" to the unit:

  • {{convert|70|e6m}} → 70×10^6 m (230,000,000 ft)

The same is possible for the output unit:

  • {{convert|23,000,000|ft|e6m}} → 23,000,000 feet (7.0×10^6 m)

Any standard unit (not a combination, multiple, or built-in unit) can have such a prefix:

  • e3 (thousand),
  • e6 (million),
  • e9 (billion),
  • e12 (trillion),
  • e15 (quadrillion).

Scientific notation: 1.23 × 10−14[edit source]

In scientific notation, a number is written like Template:Val. The plain number has exactly one digit before the decimal point.

With Template:Tlf, the input can be in e-notation such as 12.3e4. This value is displayed as a power of ten, and the output is displayed in scientific notation, except that an output value satisfying 0.01 <= v < 1000 is shown as a normal number. In addition, if the output value is 1000 and sigfig=4 is used, the value is displayed as a normal number.

  • {{convert|12.3e-15|atm|atm|abbr=on}} → 12.3×10−15 atm (1.23×10−14 atm)
  • {{convert|0.00000005|atm|atm|abbr=on}} → 0.00000005 atm (5.0×10−8 atm)

Input with fractions: 1+12 inches (38.1 mm)[edit source]

The number to convert can be written in fractions. Both / (keyboard slash) and (fraction slash) are accepted:

  • {{convert|1/2|in|mm|1}}12 inch (12.7 mm)
  • {{convert|1⁄2|in|mm|1}}12 inch (12.7 mm)

With positive mixed numbers (a positive integer and a fraction), use a + sign

  • {{convert|2+1⁄2|in|mm|1}}2+12 inches (63.5 mm)

With negative mixed numbers, use a hyphen - and repeat it:

  • {{convert|-2-1⁄2|in|mm|1}}−2+12 inches (−63.5 mm)

Note that the following cases are not interpreted as mixed numbers:

  • {{convert|2-1⁄2|in|mm|1}}2–12 inch (50.8–12.7 mm). This is interpreted as a range from 2 inches to 1⁄2 inch.
  • {{convert|-2+1⁄2|in|mm|1}}[convert: invalid number] Template:Nay This is neither a mixed number nor a range, and mathematical expressions requiring calculations are not allowed here.
  • {{convert|2+½|in|mm|1}}[convert: invalid number] Template:Nay Fractions consisting of a single Unicode character are not allowed either.

Horizontal fraction bar: Script error: No such module "Unsubst". inch[edit source]

Using a double slash (//) provides a horizontal fraction bar for the original (input) unit:

  • {{convert|1//2|in|mm|1}}1/2 inch (12.7 mm)
  • {{convert|6+3//8|in|mm|1}}6+3/8 inches (161.9 mm)

Using a negative value for Template:Para provides a horizontal fraction bar for the converted (output) unit:

  • {{convert|12.7|mm|frac=-2}}12.7 millimetres (1/2 in)
  • {{convert|161.9|mm|frac=-8}}161.9 millimetres (6+3/8 in)

Thousands separator: 1,000 mi or 1000 mi[edit source]

In input, a comma for thousands separator is accepted but not required; a gap (space) is not accepted. In output, by default, the thousand separator is the comma:

  • {{convert|1234567|m|ft}} → 1,234,567 metres (4,050,417 ft)
  • {{convert|1,234,567|m|ft}} → 1,234,567 metres (4,050,417 ft)

Set Template:Para to remove the separator from the output:

  • {{convert|1234567|m|ft|comma=off}} → 1234567 metres (4050417 ft)

Use Template:Para to use digit grouping by gap (thin space) as a thousands separator:

  • {{convert|1234567|m|ft|comma=gaps}}1234567 metres (4050417 ft)

Default behavior, for comparison:

  • {{convert|1234567|m|ft}} → 1,234,567 metres (4,050,417 ft)

Setting Template:Para will only add the separator when the number of digits is 5 or more:

  • {{convert|1234|m|ft|comma=5}} → 1234 metres (4049 ft)
  • {{convert|1234567|m|ft|comma=5}} → 1,234,567 metres (4,050,417 ft)

Default behavior, for comparison:

  • {{convert|1234|m|ft}} → 1,234 metres (4,049 ft)

Output manipulation[edit source]

Brackets and separators: 10 m [33 ft] [edit source]

Punctuation that distinguishes the two measurements is set by Template:Para.
Options are: b (the default), sqbr, comma, or, br, br(), x|…:

  • {{convert|10|m|ft|disp=sqbr}} → 10 metres [33 ft]
  • {{convert|10|m|ft|disp=comma}} → 10 metres, 33 ft
  • {{convert|10|m|ft|disp=or}} → 10 metres or 33 feet

Default behavior, for comparison:

  • {{convert|10|m|ft}} → 10 metres (33 ft)

Setting Template:Para will force a new line (<br/>)

  • {{convert|10|m|ft|disp=br}} → 10 metres
    33 feet

Also Template:Para will force a new line, and keep the brackets (useful in tables):

  • {{convert|10|m|ft|disp=br()}} → 10 metres
    (33 feet)

Setting Template:Para allows any text as separator:

  • {{convert|10|m|ft|disp=x|_MyText_}} → 10 metres_MyText_33 ft (To display spaces, use &nbsp;)

Flipping (reordering) the two measurements: 1,609.3 metres (1 mile)[edit source]

Setting Template:Para will flip (swap) the two measurements:

  • {{convert|1|mi|m|order=flip}} → 1,609.3 metres (1 mile)

Default behavior, for comparison:

  • {{convert|1|mi|m}} → 1 mile (1,609.3 metres)

When converting to multiple units, the effect is:

  • {{convert|10|km|mi nmi|order=flip}} → 6.2137 miles; 5.3996 nautical miles (10 kilometres)
  • {{convert|10|km|nmi mi|order=flip}} → 5.3996 nautical miles; 6.2137 miles (10 kilometres)

Fixed ordering of output units: 212 °F (100 °C; 373 K)[edit source]

Setting Template:Para shows the output-units as ordered; the input unit is skipped:

  • {{convert|100|C|F C K|abbr=on|order=out}} → 212 °F (100 °C; 373 K)
  • {{convert|200|PS|kW hp|0|abbr=on|order=out}} → 147 kW (197 hp)

See also: § Displaying parts of the output.

Displaying parts of the result: 2 (1.5)[edit source]

It is possible to display only parts of the conversion result: The following examples show how to display only a part of the result.

Note: in Convert, abbr is synonym for unit symbol
Convert Returns Components
{{convert|2|cuyd|m3}} 2 cubic yards (1.5 m3) all (default conversion)
{{convert|2|cuyd|m3|abbr=on}} 2 cu yd (1.5 m3) all (default conversion, abbr)
{{convert|2|cuyd|m3Template:Bg}} 2 (1.5) numbers only
{{convert|2|cuydTemplate:Bg}} 2.0 cu yd input value (workaround)
{{convert|2|cuydTemplate:Bg}} 2.0 cu yd input value abbr (workaround)
{{convert|2|cuyd|m3Template:Bg}} cubic yards input unit
{{convert|2|cuyd|m3Template:Bg}} cubic-yard input unit, adjectival (hyphenated)
{{convert|2|cuyd|m3Template:Bg}} cu yd input unit, adjectival (abbr so not hyphenated)
{{convert|2|cuyd|m3Template:Bg}} cu yd input unit abbr
{{convert|2|cuyd|m3Template:Bg}} 1.5 m3 output value, symbols
{{convert|2|cuyd|m3Template:Bg}} 1.5 cubic metres output value, names
{{convert|2|cuyd|m3Template:Bg}} 1.5-cubic-metre output, adjective
{{convert|2|cuyd|m3Template:Bg}} 1.5 output number
{{convert|2|cuyd|m3Template:Bg}} m3 output unit (abbr by default)
{{convert|2|cuyd|m3Template:Bg}} cubic metres output unit (name)
{{convert|2|cuyd|m3Template:Bg}} m3 output unit (abbr)

Display both input name and symbol: 2 kilopascals [kPa][edit source]

Setting Template:Para returns both name and symbol of the first (input) unit:

  • {{convert|2|kPa|psi|abbr=~}} → 2 kilopascals [kPa] (0.29 psi)
  • A {{convert|2|kPa|psi|abbr=~|adj=on}} pressureTemplate:Nowrap

Table options[edit source]

For the wikitable structure, there are three options: add a line-break, split the result over columns and make the table sortable.

Enforced line break[edit source]

Template:Para adds a line-break and omits brackets.

Template:Para adds a line-break and does add brackets to the converted value. This may be useful in tables:

Template:Para Template:Para
100 kilometres
62 miles
100 kilometres
(62 miles)

Table columns[edit source]

Using {convert} in a table cell, with Template:Para splits the result over two (or more) columns. By default units are not included in the table, however, they can be added using the Template:Para parameter. Multiple-unit outputs, like ftin, always output their units to the table.

{{convert|10|m|ft|disp=table}}

style="text-align:right;"|10 |style="text-align:right;"|33

Template:Para does the same, and also centers the text:

{{convert|20|m|ft|disp=tablecen}}

style="text-align:center;"|20 |style="text-align:center;"|66

The units are added as a column header:

  kilograms pounds stone and pounds
Template:Para 10 22 1 st 8 lb
Template:Para and Template:Para 20 kg 44 lb 3 st 2 lb
Template:Para and Template:Para 30 kilograms 66 pounds 4 stone 10 pounds
Template:Para 40 88 6 st 4 lb
Template:Para (default) 50 kilograms (110 lb; 7 st 12 lb)

Sorting[edit source]

Use Template:Para to include a hidden numerical sortkey in the output, suitable for use in a table with sortable columns. Technically, this places a hidden string before the actual displayed values:

{{convert|10|m|ft|sortable=on}} Template:Nowrap
showing: 10 metres (33 ft).

Use both Template:Para and Template:Para together to produce table columns (pipe symbols) for each value in sortable columns:

m m ft
A Template:Val 15+34 52
B Template:Val 15.5 51
C Template:Val 16.0 52.5
D Template:Val 16 52

The generated sortkey is calculated in a consistent way based on both the value and its unit as passed to the convert template. In most cases convert uses the passed value converted to SI base units. It is therefore not necessarily the displayed value or other alternate units and is calculated regardless of output format options. Using different units or different order of units in individual rows should therefore not lead to incorrect sorting, although variations in rounding can give surprising results, since an unrounded number is used for the sortkey.

Units[edit source]

The conversion factors and physical constants are sourced here.

All units[edit source]

Template:Selfref

The table below lists units supported by Template:Tlf. More complete lists are linked for each dimension. For a complete list of all dimensions, see full list of units.

Template:Divbox

Template:Tlf uses unit-codes, which are similar to, but not necessarily exactly the same as, the usual written abbreviation for a given unit. These unit-codes are displayed in column 3 of the following tables. These are accepted as input by Template:Tlf as the second and third unnamed parameters:

The unit-codes should be treated as case-sensitive:

The output of Template:Tlf can display multiple converted units, if further unit-codes are specified after the second unnamed parameter (without the pipe separator). Typical combination output units are listed below in column 7.

Some units have alternative unit-codes. These are shown in brackets in column 3, e.g. °F (F). Either may be entered for Fahrenheit (but not a lower-case f).

Abridged list of supported units
Template:Large
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

Template:Convert/list of units/area/short list Template:Convert/list of units/density/short list Template:Convert/list of units/energy/short list Template:Convert/list of units/force/short list Template:Convert/list of units/length/short list Template:Convert/list of units/mass/short list Template:Convert/list of units/speed/short list Template:Convert/list of units/temperature/short list Template:Convert/list of units/torque/short list Template:Convert/list of units/volume/short list

Template:Large
(Full list)
unit unit-
code
symbol or
abbrev.
sample default
conversion
gigapascal GPa GPa 1.0 GPa (150,000 psi)
megapascal MPa MPa 1.0 MPa (150 psi)
kilopascal kPa kPa 1.0 kPa (0.15 psi)
hectopascal hPa hPa 1.0 hPa (0.015 psi)
pascal Pa Pa 1.0 Pa (0.00015 psi)
millipascal mPa mPa 1.0 mPa (1.5×10−7 psi)
millibar mbar mbar 1.0 mbar (1.0 hPa)

Template:Convert/list of units/unitaltab

decibar dbar dbar 1.0 dbar (10 kPa)
bar bar (none) 1.0 bar (100 kPa)
kilobarye kBa kBa 1.0 kBa (1.0 hPa)
barye Ba Ba 1.0 Ba (0.10 Pa)
standard atmosphere atm atm 1.0 atm (100 kPa)
torr Torr Torr 1.0 Torr (0.13 kPa)
millimetre of mercury mmHg mmHg 1.0 mmHg (0.13 kPa)
inch of mercury inHg inHg 1.0 inHg (3.4 kPa)
pound per square inch psi psi 1.0 psi (6.9 kPa)
Template:Large
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).
Template:Large
unit unit-
code
notes combinations
inhabitants per square kilometre PD/km2 PD stands for population density, i.e. humans (inhabitants)
  • PD/km2 PD/sqmi
per square kilometre /km2 Used when the word 'inhabitants' would be inappropriate.
  • /km2 /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/km2
per square mile /sqmi Used when the word 'inhabitants' would be inappropriate.
  • /sqmi /km2
inhabitants per acre PD/acre
  • PD/acre PD/ha
per acre /acre
  • /acre /ha
Template:Large
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)

'per' units: kg/ha, miles per gallon[edit source]

When using a slash (/), a unit like kg/ha is recognized as kilograms per hectare and will be converted in to other mass/area units. A unit in the numerator is not required.

  • {{convert|1000|kg/ha}} → 1,000 kilograms per hectare (890 lb/acre)
  • {{convert|350|/in2}} → 350 per square inch (54/cm2)

Population density (inhabitants per square mile) can be converted using

  • {{convert|10|PD/sqmi|PD/km2}} → 10 inhabitants per square mile (3.9/km2)

Vehicular fuel efficiency, commonly expressed in miles per gallon or litres per 100 km can also be converted

  • {{convert|26|mpgUS|l/100km mpgimp}} → 26 miles per US gallon (9.0 l/100 km; 31 mpg‑imp)

Units of difference: Expressing a change or difference in temperature[edit source]

We have already discussed standard temperature conversions (°C, °F, K), as shown in these two examples:

  • {{convert|10|C}} → 10 °C (50 °F) (standard temperature conversion)
  • {{convert|10|-|15|C}} → 10–15 °C (50–59 °F) (standard temperature range conversion)

When expressing a temperature change (e.g., "The temperature increased by 10 °C"), or when comparing temperatures (e.g., "10 to 15 °C warmer"), we cannot use the standard temperature units (Template:Para, Template:Para and Template:Para), which refer to points on the respective scale. Instead, we must use one of the following "units of difference": Template:Para, Template:Para and Template:Para.

Compare the following two examples with the two above:

  • {{convert|10|C-change}} → 10 °C (18 °F) increase in temperature
  • {{convert|10|-|15|C-change}} → 10–15 °C (18–27 °F) warmer than normal

To produce multiple units in the output:

  • {{convert|10|C-change|F-change K-change}} → 10 °C (18 °F; 10 K) difference

Multiple units: 1 ft 5 in[edit source]

In input[edit source]

Base document Template:Section link lists options for multiple unit input (like ft,in). It can catch predefined sets only (units that can be subdivided; e.g., yd into ft):

  • {{convert|1|yd|2|ft|3|in}} → 1 yard 2 feet 3 inches (1.60 m)
  • {{convert|2|ft|3|in|cm}} → 2 feet 3 inches (69 cm)
  • {{convert|1|lb|5|oz|g}} → 1 pound 5 ounces (600 g)

In output[edit source]

Available multiple-unit output options predefined, like ftin and ydftin. The full list is at Template:Section link.

  • {{convert|2|m|ftin}} → 2 metres (6 ft 7 in)
  • {{convert|2|m|ft in}} → 2 metres (6.6 ft; 79 in), using a space, returns the decimal point

Default behavior, for comparison:

  • {{convert|2|m}} → 2 metres (6 ft 7 in)

See also:

  • {{hands}} a length used to measure horses
  • {{Long ton}} a weight in ton, cwt, qr and lb

Currency per unit: $/mi → $/km[edit source]

Using currency symbols in a $ per unit value, you can convert the per-unit:

  • {{convert|10|$/mi|$/km}} → $10 per mile ($6.2/km)
  • {{convert|1500|$/ozt|$/g}} → $1,500 per troy ounce ($48/g)

You can set the currency in both values using Template:Para:

  • {{convert|10|$/mi|$/km|$=€}} → €10 per mile (€6.2/km)

It is not possible to convert the currency. So, this result (mixed currencies) is not possible: Template:!mxt Template:Nay

Using convert inside templates[edit source]

For usage in template code, like infoboxes, Template:Tlf has these options:

Pre-formatting fraction input
Your template can accept Template:Para and use {{#invoke:Convert/helper|number|16 7/8}} → Script error: No such module "Convert/helper".
Using a Wikidata property
  • Adding the Wikidata property code, like code Template:Para, to your template code automatically returns the Wikidata property for that article, and convert it. Both number and unit are read.

Note: to return that property value for an other article, use Template:Para.

Example for Template:Wikidata property link of Template:Wikidata entity link:

  • {{convert|input=P2073|qid={{get QID|Cessna 208 Caravan}}|ftin|abbr=on}} → P2073
  • {{convert|input=P2073|qid=Q1056131|km|abbr=on}} → P2073
  • {{convert|input=P2073|qid=Q1056131|km|abbr=on|disp=out}} → P2073
For example see template:Infobox Telescope.

Sometimes a property may have more than one value against it in Wikidata. You can use the Template:Para parameter to specify which of the values you want to use.

Example for Template:Wikidata property link: Note: this example uses Template:Para (testing for Template:Wikidata entity link)

Parameter list[edit source]

Template:Navbar-collapsible
Parameter Value Description Note
|abbr=in in Use symbol for first (left-hand side) unit Unit display
|abbr=off off Use name for all units Unit display
|abbr=none none
|abbr=on on Use symbol for all units Unit display
|abbr=out out Use symbol for right-hand side unit (default) Unit display
|abbr=unit unit Use symbol for all units when using scientific notation Unit display
|abbr=values values Omit both the input and output units: show only the numbers Unit display
|abbr=~ ~ Shows both unit name and symbol Unit display
|adj=mid|… mid User-specified text after the input unit; sets adj=on (adjective). Expects 1 unnamed parameter. Word adding, adjective
|adj=on on Unit name is adjective (singular and hyphenated) Grammar, adjective
|adj=pre|… pre User-specified text before input unit. Expects 1 unnamed parameter. Word adding
|adj=ri0 ri0 Round input with precision 0 Input precision
|adj=ri1 ri1 Round input with precision 1 Input precision
|adj=ri2 ri2 Round input with precision 2 Input precision
|adj=ri3 ri3 Round input with precision 3 Input precision
|comma=5 5 Only use comma for thousands separator if 5 or more digits Number format
|comma=gaps gaps Use gaps (space), not comma, for thousands separator Number format
|comma=off off No thousands separator Number format
|disp=b b Join input and output using " (...)" (default) Join values
|disp=sqbr sqbr Join input and output using " [...]" Join values
|disp=br br Join input and output using "<br/>" Join values
|disp=comma comma Join input and output using ", " Join values
|disp=or or Join input and output using " or " Join values
|disp=number number Display output number only Parts only
|disp=output number only output number only
|disp=out out Display only output number and name/symbol Parts only
|disp=output only output only
|disp=preunit|…[|…] preunit Text to be inserted after value and before units, for both input and output, with optionally different text for output. Expects 1 or 2 unnamed parameters. Word adding
|disp=table table Output is suitable for a table cell with align="right" Table columns
|disp=tablecen tablecen Output is suitable for a table cell with align="center" Table columns
|disp=unit unit Display input name/symbol only (not input number, not output) Parts only
|disp=unit2 unit2 Display output name/symbol only (not input; not output number) Parts only
|disp=x|… x Join input and output using user-specified text Word adding
|frac=N N Show imperial number in fractions, denominator=N Number format, fraction
|input=P2048 P2048 Template:Small Reads and converts Wikidata property Inside template
|lk=in in Link left-hand side unit name or symbol Unit link
|lk=on on Link all unit names or symbols (but not twice for the same unit) Unit link
|lk=out out Link right-hand side unit name or symbol Unit link
|order=flip flip Inverts order of input, output measurements (conversion first) Order
|order=out out Displays output units in the order entered, skipping input unit Order
|qid=Q1056131 Q1056131 Template:Small Reads Wikidata property from Wikidata item Inside template; testing
|qual=Q613628 Q613628 Template:Small Qualify Wikidata property
|round=5 5 Rounds calculation to the nearest multiple of 5 Output precision
|round=25 25 Rounds calculation to the nearest multiple of 25 Output precision
|round=each each In a range, each number is rounded by the default rounding Output precision
|sigfig=N N Round output number to N significant figures (N is a positive integer) Output precision
|sortable=on on Adds invisible sort key Table sort
|sp=us us Use U.S. spelling ("meter" instead of default "metre") Spelling U.S. names
|spell=in in Spell input number in words Spelling numbers
|spell=In In Spell input number in words with first letter uppercase Spelling numbers
|spell=on on Spell input and output numbers in words Spelling numbers
|spell=On On Spell input and output numbers in words with first letter uppercase Spelling numbers
|$=€ Replace $-sign with a currency sign, for example in €/hectare Cost per unit
Template:Nowrap
|debug=yes yes Debugging only. In a sortable table: show the normally hidden sort key Table sort
Template:!mxt flip Deprecated. Use Template:Mxt Order
Template:!mxt Deprecated. Use Template:Mxt Plurals

Deprecated options[edit source]

Template:Convert/doc/deprecations list

TemplateData[edit source]

Template:TemplateData header

Converts measurements to other units.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Value1

The value to convert.

Numberrequired
From unit2

The unit for the provided value.

Suggested values
km2 m2 cm2 mm2 ha sqmi acre sqyd sqft sqin km m cm mm mi yd ft in kg g mg lb oz m/s km/h mph K C F m3 cm3 mm3 L mL cuft cuin U.S.gal U.S.oz psi mpgU.S. $/lb $/kg
Example
km
Stringrequired
To units3

The units to convert into. Separate units by a space for multiple outputs. In an output unit, use + for a multiplication space.

Suggested values
km2 m2 cm2 mm2 ha sqmi acre sqyd sqft sqin km m cm mm mi yd ft in kg g mg lb oz m/s km/h mph K C F m3 cm3 mm3 L mL cuft cuin U.S.gal U.S.oz psi mpgU.S. $/lb $/kg
Example
mi nmi
Stringsuggested
Precision or suffix4

Significant digits after decimal dot or, if negative, exponent of ten.

Numberoptional
Link unitslk

Indication of what units to apply wikilinks to. Use “on” for all, “in” for the input unit, “out” for the output units, or “off” for none of the units. For more fine-grained control over which units to link, use the template multiple times.

Suggested values
in out on off
Default
off
Example
on
Stringoptional
Abbreviationabbr

Display for the units: “on” to display all units using their unit symbols, “off” to display all units in full words, “in” to display the unit symbol for the input unit, “out” to display the unit symbols for the output units, “unit” to display unit symbols for both input and output units when using scientific notation, “values” for no units at all (neither unit symbols nor full words of units).

Suggested values
in off none on out unit values ~
Default
out
Example
on, unit, in, out, off
Stringsuggested
Spellingsp

Spelling of units. Use “us” to display unit names using U.S. spelling.

Example
us
Stringoptional
Adjectiveadj

Whether to use adjectival form. Use “on” for singular unit name appended by a hyphen, “mid” to put conversion at end, or “off” (default) for no adjectival form.

Suggested values
mid on pre ri0 ri1 ri2 ri3 off
Default
off
Example
on
Unbalanced wikitextoptional
Conversiondisp

Display conversion result: “or”: after ‘or’, “x”: with custom prefix and suffix, “b”: in parentheses, “table”/“tablecen”, “output only”: alone, “output number only”: alone and without unit, “unit”: not at all but input unit; if the value is a number it is used as precision.

Suggested values
b sqbr br comma or number output number only out output only preunit table tablecen unit unit2 x
Example
b
Stringoptional
Orderingorder

“flip” returns converted value first, input value second.

Suggested values
flip out
Example
flip
Stringoptional
Significant figuressigfig

Indicates the number of significant figures to be used in rounding.

Numberoptional
Rounding outputround

The type of rounding. “5” rounds the output number to nearest multiple of 5, “25” to nearest multiple of 25, “each” rounds each number in a range.

Numberoptional
Thousands separatorcomma

Sets or suppresses the use of thousands separators in the numbers. “off”: no separator; “gaps”: use space instead of comma as thousands separator; “5”: only add thousands separator when the integral part of the number uses 5 positions or more (10,000 or more; if using comma as thousands separator, 1234 would produce '1234', 12345 would produce '12,345').

Default
on
Example
off
Booleanoptional
Sort keysortable

“on” generates a hidden sort key

Example
on
Booleanoptional
Spell numbers?spell

If used, spells input or input and output numbers in words, optionally capitalizing the first

Suggested values
in In on On
Example
'in', 'In', 'on', or 'On'
Stringoptional
Singular?sing

If 'yes', uses singular form of units (deprecated)

Example
yes
Booleandeprecated
Fraction?frac

fraction as rounding unit

Numberoptional
Currency symbol$

sets currency symbol in both units

Example
$=€ will show " €10 per mile (€6.2/km)"
Stringoptional
Mach altitude (ft)altitude_ft

Mach (speed) depends on altitide

Suggested values
10000
Numberoptional
Mach altitude (m)altitude_m

Mach (speed) depends on altitude

Numberoptional
WD propertyinput

Reads the property value of the item (article), then converts it

Example
{{convert|input=P2046}} (P2046=area)
Stringoptional

See also[edit source]

  • {{Cvt}}
  • {{SI units}}
  • {{Inflation}}, for converting historical prices to their current equivalent
  • {{To USD}}, for currency conversions

Template:Convert/documentation navbox