Template:Convert

From TALOD
Jump to navigation Jump to search
[view] [edit] [history] [purge] Documentation icon Template documentation

Template:High-risk Template:Transwiki guide Template:Lua 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 (Template:Xt, not Template:!xt and not Template:!xt). Multiple formatting and calculation options are listed below.

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

By default, the first value shows unit name, the second the symbols (= 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[edit source]

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?[edit source]

In detail, it is 100 feet (30,480 mm). In practical use, it is common to round the calculated metric number. With that, there are several possibilities.

Default rounding[edit source]

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=[edit source]

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 Template:Frac 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: use |sigfig=[edit source]

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, ...[edit source]

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 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 |frac=<some positive integer>. (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)
{{convert|8|cm|in}} → 8 centimetres (3.150 in) (To compare)

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

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)[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)

Ranges of values[edit source]

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:Convert/doc/range separator list

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 "×" 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 km2):

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

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:

  • {{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 ([convert: unknown unit])

Words[edit source]

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

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[edit source]

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

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

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

{{convert|10|mi|m|spell=on}}Lua error in Module:Convert at line 393: attempt to call upvalue 'speller' (a string value).

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

{{convert|10|mi|m|spell=In}} → 10 miles (16,000 m)
{{convert|10|mi|m|spell=On}}Lua error in Module:Convert at line 393: attempt to call upvalue 'speller' (a string value).

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}}Lua error in Module:Convert at line 393: attempt to call upvalue 'speller' (a string value).

Extra words: 4 planted acres[edit source]

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

Extra adjective words: A 10-foot-long corridor[edit source]

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

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

Grammatical construction: The 18-, 24- and 32-pounder (8, 11 and 15 kg) cannons[edit source]

This example is from article Fort McHenry: Template:Quotation This formatted result is not possible straightforward by using Template:Tlf. However, it can be made in three steps.

Step 1: Enter the input numbers and units in Template:Tlf just to get the calculated output:
  • had {{convert|18 |, |24 |, |32 |lb |kg |0 }} cannons
→ had 18, 24, 32 pounds (8, 11, 15 kg) cannons
The core conversion should look good now. You can save this (or preview).
Step 2: We need the resulting text in plain code in the page, not as a Template:Tlf template.
For this, add subst: to the template name (for 'substitute') :
As a check: the preview result should show the conversion correct, with the numbers still right.
Now save this.
→ had 18, 24, 32 pounds (8, 11, 15 kg) cannons
Step 3: When opening the edit screen again, you'll see that the text is there in code. The template Template:Tlf itself has disappeared. You can change the text as needed. The edit screen text is:
had 18,&nbsp;24,&nbsp;32 pounds (8,&nbsp;11,&nbsp;15&nbsp;kg) cannons
You can edit this text to add the grammar:
After saving your edit, it shows:
→ "had 18-, 24- and 32-pounder (8, 11 and 15 kg) cannons".

Numbers[edit source]

Using an SI prefix: gigameter (Gm), or micrometer (μ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: gigameter. These are plain multiplication factors.

To illustrate, these are trivial calculations (from meter to meter), 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 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)
Template:Further

Engineering notation: 7 × 106 m[edit source]

Engineering number notations like 7Template:Smallcaps6 (for 7 × 106) are to be entered as a "prefix" en (lowercase "e") 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}} → 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:Rnd/e−. At the moment, there is incomplete support for this in Template:Tlf. As input, the number is recognized but not re-formatted. In output, very large and very small numbers are presented in scientific notation:

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

Workaround:

  • {{convert|0.3|nPa|atm|abbr=on|order=flip|sigfig=1}} → 3×10−15 atm (0.3 nPa)
See also: {{rnd}} for this notation.

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 integers, use a + sign

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

When negative, use a hyphen - and repeat it:

{{convert|-2-1⁄2|in|mm|1}}−2 12 inches (−63.5 mm)
{{convert|2-1⁄2|in|mm|1}} → 2–12 inch (50.8–12.7 mm) Note: this is read as a range
{{convert|-2+1⁄2|in|mm|1}}[convert: invalid number] Template:Nay Should be a number, not an expression (do not require a calculation)

Output with horizontal fraction bar in: Template:Sfrac inch[edit source]

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[edit source]

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}} → 1,234,567 metres (4,050,417 ft)
  • {{convert|1,234,567|m|ft}} → 1,234,567 metres (4,050,417 ft)
  • {{convert|1 234 567|m|ft}}[convert: invalid number] Template:Nay

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[edit source]

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

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

Setting |disp=x|... 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 |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)[edit source]

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][edit source]

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}} pressureA 2-kilopascal [kPa] (0.29 psi) pressure

Table options[edit source]

For the wikitable structure, there are two options: split over columns and make the table sortable.

Table columns showing numbers only[edit source]

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[edit source]

Use both |disp=table |sortable=on to produce table columns (pipe symbols), with sortable table column. As of January 2013, only the first (lefthand) column will sort (improvements pending).
{{convert|10|m|ft|disp=table|sortable=on}} →

style="text-align:right;" data-sort-value="7001100000000000000"|10 |style="text-align:right;" data-sort-value="7001100000000000000"|33

This shows the hidden numerical sortkey:

align="right"|<span style="display:none">7001100000000000000</span>10 |align="right"|33

m ft
15 34 52
15.5 51
16.0 52.5
16 52

Units[edit source]

Template:Selfref

Parameter list[edit source]

Template:Convert/doc/parameter list

Deprecated options[edit source]

Template:Convert/doc/deprecations list

TemplateData[edit source]

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Convert

Converts measurements to other units.

Template parameters

ParameterDescriptionTypeStatus
value1

the value to convert

Numberoptional
from unit2

Lineoptional
to units3

the unit to convert into

Lineoptional
precision or suffix4

significant digits after decimal dot or, if negative, exponent of ten

Numberoptional
link unitslk

“on” all, “in” input, “out” output or “off” no units

Default
off
Lineoptional
abbreviationabbr

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
Lineoptional
spellingsp

“us” display U.S. spelling of unit names

Lineoptional
adjectiveadj

adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end

Lineoptional
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

Default
b
Lineoptional
orderingorder

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

Lineoptional
significant figuressigfig

number that sets the number of significant figures

Numberoptional
rounding outputround

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

Lineoptional
thousands separatorcomma

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
Lineoptional
sort keysortable

“on” generates a hidden sort key

Lineoptional

See also[edit source]

Template:Navbox convert