Fyrimynd:Convert/doc

Template {{convert}} calculates measurements from one unit (you can enter) to another one, and then presents the results. For example:

{{convert|2|km|mi}} → 2 kilometres (1,2 mi)

{{convert|7|mi|km}} → 7 miles (11 km)

The available units are listed below. Units are case-sensitive always (kW, not KW and not kw). Multiple formatting and calculation options are listed below.

See also Help:Convert for more complete information

Unit name or symbol (abbreviation): 1 pound or 1 lb?

By default, the first value shows unit name, the second the symbol (or abbreviation). Use |abbr=on/off to change this behaviour:

{{convert|1|lb|kg}} → 1 pound (0,45 kg) (To compare; default: first value shows unit name)

{{convert|1|lb|kg|abbr=on}} → 1 lb (0,45 kg)

{{convert|1|lb|kg|abbr=off}} → 1 pound (0,45 kilograms)

• |abbr=in toggles the default behaviour (|abbr=out):

{{convert|1|lb|kg|abbr=in}} → 1 lb (0,45 kilograms)

Adjective: a 10-mile distance

Use |adj=on to produce the adjective form. The difference:

{{convert|10|mi|km}} to go → 10 miles (16 km) to go. (To compare, default)

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

Rounding: 100 ft is 30 m or 30.5 m or 30.48 m?

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

By 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 figures, 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|0}}	123 feet (37 m)
{{convert|123|ft|m|1}}	123 feet (37,5 m)
{{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

Convert supports four types of rounding:

Round to a given precision: use |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.

Round to a given number of significant figures: |sigfig=

To specify the output number to be with n significant figures use |sigfig=<number>:

• To compare: {{convert|1200|ft|m}} → 1.200 feet (370 m)
• {{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)

Setting |sigfig= is meaningless

• {{convert|1200|ft|m|sigfig=0}} → 1.200 feet (370 m)

Round to a multiple of 5: 15, 20, 25, ...

Using |round=5 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 |round=25 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)

To compare: {{convert|10|m|ft|sigfig=4}} → 10 metres (32,81 ft)

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

{{convert|10 x 200 x 3000|m|ft}} → 10 by 200 by 3.000 metres (33 × 656 × 9.843 ft)

{{convert|10 x 200 x 3000|m|ft|round=each}} → 10 by 200 by 3.000 metres (33 × 660 × 9.800 ft)

Round to a multiple of a given fraction: 2 ³⁄₁₆ inch

Specify the desired denominator using |frac=<some positive integer>. (Denominator is the below-the-slash number, for example the 3 in ¹⁄₃).

{{convert|5.56|cm|in|frac=16}} → 556 centimetres (218 ⁷⁄₈ in)

{{convert|8|cm|in|frac=4}} → 8 centimetres (3 ¹⁄₄ in)

The fraction is reduced when possible:

{{convert|8|cm|in|frac=100}} → 8 centimetres (3 ³⁄₂₀ in)

{{convert|8|cm|in}} → 8 centimetres (3,150 in) (To compare)

Rounding the temperatures °C, °F and K

In temperatures, 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.

{{convert|10|C|F K}} → 10 °C (50 °F; 283 K)

Note

For a temperature difference, like to convert "A rise of 10 °C", use |C-change=10 &tc.

{{convert|10|C-change|F-change K-change}} → A rise of 10 °C (18 °F; 10 K)

Into multiple units: 10 °C (50 °F; 283 K)

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)

See also

For multiple-unit options like 1 ft 5 in, see #In input and #In output.

Ranges of values

A range: 6 to 17 kg (13 to 37 lb)

Range indicators are entered as the second parameter (between the values). Range separators can be:
Fyrimynd:Convert/doc/range separator list

Multiple dimensions: 6 m × 12 m (20 ft × 39 ft)

Use "by"

{{convert|6|by|12|ft|m}} → 6 by 12 feet (1,8 by 3,7 m)

Use "×" or ""x""

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

In science, the formal way is to set |x| and |abbr=on (keeping dimensions right, like in area = x km²):

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

About feet, inch in ranges and multiples

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

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

Words

Spelling of unit name: UK metre or US meter?

Default spelling of units is en-UK. To show en-US spelling, use |sp=us:

{{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

To write a number in words, use |spell=in:

{{convert|10|mi|m|spell=in}} → tíggju miles (16.000 m)

To spell out both in and out values, use |spell=on:

{{convert|10|mi|m|spell=on}} → tíggju miles (sekstan túsund metres)

To make first letter a capital, use |spell=In, |spell=On

{{convert|10|mi|m|spell=In}} → Tíggju miles (16.000 m)

{{convert|10|mi|m|spell=On}} → Tíggju miles (sekstan túsund metres)

Remember that the spelling of the units (ft, m) is independently set by |abbr=. To the extreme:

{{convert|10|mi|m|spell=on|abbr=off|sp=us}} → tíggju miles (sekstan túsund meters)

Extra words: 4 planted acres

Incomplete section

{{convert|4|acre||adj=pre|planted}} → 4 planted acres (1,6 ha)

Extra adjective words: A 10-foot-long corridor

{{convert|4|ft|m|adj=mid|-long}} → 10-foot-long (3,0 m)

Plurals: 1 inch, 2 inches

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 spelled |foot| forces singular output "foot", whatever the number is.

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

Changes to grammatical structure: The 18-, 24- and 32-pounder (8, 11 and 15 kg) cannons

This example is from the article Fort McHenry:

The American defenders had 18-, 24- and 32-pounder (8, 11 and 15 kg) cannons.

You can't get this sentence structure (and some others you might want to use) as a direct result of using {{convert}} and its options. However, you can get the correctly converted numbers and the grammatical structure you want to use by using {{convert}} plus three stages of editing, previewing and saving versions of the text you wish to change.

Stage 1: Enter the input numbers and units in {{convert}} as usual (this stage is just to get the calculated output):

• had {{convert|18 |, |24 |, |32 |lb |kg |0 }} cannons

Get the converted data below by clicking Show Preview (or Save Page):

→ had 18, 24, 32 pounds (8, 11, 15 kg) cannons

Stage 2: Change the resulting text from a {{convert|...}} template result to plain code by adding subst: to the template name (short for "substitution") :

• had {{subst:convert|18 |, |24 |, |32 |lb |kg |0 }} cannons

Double-check this by clicking Show Preview. The preview will show the converted numbers are still correct:

→ had 18, 24, 32 pounds (8, 11, 15 kg) cannons

Then click Save Page.

Stage 3: Click Edit at the top of the article again, and then go to the text in the editing window. You'll see that the text is there in plain code. The template {{convert|...}} itself will have disappeared. You can change the text as needed. The substituted text and plain code in the editing window in this example would be:

had 18, 24, 32 pounds (8, 11, 15 kg) cannons

You can edit this text as usual to add the grammatical features you wish. In this example, editing the above text to:

• had 18-,_24-_and_32-pounder (8, 11_and_15 kg) cannons

And then saving your edit will show the following result in the article text:

→ "had 18-, 24- and 32-pounder (8, 11 and 15 kg) cannons"

Numbers

Using an SI prefix: gigameter (Gm), or micrometer (μm)

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

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

• 12 Gm (1,2×10¹⁰ m)
• 12 µm (1,2×10⁻⁵ m)

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

• {{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)

Further information: Help:Convert units § SI prefixes

Engineering notation: 7 × 10⁶ m

In the unit: e6m

Engineering number notations like 7E6 (for 7 × 10⁶) can be entered as a "prefix" to the unit:

{{convert|7|e6m}} → 7 million metres (23.000.000 ft)

The same is possible for the output unit:

{{convert|23,000,000|ft|e6m}} →

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⁻¹⁴

In scientific notation, a number is written like 1,23×10⁻¹⁴.

With {{convert}}, 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}} → 123×10⁻¹⁵ atm (1,23×10⁻¹³ atm)
• {{convert|0.00000005|atm|atm|abbr=on}} → 000.000.005 atm (5,0 atm)

Input with fractions: 1 ¹⁄₂ inches (38,1 mm)

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

{{convert|1/2|in|mm|1}} → 1⁄2 inch (12,7 mm)

{{convert|1⁄2|in|mm|1}} → 1⁄2 inch (12,7 mm)

With integers, use a + sign

{{convert|2+1⁄2|in|mm|1}} → 2 1⁄2 inches (63,5 mm)

When negative, use a hyphen - and repeat it:

{{convert|-2-1⁄2|in|mm|1}} → −2 1⁄2 inches (−63,5 mm)

{{convert|2-1⁄2|in|mm|1}} → 2–1⁄2 inch (50,8–12,7 mm) Note: this is read as a range

{{convert|-2+1⁄2|in|mm|1}} → N Should be a number, not an expression (do not require a calculation)

Output with horizontal fraction bar in: 1/2 inch

Using a double slash (//) returns a horizontal bar fraction:

• {{convert|1//2|in|mm|1}} → 1/2 inch (12,7 mm)
• {{convert|2+1//2|in|mm|1}} → 2 1/2 inches (63,5 mm)

Thousands separator: 1,000 mi and 1000 mi

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

• {{convert|1,234,567|m|ft}} →
• {{convert|1,234,567|m|ft}} →
• {{convert|1 234 567|m|ft}} → N

Set |comma=off to remove the separator:

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

Use |comma=gaps to set digit grouping by gap (<space>) in larger numbers (thousands separator):

• {{convert|1234567|m|ft}} → 1.234.567 metres (4.050.417 ft) (To compare, default)
• {{convert|1234567|m|ft|comma=gaps}} → 1234567 metres (4050417 ft)

Setting |comma=5 or |comma=gaps5 will only add the separator when the number of digits is 5 or more:

• {{convert|1234|m|ft}} → 1.234 metres (4.049 ft) (To compare, default)
• {{convert|1234|m|ft|comma=5}} → 1234 metres (4049 ft)
• {{convert|1234567|m|ft|comma=5}} → 1.234.567 metres (4.050.417 ft)
• {{convert|1234|m|ft|comma=gaps5}} → 1234 metres (4049 ft)
• {{convert|1234567|m|ft|comma=gaps5}} → 1234567 metres (4050417 ft)

Output manipulation

Brackets and separators: 10 m [33 ft]

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

{{convert|10|m|ft}} → 10 metres (33 ft)—( ) brackets are the default

{{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

Setting |disp=br will force a new line (<br>)

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

Also |disp=br() will force a new line, and keep the brackets:

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

Setting |disp=x|... allows any text as separator:

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

Flipping (reordering) the two measurements: 1.609,3 metres (1 mile)

Setting |order=flip will flip (swap) the two measurements:

{{convert|1|mi|m}} → 1 mile (1.609,3 metres) (To compare, default)

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

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)

Displaying parts of the result: 2 (1,5)

It is possible to display only parts of the conversion result:

Convert	Output	Description
{{convert|2|cuyd|m3}}	2 cubic yards (1,5 m3)	Default, to compare
{{convert|2|cuyd|m3|abbr=values}}	2 (1,5)	Input and output numbers
{{convert|2|cuyd|m3|disp=unit}}	cubic yards	Input unit
{{convert|2|cuyd|m3|disp=unit|adj=on}}	cubic-yard	Input unit, adjective (hyphenated)
{{convert|2|cuyd|cuyd|0|disp=out|abbr=off}}	2 cubic yards	Input (workaround)
{{convert|2|cuyd|m3|abbr=~}}	2 cubic yards [cu yd] (1,5 m3)	Input: both name and symbol
{{convert|2|cuyd|m3|disp=unit2}}	m3	Output unit (symbol)
{{convert|2|cuyd|m3|disp=unit2|abbr=off}}	cubic metres	Output unit (name)
{{convert|2|cuyd|m3|disp=number}}	1,5	Output value
{{convert|2|cuyd|m3|disp=out}}	1,5 m3	Output value and unit
{{convert|2|cuyd|m3|disp=out|abbr=off}}	1,5 cubic metres	Output value and unit

Display input name and symbol: 2 kilopascals [kPa]

Setting |abbr=~ 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}} pressure → A 2-kilopascal [kPa] (0,29 psi) pressure

Table options

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

|disp=br adds a line-break and omits brackets.

|disp=br() adds a line-break and does add brackets to the converted value. This may be useful in tables:

|disp=br	|disp=br()
100 kilometres 62 miles	100 kilometres (62 miles)

Table columns showing numbers only

Using {convert} in a table cell, with |disp=table splits the result over two columns:

{{convert|10|m|ft|disp=table}} → style="text-align:right;"|10

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

|disp=tablecen 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:

	m	ft
|disp=table	10	33
|disp=tablecen	20	66
|disp=<other> (default)	30 metres (98 ft)

Sorting

Use |sortable=on 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}} → <span style="display:none">7001100000000000000</span>10 metres (33&nbsp;ft)

Use both |disp=table and |sortable=on together to produce table columns (pipe symbols) for each value in sortable columns:

	m	ft
A	15 3⁄4	52
B	155	509
C	160	520
D	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

See also: complete Convert/list of units

Units are case-sensitive: kW, not KW or kw

Multiple units: 1 ft 5 in

In input

Base document #Input multiples 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

Available multiple-unit output options predefined, like ftin and ydftin. The full list is at #Output multiples.

• {{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
• {{convert|2|m}} → 2 metres (6 ft 7 in)—the default

See also

• {{hands}} a length used to measure horses.

'per' units: kg/hl

When using a slash (/), a unit like kg/hl is recognized as kilograms per hectolitre and will be converted with other mass/volume units.

• {{convert|1000|kg/hl}} → 1.000 kilograms per hectolitre (100 lb/imp gal)

Currency per unit: $/mi, $/km

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

• {{convert|10|$/mi|$/km}} → $10 per mile ($6,2/km) Y

You can set the unit in both values using |$=€:

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

You can not convert the currency. This outcome combination is not possible: $15 per mile (€8.6/km)

Parameter list

Deprecated options

TemplateData

Hetta er TemplateData dokumentatiónin fyri hesa fyrimynd, ið verður brúkt av VisualEditor og øðrum tólum.

Convert

Converts measurements to other units.

Template parameters

Parameter		Description	Type	Status
value	1	the value to convert	Number	optional
from unit	2		Line	optional
to units	3	the unit to convert into	Line	optional
precision or suffix	4	significant digits after decimal dot or, if negative, exponent of ten	Number	optional
link units	lk	“on” all, “in” input, “out” output or “off” no units Default off	Line	optional
abbreviation	abbr	display for the units: “on” unit symbols, “off” all unit names in full words, “in” input unit symbol, “out” abbreviated output units, “values” no units at all Default out	Line	optional
spelling	sp	“us” display U.S. spelling of unit names	Line	optional
adjective	adj	adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end	Line	optional
conversion	disp	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 Default b	Line	optional
ordering	order	“flip” returns converted value first, input value second.	Line	optional
significant figures	sigfig	number that sets the number of significant figures	Number	optional
rounding output	round	“5” rounds the output number to nearest multiple of 5, “25” to nearest multiple of 25, “each” rounds each number in a range	Line	optional
thousands separator	comma	Sets or suppresses thousand separator in the numbers. “off” = no separator; “gaps”: use space not comma; “5” and “gaps5”: only add separator when number > 5 positions (10,000 or more) Default on	Line	optional
sort key	sortable	“on” generates a hidden sort key	Line	optional

See also