Template:Convert/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
meta>DePiep
Ookami (talk | contribs)
m 599 revisions imported
 
(355 intermediate revisions by 73 users not shown)
Line 1: Line 1:
{{documentation subpage}}<!-- for stats: 673940 tc's on 2014-09-05 -->
{{documentation subpage}}<!--
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk|680.000}}}}
Template convert transclusions
{{Transwiki guide|text=See [[Template:Convert/Transwiki guide|'''how to copy this template''']] for information on copying this template and modifying it for use on another wiki.}}
Statistics on total tc's:
2014-09-05 673940
2014-12-16 693141
2015-01-28 700000
2015-08-31 736989
2016-05-25 789091
2016-11-17 832994
2017-07-29 872000
2017-12-15 902231
2018-12-27 957770
2019-01-12 960769
2019-10-26 995152
2019-01-01 by TDmonthly error report: Page [article] count: 651064; Transclusion count: 2878293
-->
{{hatnote|For currency conversion into US dollars, see [[Template:To USD]]}}
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk| {{formatnum:995000}}+ }}}}
{{Transwiki guide |small=yes |text=See [[Template:Convert/Transwiki guide|'''this information''']] on copying this template and modifying it for use on another wiki.}}
{{Lua|Module:Convert}}
{{Lua|Module:Convert}}
'''Template {{tl|convert}}''' ''calculates'' measurements from one unit (you can enter) to another one, and then ''presents the results''. For example:
'''Template {{tl|convert}}''' ''calculates'' from one measurement unit to another one, and then ''presents'' the results formatted. The complete list of unit symbols recognized by the template is at [[Module:Convert/documentation/conversion data]].
:<code><nowiki>{{convert|2|km|mi}}</nowiki></code> &rarr; {{convert|2|km|mi}}
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> &rarr; {{convert|7|mi|km}}<br />


Multiple formatting and calculation options are listed below.
For example:
{{hatnote|See also [[Help:Convert]] for more complete information}}
:<code><nowiki>{{convert|2|km|mi}}</nowiki></code> → {{convert|2|km|mi}} <small>(km entered, so converted into mile)</small>
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> → {{convert|7|mi|km}} <small>(mi entered, so converted into km)</small>
 
''Numbers'' can be rounded, ''units'' can be abbreviated into symbols:
:<code><nowiki>{{convert|2|km|mi|2|abbr=on}}</nowiki></code> → {{convert|2|km|mi|2|abbr=on}}
:<code><nowiki>{{convert|7|mi|km|2|abbr=on}}</nowiki></code> → {{convert|7|mi|km|2|abbr=on}}
Value ''ranges'' can be entered using <code>|to|...</code> or <code>|-|...</code>:
:<code><nowiki>{{convert|2|to|5|km|mi}}</nowiki></code> → {{convert|2|to|5|km|mi}}
:<code><nowiki>{{convert|2|-|5|km|mi}}</nowiki></code>  → {{convert|2|-|5|km|mi}}
 
Combined effect example:
:<code><nowiki>{{convert|2|-|5|km|mi|2|abbr=on}}</nowiki></code> → {{convert|2|-|5|km|mi|2|abbr=on}}
:<code><nowiki>{{convert|2|and|5|km|mi|sigfig=3|abbr=off}}</nowiki></code> → {{convert|2|and|5|km|mi|sigfig=3|abbr=off}}
 
{{hatnote|See [[Help:Convert]] for more detailed, technical information}}
 
==Units to convert==
{{hatnote|See also: the summary at [[Template:Convert/list of units|Complete list of units for {{tlf|Convert}}]] and the complete list at [[ Module:Convert/documentation/conversion data]]}}
Enter units to convert ''from''&nbsp;''into'':
* <code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}
:[[International System of Units|SI]] units generally accept prefixes, like "m" for milli (10<sup>−3</sup>), and "M" for mega (10<sup>6</sup>)
:For "per" units, use "/" (slash): kg/ha
:For three-unit units, etc., see {{cl|Convert-like templates}}


==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
The "abbreviation" is actually the "symbol".
By default, the first quantity shows the unit name, the second shows the symbol (or abbreviation):
{{para|abbr|on}} will produce the symbol of the unit, instead of its name:
* <code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}
:<code><nowiki>{{convert|1|lb|kg}}</nowiki></code> &rarr; {{convert|1|lb|kg}} <small>(To compare, default)</small>
 
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> &rarr; {{convert|1|lb|kg|abbr=on}}
Using {{para|abbr|in}} is the ''reverse behaviour'' to the default:
*<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{convert|1|lb|kg|abbr=in}}
 
To abbreviate both or neither:
* <code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{convert|1|lb|kg|abbr=on}}
* <code><nowiki>{{convert|1|lb|kg|abbr=off}}</nowiki></code> → {{convert|1|lb|kg|abbr=off}}
 
===Convenience: {{tlf|cvt}} has {{para|abbr|on}} by default===
Template {{tl|cvt}} is the same as {{tlf|convert}}, except that it has {{para|abbr|on}} as the default behaviour. In {{tlf|cvt}}, all other options are available. So:
:<code><nowiki>{{cvt|1|lb|kg}}</nowiki></code> → {{cvt|1|lb|kg}}
is equivalent to:
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> {{cvt|1|lb|kg|abbr=on}}


==Adjective: ''a 10-mile distance''==
==Adjective: ''a 10-mile distance''==
Use {{para|adj|on}} to produce the adjective form. The difference:
Use {{para|adj|on}} to produce the adjectival (hyphenated) form:
:<code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> &rarr; {{convert|10|mi|km}} to go. -- to compare
* <code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> → A {{convert|10|mi|km|adj=on}} distance.
:<code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> &rarr; A {{convert|10|mi|km|adj=on}} distance. -- Adjective
Default behaviour, for comparison:
* <code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> {{convert|10|mi|km}} to go.


==Rounding: ''100 ft'' is ''30&nbsp;m'' or ''30.5&nbsp;m'' or ''30.48&nbsp;m''?==
{{para|adj|on}} does not produce hyphens with unit symbols, as per [[MOS:UNITSYMBOLS|Manual of Style]]:
In detail, it is {{convert|100|ft|mm|sigfig=5|disp==}}. In practical use, it is common to round the calculated metric number. With that, there are several possibilities.
* <code><nowiki>A {{convert|9|in|cm|adj=on|abbr=on}} nail</nowiki></code> → A {{convert|9|in|cm|adj=on|abbr=on}} nail.
 
=={{anchor|Rounding}}Rounding: ''100 ft'' is ''30&nbsp;m'' or ''30.5&nbsp;m'' or ''30.48&nbsp;m''?==
{{hatnote|See {{section link|Help:Convert#Rounding}} for a more mathematical description of the rounding options}}
By definition, 100&nbsp;ft equals {{convert|100|ft|m|sigfig=4|disp=out}}. In practical use, it is common to round the calculated metric number. With that, there are several possibilities.


===Default rounding===
===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 [[#Rounding temperatures|below]]).
By {{tlf|Convert}} 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 [[#Rounding temperatures|below]]).


{| class="wikitable"
{| class="wikitable"
Line 33: Line 85:
|'''Input'''||'''Displays as'''||'''Note'''
|'''Input'''||'''Displays as'''||'''Note'''
|-
|-
|<nowiki>{{convert|123|ft|m|-1}}</nowiki>||{{convert|123|ft|m|-1}} ||
|<code><nowiki>{{convert|123|ft|m|-1}}</nowiki></code> || {{convert|123|ft|m|-1}} ||
|-
|-
|<nowiki>{{convert|123|ft|m|0}}</nowiki>||{{convert|123|ft|m|0}} ||
|<code><nowiki>{{convert|123|ft|m}}</nowiki></code> || {{convert|123|ft|m}} || same output as with 0 (below)
|-
|-
|<nowiki>{{convert|123|ft|m|1}}</nowiki>||{{convert|123|ft|m|1}} ||
|<code><nowiki>{{convert|123|ft|m|0}}</nowiki></code> || {{convert|123|ft|m|0}} ||
|-
|-
|<nowiki>{{convert|550|ft|m|0}}</nowiki>||{{convert|550|ft|m|0}} || Approximate value is 167.64 m
|<code><nowiki>{{convert|123|ft|m|1}}</nowiki></code> || {{convert|123|ft|m|1}} ||
|-
|-
|<nowiki>{{convert|550|ft|m}}</nowiki>||{{convert|550|ft|m}} || Rounds to 170, when approximate value is 167.64 m
|<code><nowiki>{{convert|123|ft|m|2}}</nowiki></code> || {{convert|123|ft|m|2}} ||The more-exact value is 37.4904 m or so, which gets converted to 37 m if this parameter is not specified at all.
|-
|-
|<nowiki>{{convert|500|ft|m|0}}</nowiki>||{{convert|500|ft|m|0}} || Approximate value is 152.4 m
|<code><nowiki>{{convert|500|ft|m|-1}}</nowiki></code> || {{convert|500|ft|m|-1}} ||
|-
|-
|<nowiki>{{convert|500|ft|m}}</nowiki>||{{convert|500|ft|m}} || Rounds to 150, when approximate value is 152.4 m
|<code><nowiki>{{convert|500|ft|m}}</nowiki></code> || {{convert|500|ft|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)
|-
|<code><nowiki>{{convert|500|ft|m|0}}</nowiki></code> || {{convert|500|ft|m|0}} ||
|-
|<code><nowiki>{{convert|500|ft|m|1}}</nowiki></code> || {{convert|500|ft|m|1}} ||
|-
|<code><nowiki>{{convert|500|ft|m|2}}</nowiki></code> || {{convert|500|ft|m|2}} || exact value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|cm|-3}}</nowiki></code> || {{convert|500|ft|cm|-3}} ||
|-
|<code><nowiki>{{convert|500|ft|cm}}</nowiki></code> || {{convert|500|ft|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)
|-
|<code><nowiki>{{convert|500|ft|cm|0}}</nowiki></code> || {{convert|500|ft|cm|0}} ||
|}<!--NOTE: rows require "nowiki", using &#123;{ disappears. -->
|}<!--NOTE: rows require "nowiki", using &#123;{ disappears. -->


''Convert'' supports four types of rounding:
''Convert'' supports four types of rounding:


===Round to a given precision: ''use {{para|precision|}}''===
===Round to a given precision: ''use a precision number''===
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 {{frac|10}} 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.
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 multiple of {{frac|10}} to the 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: ''use {{para|sigfig|}}''===
{{Anchor|Round to a given number of significant figures}}
===Round to a given number of significant figures: ''{{para|sigfig|}}''===
To specify the output number to be with ''n'' significant figures use {{para|sigfig|&lt;number>}}:
To specify the output number to be with ''n'' significant figures use {{para|sigfig|&lt;number>}}:
* <small>To compare:</small> <nowiki>{{convert|1200|ft|m}}</nowiki> &rarr; {{convert|1200|ft|m}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki></code> → {{convert|1200|ft|m|sigfig=4}}
* <nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki> &rarr; {{convert|1200|ft|m|sigfig=4}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=3}}</nowiki></code> → {{convert|1200|ft|m|sigfig=3}}
* <nowiki>{{convert|1200|ft|m|sigfig=3}}</nowiki> &rarr; {{convert|1200|ft|m|sigfig=3}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=2}}</nowiki></code> → {{convert|1200|ft|m|sigfig=2}}
* <nowiki>{{convert|1200|ft|m|sigfig=2}}</nowiki> &rarr; {{convert|1200|ft|m|sigfig=2}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki></code> → {{convert|1200|ft|m|sigfig=1}}
* <nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki> &rarr; {{convert|1200|ft|m|sigfig=1}}
Default behaviour, for comparison:
Setting {{para|sigfig|&lt;=0}} is meaningless
* <code><nowiki>{{convert|1200|ft|m}}</nowiki></code> → {{convert|1200|ft|m}}
* <nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki> &rarr; {{convert|1200|ft|m|sigfig=0}}
Setting {{para|sigfig}} to a value less than 1 is meaningless:
* <code><nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki></code> → {{convert|1200|ft|m|sigfig=0}} {{nay}}


===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
Using {{para|round|5}} rounds the outcome to a multiple of 5.
Using {{para|round|5}} rounds the outcome to a multiple of 5.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> &rarr; {{convert|10|m|ft}}
* <code><nowiki>{{convert|10|m|ft}}</nowiki></code> {{convert|10|m|ft}}
:<code><nowiki>{{convert|10|m|ft|round=5}}</nowiki></code> &rarr; {{convert|10|m|ft|round=5}}
* <code><nowiki>{{convert|10|m|ft|round=5}}</nowiki></code> {{convert|10|m|ft|round=5}}


Similar: using {{para|round|25}} rounds the outcome to a multiple of 25.
Similar: using {{para|round|25}} rounds the outcome to a multiple of 25.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> &rarr; {{convert|10|m|ft}}
* <code><nowiki>{{convert|10|m|ft}}</nowiki></code> {{convert|10|m|ft}}
:<code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> &rarr; {{convert|10|m|ft|round=25}}
* <code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> {{convert|10|m|ft|round=25}}
:<small>To compare:</small> <code><nowiki>{{convert|10|m|ft|sigfig=4}}</nowiki></code> &rarr; {{convert|10|m|ft|sigfig=4}}
Default behaviour, for comparison:
* <code><nowiki>{{convert|10|m|ft|sigfig=4}}</nowiki></code> {{convert|10|m|ft|sigfig=4}}


In a range, one can round ''each value'' individually to the default. Use {{para|round|each}}:
In a range, one can round ''each value'' individually to the default. Use {{para|round|each}}:
:<code><nowiki>{{convert|10 x 200 x 3000|m|ft}}</nowiki></code> &rarr; {{convert|10 x 200 x 3000|m|ft}}
* <code><nowiki>{{convert|10 x 200 x 3000|m|ft}}</nowiki></code> {{convert|10 x 200 x 3000|m|ft}}
:<code><nowiki>{{convert|10 x 200 x 3000|m|ft|round=each}}</nowiki></code> &rarr; {{convert|10 x 200 x 3000|m|ft|round=each}}
* <code><nowiki>{{convert|10 x 200 x 3000|m|ft|round=each}}</nowiki></code> {{convert|10 x 200 x 3000|m|ft|round=each}}


===Round to a multiple of a given fraction: ''{{frac|2|1|4}} inch''===
===<span id="Round to a multiple of a given fraction"></span>Round to a multiple of a given fraction: ''{{frac|2|3|16}} inch''===
Specify the desired ''denominator'' using {{para|frac|&lt;some positive integer&gt;}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|3}}).
Specify the desired ''denominator'' using {{para|frac|&lt;some positive integer&gt;}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|3}}).
:<code><nowiki>{{convert|6|cm|in|frac=2}}</nowiki></code> &rarr; {{convert|6|cm|in|frac=2}}
* <code><nowiki>{{convert|5.56|cm|in|frac=16}}</nowiki></code> {{convert|5.56|cm|in|frac=16}}
:<code><nowiki>{{convert|6|cm|in|frac=4}}</nowiki></code> &rarr; {{convert|6|cm|in|frac=4}}
* <code><nowiki>{{convert|8|cm|in|frac=4}}</nowiki></code> {{convert|8|cm|in|frac=4}}
:<code><nowiki>{{convert|6|cm|in|frac=100}}</nowiki></code> &rarr; {{convert|6|cm|in|frac=100}}
The fraction is reduced when possible:
:<small>To compare:</small> <code><nowiki>{{convert|6|cm|in}}</nowiki></code> &rarr; {{convert|6|cm|in|sigfig=4}}
* <code><nowiki>{{convert|8|cm|in|frac=100}}</nowiki></code> {{convert|8|cm|in|frac=100}}
Default behaviour uses decimal notation:
* <code><nowiki>{{convert|5.56|cm|in}}</nowiki></code> {{convert|5.56|cm|in}}
 
==={{anchor|Rounding temperatures}}Rounding temperatures: ''°C'', ''°F'' and ''K''===
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.
 
#{{#invoke:DemoTemplate|convert|10,000|C|F K}}
#{{#invoke:DemoTemplate|convert|10,000.1|C|F K}}
#{{#invoke:DemoTemplate|convert|-272|C|F K}}
#{{#invoke:DemoTemplate|convert|-272|C}}
#{{#invoke:DemoTemplate|convert|100|C|F K}}
#{{#invoke:DemoTemplate|convert|0|C|F 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 {{convert|0.1|C-change|F-change|disp=x| is a |abbr=off}}, 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 {{para|sigfig}}:
:{{#invoke:DemoTemplate|convert|10000|C|sigfig=5}}
or you set the precision ''positionally'', relative to the decimal point (zero being ''at'' the decimal point):
:{{#invoke:DemoTemplate|convert|10000|C|0}}


==={{anchor|Rounding temperatures}}Rounding temperatures &deg;C, &deg;F and K===
The precision of the input number in example (2) is six, so the precision of the Fahrenheit output is, 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 two 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.
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.
:<code><nowiki>{{convert|10|C|F K}}</nowiki></code> &rarr; {{convert|10|C|F K}}
''Note''
:For a temperature ''difference'', like to convert "A rise of 20 &deg;C", use {{para|C-change|20}} &tc.
:<code><nowiki>{{convert|20|C-change|F-change K-change}}</nowiki></code> &rarr; A rise of {{convert|20|C-change|F-change K-change}}


:<small>To compare: "A temperature of 20 &deg;C" would yield: A temperature of {{convert|20|C|F K}}</small>
===Rounding input===
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 {{tlc|&#35;expr:}} 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:
* {{para|adj|ri0}}
* {{para|adj|ri1}}
* {{para|adj|ri2}}
* {{para|adj|ri3}}
Note that there is no {{para|adj|ri-1}}{{nay}} or similar for rounding above the decimal place.  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:
* {{tlc|convert|4.14159|mi|km|adj{{=}}ri0}} → {{convert|4.14159|mi|km|adj=ri0}} {{nay}} (precisions are mismatched)
* {{tlc|convert|4.14159|mi|km|0|adj{{=}}ri0}} → {{convert|4.14159|mi|km|0|adj=ri0}} {{aye}}
 
In this case, if the input were rounded before conversion, a different result would be obtained:
* {{tlc|convert|<nowiki>{{#expr:4.14159 round 0}}</nowiki>|mi|km|0}} → {{convert|{{#expr:4.14159 round 0}}|mi|km|0}} {{nay}} (double rounding)


==Into multiple units: ''{{convert|10|C|F K}}''==
==Into multiple units: ''{{convert|10|C|F K}}''==
Separate the multiple output units by a space:
Separate the multiple output units by a space:
:<code><nowiki>{{convert|10|C|F K}}</nowiki></code> &rarr; {{convert|10|C|F K}}
* <code><nowiki>{{convert|10|C|F K}}</nowiki></code> {{convert|10|C|F K}}
:<code><nowiki>{{convert|5|km|mi nmi}}</nowiki></code> &rarr; {{convert|5|km|mi nmi}}
* <code><nowiki>{{convert|5|km|mi nmi}}</nowiki></code> {{convert|5|km|mi nmi}}
If the output unit names contain spaces, use <code>+</code> as the separator.
 
See also:
* For multiple-unit options like ''1 ft 5 in'', see {{section link||In input}} and {{section link||In output}}.
 
==Ranges of values==
{{For|a conversion of a difference|#Units of difference}}
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)''===
Range indicators are entered as the second parameter (between the values). Range separators can be:<br/>
{{Convert/doc/range separator list}}
 
===Multiple dimensions: ''{{convert|6|x|12|m|ft|abbr=on}}''===
Use <code>by</code>:
* <code><nowiki>{{convert|6|by|12|ft|m}}</nowiki></code> → {{convert|6|by|12|ft|m}}
 
Use <code>×</code>, multiplication sign, or <code>x</code>, letter:
* <code><nowiki>{{convert|6|x|12|m|ft}}</nowiki></code> → {{convert|6|x|12|m|ft}}


==Multiple measurements==
In science, the formal way is to set <code>&#x7c;x&#x7c;</code> and {{para|abbr|on}} (keeping dimensions right, like in ''area = x km<sup>2</sup>''):
===Range of values: ''6 to 17 kg (13 to 37 lb)''===
* <code><nowiki>{{convert|6|x|12|m|ft|abbr=on}}</nowiki></code> {{convert|6|x|12|m|ft|abbr=on}}
Range indicators are entered as the second parameter (between the values). Range separators can be:<br />
:<code>to</code>, <code>to(-)</code>, <code>-</code> (ndash or hyphen), <code>or</code>, <code>and</code>, <code>±</code>, <code>+/-</code>:
:<code><nowiki>{{convert|6|to|17|kg|lb|abbr=on}}</nowiki></code> &rarr; {{convert|6|to|17|kg|lb|abbr=on}}
:<code><nowiki>{{convert|-10|to|-20|C}}</nowiki></code> &rarr; {{convert|-10|to|-20|C}}
:<code><nowiki>{{convert|6|to(-)|17|kg|lb}}</nowiki></code> &rarr; {{convert|6|to(-)|17|kg|lb}}
:<code><nowiki>{{convert|6|and|17|kg|lb}}</nowiki></code> &rarr; {{convert|6|and|17|kg|lb}}
:<code><nowiki>{{convert|60|±|10|m|ft}}</nowiki></code> &rarr; {{convert|60|±|10|m|ft}}
:<code><nowiki>{{convert|60|+/-|10|m|ft}}</nowiki></code> &rarr; {{convert|60|+/-|10|m|ft}}


===Multiple dimensions: ''6 by 12 feet (1.8 by 3.7 m)''===
===Lists of values: ''20, 40, or 60 miles''===
:<code><nowiki>{{convert|6|by|12|ft|m}}</nowiki></code> &rarr; {{convert|6|by|12|ft|m}}
:<code><nowiki>{{convert|20|,|40|, or|60|mi}}</nowiki></code> &rarr; {{convert|20|,|40|, or|60|mi}}
:<code><nowiki>{{convert|6|x|12|m|ft}}</nowiki></code> &rarr; {{convert|6|x|12|m|ft}}


===About ''feet, inch'' in ranges and multiples===
===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:
While it is possible to enter feet, inch in a simple conversion, this is not possible for ranges:
* <code><nowiki>{{convert|1|ft|3|in|mm}}</nowiki></code> &rarr; {{convert|1|ft|3|in|mm}} <small>(to compare)</small>
* <code><nowiki>{{convert|1|ft|3|in|x|3|ft|5|in|mm}}</nowiki></code> {{convert|1|ft|3|in|x|3|ft|5|in|mm}} {{nay}}
* <code><nowiki>{{convert|1|ft|3|in|x|3|ft|5|in|mm}}</nowiki></code> &rarr; {{convert|1|ft|3|in|x|3|ft|5|in|mm}}
Default behaviour, for comparison:
* <code><nowiki>{{convert|1|ft|3|in|mm}}</nowiki></code> {{convert|1|ft|3|in|mm}}
However, converting metric units into feet and inches with {{para|order|flip}} can produce the desired output:
* <code><nowiki>{{convert|380|x|1040|mm|ftin|order=flip}}</nowiki></code> → {{convert|380|x|1040|mm|ftin|order=flip}}


==Words==
==Words==
===Spell out numbers: ''ten miles''===
===Spelling of unit name: international ''metre'' or US ''meter''?===
Default spelling of units is in the en (generic) locale. To show en-US spelling, use {{para|sp|us}}:
:<code><nowiki>{{convert|1|m|ft}}</nowiki></code> → {{convert|1|m|ft}}—''default''
:<code><nowiki>{{convert|1|m|ft|sp=us}}</nowiki></code> → {{convert|1|m|ft|sp=us}}
 
===<span id="spell"></span>Spell out numbers: ''ten miles''===
To write a number in words, use {{para|spell|in}}:
To write a number in words, use {{para|spell|in}}:
:<code><nowiki>{{convert|10|mi|m|spell=in}}</nowiki></code> &rarr; {{convert|10|mi|m|spell=in}}
* <code><nowiki>{{convert|10|mi|m|spell=in}}</nowiki></code> {{convert|10|mi|m|spell=in}}


To spell out both in and out values, use {{para|spell|on}}:
To spell out both in and out values, use {{para|spell|on}}:
:<code><nowiki>{{convert|10|mi|m|spell=on}}</nowiki></code> &rarr; {{convert|10|mi|m|spell=on}}
* <code><nowiki>{{convert|10|mi|m|spell=on}}</nowiki></code> {{convert|10|mi|m|spell=on}}


To make first letter a capital, use {{para|spell|In}}, {{para|spell|On}}
To make first letter a capital, use {{para|spell|In}}, {{para|spell|On}}
:<code><nowiki>{{convert|10|mi|m|spell=In}}</nowiki></code> &rarr; {{convert|10|mi|m|spell=In}}
* <code><nowiki>{{convert|10|mi|m|spell=In}}</nowiki></code> {{convert|10|mi|m|spell=In}}
:<code><nowiki>{{convert|10|mi|m|spell=On}}</nowiki></code> &rarr; {{convert|10|mi|m|spell=On}}
* <code><nowiki>{{convert|10|mi|m|spell=On}}</nowiki></code> {{convert|10|mi|m|spell=On}}


Remember that the spelling of the units (ft, m) is independently set by {{para|abbr|}}. To the extreme:
Remember that the spelling of the units (ft, m) is independently set by {{para|abbr|}}. To the extreme:
:<code><nowiki>{{convert|10|mi|m|spell=on|abbr=off|sp=us}}</nowiki></code> &rarr; {{convert|10|mi|m|spell=on|abbr=off|sp=us}}
* <code><nowiki>{{convert|10|mi|m|spell=on|abbr=off|sp=us}}</nowiki></code> {{convert|10|mi|m|spell=on|abbr=off|sp=us}}


===Spelling of units: UK ''metre'' or US ''meter''?===
===Inserted before units: ''4 planted acres''===
Default spelling of units is en-UK. To show en-US spelling, use {{para|sp|us}}:
*<code><nowiki>{{convert|4|acre||adj=pre|planted}}</nowiki></code> → {{convert|4|acre||adj=pre|planted}}
:<code><nowiki>{{convert|1|m|ft}}</nowiki></code> &rarr; {{convert|1|m|ft}} -- ''default''
<code>disp=preunit</code> is similar, but has no separator after the specified text, and can have different text for the output value:
:<code><nowiki>{{convert|1|m|ft|sp=us}}</nowiki></code> &rarr; {{convert|1|m|ft|sp=us}}
*<code><nowiki>{{convert|4|acre||disp=preunit|planted }}</nowiki></code> {{convert|4|acre||disp=preunit|planted }}
*<code><nowiki>{{convert|4|acre||disp=preunit|planted |reforested-}}</nowiki></code> {{convert|4|acre||disp=preunit|planted |reforested-}}


===Extra words: ''4 planted acres'' ===
===After adjective unit: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
:''Incomplete section''
Note that two units (in this case, ft and m) are required. Use with just one unit will generate an error message.
:<code><nowiki>{{convert|4|acre||adj=pre|planted}}</nowiki></code> &rarr; {{convert|4|acre||adj=pre|planted}}
:<code><nowiki>{{convert|10|ft|m|adj=mid|-long}}</nowiki></code> {{convert|10|ft|m|adj=mid|-long}}


===Extra adjective words: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
===Plurals: ''1&nbsp;inch, 2&nbsp;inches''===
:<code><nowiki>{{convert|4|ft| |adj=mid|-long}}</nowiki></code> &rarr; {{convert|10|ft| |adj=mid|-long}}
The unit symbol is singular always. Depending on the preceding number only, a unit name can be shown plural.
* <code><nowiki>{{convert|1|metre}}</nowiki></code> → {{convert|1|metre}}
* <code><nowiki>{{convert|2|metre}}</nowiki></code> → {{convert|2|metre}}
* <code><nowiki>{{convert|2|metre|abbr=on}}</nowiki></code> {{convert|2|metre|abbr=on}}


===Grammatical construction: ''The 18-, 24- and 32-pounder (8, 11 and 15 kg) cannons'' ===
;Exception:
This example is from article [[Fort McHenry#19th_Century|Fort McHenry]]:
Entering the unit spelled <code>|foot|</code> forces singular output "foot", whatever the number is.
{{quotation|The American defenders had 18-, 24- and 32-pounder (8,&nbsp;11&nbsp;and 15&nbsp;kg) cannons.}}
* <code><nowiki>{{convert|100|foot|abbr=off}}</nowiki></code> {{convert|100|foot|abbr=off}}
This formatted result is not possible straightforward by using {{tlf|convert}}. However, it can be made in three steps.
:'''Step 1:''' Enter the input numbers and units in {{tlf|convert}} just to get the calculated output:
:*<code><nowiki>had {{convert|18 |, |24 |, |32 |lb |kg |0 }} cannons</nowiki></code>
::&rarr; had {{convert|18 |, |24 |, |32 |lb |kg |0 }} 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 {{tlf|convert|...}} template.
:For this, '''add&nbsp;<code>subst:<code> to the template name''' (for 'substitute') :
:*<code><nowiki>had {{</nowiki>{{purple|'''subst:'''}}<nowiki>convert|18 |, |24 |, |32 |lb |kg |0 }} cannons</nowiki></code>
:As a check: the preview result should show the conversion correct, with the numbers still right.
:'''Now save this'''.
::&rarr; had 18,&nbsp;24,&nbsp;32 pounds (8,&nbsp;11,&nbsp;15&nbsp;kg) cannons
:'''Step 3:''' When opening the edit screen again, you'll see that the text is there in code. You can change the text as needed. The template {{tlf|convert|...}} itself has disappeared. The edit screen text is:
::<code><nowiki>had 18,&amp;nbsp;24,&amp;nbsp;32 pounds (8,&amp;nbsp;11,&amp;nbsp;15&amp;nbsp;kg) cannons</nowiki></code>
:You can edit this text to add the grammar:
:*<code>had 18{{red|-}},{{red|_}}24{{red|-_and_}}32{{red|-}}pound{{red|er}} (8,&amp;nbsp;11{{red|_and_}}15&amp;nbsp;kg) cannons </code>
:After saving your edit, it shows:
::&rarr; "had 18-, 24- and 32-pounder (8,&nbsp;11&nbsp;and 15&nbsp;kg) cannons".


== Numbers ==
===Fractions: ''one-eighth of an imperial pint''===
=== Using SI prefixes: ''gigameter (Gm), micrometer (μm)'' ===
The convert template also supports spelling out fractions.
Units can have [[metric prefix|SI prefixes]] like: <code>G, M, k, m, &mu;</code> for giga-, mega-, kilo-, milli-, micro- multiplication factors.
* <code><nowiki>{{convert|3+1/2|oz|g|spell=in}}</nowiki></code> → {{convert|3+1/2|oz|g|spell=in}}
Any additional words needed for the fraction can also be added at the end of the template.
* <code><nowiki>{{convert|1/8|imppt|ml|spell=in|adj=pre|of an}}</nowiki></code> → {{convert|1/8|imppt|ml|spell=in|adj=pre|of an}}
<!-- todo: decimals & negative examples -->


To illustrate, these are trivial calculations (from meter to meter), displaying the multiplication factor:
===Wrapping and line breaking===
:See {{section link|Help:Convert|Wrapping and line breaking}}
 
===<span id="million"></span>Spelling out "thousands", "millions", etc.===
Most unit codes accept a prefix of e3 (thousand) or e6 (million) or e9 (billion).
* <code><nowiki>{{convert|100|e6mi|e6km}}</nowiki></code> → {{convert|100|e6mi|e6km}}
* <code><nowiki>{{convert|120|e6acre}}</nowiki></code> → {{convert|120|e6acre}}
* <code><nowiki>{{convert|120|e6acre|e3km2}}</nowiki></code> → {{convert|120|e6acre|e3km2}}
 
To display both input and output in scientific notation, use {{para|abbr|on}}
* <code><nowiki>{{convert|100|e6mi|e6km|abbr=on}}</nowiki></code> → {{convert|100|e6mi|e6km|abbr=on}}
 
To spell out "thousands", "millions", etc., {{para|abbr|unit}} abbreviates the unit; {{para|abbr|off}} displays both full unit names.
* <code><nowiki>{{convert|100|e6mi|e6km|abbr=unit}}</nowiki></code> → {{convert|100|e6mi|e6km|abbr=unit}}
* <code><nowiki>{{convert|100|e6mi|e6km|abbr=off}}</nowiki></code> → {{convert|100|e6mi|e6km|abbr=off}}
 
==Numbers==
 
===Using an SI prefix: ''gigametre (Gm)'', or ''micrometre (&#x03BC;m)''===
{{Sidebar metric prefixes (small)}}
Units can have an [[metric prefix|SI prefix]] like <code>G</code> before the unit: <code>Gm</code>, and <code>giga</code> before the name: <code>gigametre</code>. These are plain multiplication factors.
 
To illustrate, these are trivial calculations (from metre to metre), showing the multiplication factor:
* {{convert|12|Gm|m|abbr=on}}
* {{convert|12|Gm|m|abbr=on}}
* {{convert|12|μm|m|abbr=on}}
* {{convert|12|μm|m|abbr=on}}


The prefix can be added before an SI unit (here: unit <code>m</code> for meter):
The prefix can be added before the SI unit (here: unit <code>m</code> for metre):
* {{convert|12|Gm|mi|abbr=on}}
* <code><nowiki>{{convert|12|Gm|mi|abbr=on}}</nowiki></code> → {{convert|12|Gm|mi|abbr=on}}
* {{convert|12|Mm|mi|abbr=on}}
* <code>Mm</code>: {{convert|12|Mm|mi|abbr=on}}
* {{convert|12|km|ft|abbr=on}}
* <code>km</code>: {{convert|12|km|ft|abbr=on}}
* {{convert|12|mm|in|abbr=on}}
* <code>mm</code>: {{convert|12|mm|in|abbr=on}}
* {{convert|12|μm|μin|abbr=on}} (as an exception, the non-SI unit inch can have the "μ" prefix too)
* <code>&#x03BC;m</code>: {{convert|12|μm|mm|abbr=on}}
* {{convert|12|um|uin|abbr=on}} (letter "u" can be used for "μ" here)
* <code>um</code>: {{convert|12|um|mm|abbr=on}} (letter "u" can be used for "&#x03BC;" here)


Also, the prefix can be used in the output unit:
The prefix can be used in the output unit:
* {{convert|1200|mi|Gm|abbr=on}}
* <code><nowiki>{{convert|12000|mi|Mm|abbr=on}}</nowiki></code> → {{convert|12000|mi|Mm|abbr=on}}
* {{convert|12|in|μm|abbr=on}}
* <code><nowiki>{{convert|12|in|μm|abbr=on}}</nowiki></code> → {{convert|12|in|μm|abbr=on}}


:{{further|Help:Convert units#SI prefixes}}
As an exception, the non-SI unit "inch" can have the "&#x03BC;" prefix too:
* <code><nowiki>{{convert|12|&#x03BC;m|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}
 
{{further|Help:Convert units#SI prefixes}}
 
===Engineering notation: ''7 × 10<sup>6</sup> m''===
 
====In the unit: ''e6m''====
[[Engineering notation]] can be entered as a "prefix" to the unit:
* <code><nowiki>{{convert|70|e6m}}</nowiki></code> → {{convert|70|e6m|abbr=on}}
 
The same is possible for the output unit:
* <code><nowiki>{{convert|23,000,000|ft|e6m}}</nowiki></code> → {{convert|23,000,000|ft|e6m}}
 
Any standard unit (not a combination, multiple, or built-in unit) can have such a prefix:
* <code>e3</code> (thousand),
* <code>e6</code> (million),
* <code>e9</code> (billion),
* <code>e12</code> (trillion),
* <code>e15</code> (quadrillion).
 
===Scientific notation: ''1.23 × 10<sup>−14</sup>''===
In [[scientific notation]], a number is written like {{round|12.3e-15|16}}. The plain number has exactly one digit before the decimal point.
 
With {{tlf|convert}}, the input can be in e-notation such as <code>12.3e4</code>. 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.
*<code><nowiki>{{convert|12.3e-15|atm|atm|abbr=on}}</nowiki></code> → {{convert|12.3e-15|atm|atm|abbr=on}}
*<code><nowiki>{{convert|0.00000005|atm|atm|abbr=on}}</nowiki></code> → {{convert|0.00000005|atm|atm|abbr=on}}


==Numbers in==
===Input with fractions: ''{{convert|1+1/2|in|mm|1}}''===
===Input with fractions: ''{{convert|1+1/2|in|mm|1}}''===
The number to convert can be written in fractions:
The number to convert can be written in fractions. Both <code>/</code> (keyboard slash) and <code>⁄</code> (fraction slash) are accepted:
:<code><nowiki>{{convert|1/2|in|mm|1}}</nowiki><code> → {{convert|1/2|in|mm|1}}
*<code><nowiki>{{convert|1/2|in|mm|1}}</nowiki></code> → {{convert|1/2|in|mm|1}}
Also the fraction slash (<code>⁄</code>) is accepted:
*<code><nowiki>{{convert|1⁄2|in|mm|1}}</nowiki></code> → {{convert|1⁄2|in|mm|1}}
:<code><nowiki>{{convert|1⁄2|in|mm|1}}</nowiki><code> → {{convert|1⁄2|in|mm|1}}
With integers, use a <code>+</code> sign
:<code><nowiki>{{convert|2+1⁄2|in|mm|1}}</nowiki><code> → {{convert|2+1⁄2|in|mm|1}}
When negative, use a hyphen <code>-</code> and repeat it:
:<code><nowiki>{{convert|-2-1⁄2|in|mm|1}}</nowiki><code> → {{convert|-2-1⁄2|in|mm|1}}
:<code><nowiki>{{convert|2-1⁄2|in|mm|1}}</nowiki><code> → {{convert|2-1⁄2|in|mm|1}} Note: this is read as a range
:<code><nowiki>{{convert|-2+1⁄2|in|mm|1}}</nowiki><code> → {{convert|-2+1⁄2|in|mm|1}} {{nay}} Should be a number, not an expression


===Input in Engineering notation: ''7 &times; 10<sup>6</sup> m''===
With positive [[mixed number]]s (a positive integer and a fraction), use a <code>+</code> sign
Common engineering notations like ''e6'' (10<sup>6</sup>) are to be entered with the unit:
*<code><nowiki>{{convert|2+1⁄2|in|mm|1}}</nowiki></code> → {{convert|2+1⁄2|in|mm|1}}
:<code><nowiki>{{convert|7|e6m}}</nowiki></code> → {{convert|7|e6m}}
See also: {{tl|val}}


==Numbers out==
With negative mixed numbers, use a hyphen <code>-</code> and repeat it:
===Output with horizontal fraction bar in: ''{{sfrac|1|2}}&nbsp;inch'' ===
*<code><nowiki>{{convert|-2-1⁄2|in|mm|1}}</nowiki></code> → {{convert|-2-1⁄2|in|mm|1}}
<!-- techinical restriction: TOC does not show the example horizontal bar intended here; rephrased section title-->
 
Using a double slash (<code>//</code>) returns a horizontal bar fraction:
Note that the following cases are not interpreted as mixed numbers:
*<code><nowiki>{{convert|2-1⁄2|in|mm|1}}</nowiki></code> → {{convert|2-1⁄2|in|mm|1}}. This is interpreted as a range from 2 inches to 1⁄2 inch.
*<code><nowiki>{{convert|-2+1⁄2|in|mm|1}}</nowiki></code> → {{convert|-2+1⁄2|in|mm|1}} {{nay}} This is neither a mixed number nor a range, and mathematical expressions requiring calculations are not allowed here.
 
===Horizontal fraction bar: ''{{sfrac|1|2}}&nbsp;inch''===
<!-- technical restriction: TOC does not show the example horizontal bar intended here; rephrased section title-->
Using a double slash (<code>//</code>) provides a horizontal fraction bar for the original (input) unit:
* <code><nowiki>{{convert|1//2|in|mm|1}}</nowiki></code> → {{convert|1//2|in|mm|1}}
* <code><nowiki>{{convert|1//2|in|mm|1}}</nowiki></code> → {{convert|1//2|in|mm|1}}
* <code><nowiki>{{convert|2+1//2|in|mm|1}}</nowiki></code> → {{convert|2+1//2|in|mm|1}}
* <code><nowiki>{{convert|6+3//8|in|mm|1}}</nowiki></code> → {{convert|6+3//8|in|mm|1}}
Using a negative value for {{para|frac}} provides a horizontal fraction bar for the converted (output) unit:
*<code><nowiki>{{convert|12.7|mm|frac=-2}}</nowiki></code> → {{convert|12.7|mm|frac=-2}}
*<code><nowiki>{{convert|161.9|mm|frac=-8}}</nowiki></code> → {{convert|161.9|mm|frac=-8}}


== Output manipulation ==
===Thousands separator: ''1,000 mi'' or ''1000 mi''===
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:
* <code><nowiki>{{convert|1234567|m|ft}}</nowiki></code> → {{convert|1234567|m|ft}}
* <code><nowiki>{{convert|1,234,567|m|ft}}</nowiki></code> → {{convert|1,234,567|m|ft}}
 
Set {{para|comma|off}} to remove the separator from the output:
* <code><nowiki>{{convert|1234567|m|ft|comma=off}}</nowiki></code> → {{convert|1234567|m|ft|comma=off}}
 
Use {{para|comma|gaps}} to use digit grouping by gap (thin space) as a thousands separator:
* <code><nowiki>{{convert|1234567|m|ft|comma=gaps}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps}}
Default behaviour, for comparison:
* <code><nowiki>{{convert|1234567|m|ft}}</nowiki></code> → {{convert|1234567|m|ft}}
 
Setting {{para|comma|5}} will only add the separator when the number of digits is 5 or more:
* <code><nowiki>{{convert|1234|m|ft|comma=5}}</nowiki></code> → {{convert|1234|m|ft|comma=5}}
* <code><nowiki>{{convert|1234567|m|ft|comma=5}}</nowiki></code> → {{convert|1234567|m|ft|comma=5}}
Default behaviour, for comparison:
* <code><nowiki>{{convert|1234|m|ft}}</nowiki></code> → {{convert|1234|m|ft}}
 
==Output manipulation==
===Brackets and separators: ''10 m [33 ft]''===
===Brackets and separators: ''10 m [33 ft]''===
Punctuation that distinguishes the two measurements is set by {{para|disp|}}.<br />
Punctuation that distinguishes the two measurements is set by {{para|disp|}}.<br/>
Options are: <code>b</code> <small>(the default)</small>, <code>sqbr</code>, <code>comma</code>, <code>or</code>, <code>br</code>, <code>x{{!}}...</code>:
Options are: <code>b</code> <small>(the default)</small>, <code>sqbr</code>, <code>comma</code>, <code>or</code>, <code>br</code>, <code>br()</code>, <code>x{{!}}</code>:
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> &rarr; {{convert|10|m|ft}} -- ''(&nbsp;) brackets are the default''
* <code><nowiki>{{convert|10|m|ft|disp=sqbr}}</nowiki></code> {{convert|10|m|ft|disp=sqbr}}
:<code><nowiki>{{convert|10|m|ft|disp=sqbr}}</nowiki></code> &rarr; {{convert|10|m|ft|disp=sqbr}}
* <code><nowiki>{{convert|10|m|ft|disp=comma}}</nowiki></code> {{convert|10|m|ft|disp=comma}}
:<code><nowiki>{{convert|10|m|ft|disp=comma}}</nowiki></code> &rarr; {{convert|10|m|ft|disp=comma}}
* <code><nowiki>{{convert|10|m|ft|disp=or}}</nowiki></code> {{convert|10|m|ft|disp=or}}
:<code><nowiki>{{convert|10|m|ft|disp=or}}</nowiki></code> &rarr; {{convert|10|m|ft|disp=or}}
Default behaviour, for comparison:
* <code><nowiki>{{convert|10|m|ft}}</nowiki></code> {{convert|10|m|ft}}


Setting {{para|disp|br}} will force a new line (<code>&lt;br></code>)
Setting {{para|disp|br}} will force a new line (<code>&lt;br/></code>)
* <code><nowiki>{{convert|10|m|ft|disp=br}}</nowiki></code> → {{convert|10|m|ft|disp=br}}


:<code><nowiki>{{convert|10|m|ft|disp=br}}</nowiki></code> &rarr; {{convert|10|m|ft|disp=br}}
Also {{para|disp|br()}} will force a new line, and keep the brackets (useful in tables):
Setting {{para|disp|x{{!}}...}} allows any text as separator:
* <code><nowiki>{{convert|10|m|ft|disp=br()}}</nowiki></code> {{convert|10|m|ft|disp=br()}}


:<code><nowiki>{{convert|10|m|ft|disp=x|_MyText_}}</nowiki></code> &rarr; {{convert|10|m|ft|disp=x|_MyText_}} -- <small>(To display spaces, use <code>&amp;nbsp;</code>)</small>
Setting {{para|disp|x{{!}}…}} allows any text as separator:
* <code><nowiki>{{convert|10|m|ft|disp=x|_MyText_}}</nowiki></code> {{convert|10|m|ft|disp=x|_MyText_}} <small>(To display spaces, use <code>&amp;nbsp;</code>)</small>
<!--todo: works for multiple freetexts too! |disp=x|TextA|TextB -->


===Flipping (reordering) the two measurements: ''{{convert|1|mi|m|order=flip|sigfig=5|abbr=off}}'' ===
===<span id="flip"></span>Flipping (reordering) the two measurements: ''{{convert|1|mi|m|order=flip|sigfig=5|abbr=off}}'' ===
Setting {{para|order|flip}} will flip (swap) the two measurements:
Setting {{para|order|flip}} will flip (swap) the two measurements:
:<code><nowiki>{{convert|1|mi|m}}</nowiki></code> &rarr; {{convert|1|mi|m|sigfig=5|abbr=off}} <small>(To compare, default)</small>
* <code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> {{convert|1|mi|m|order=flip|sigfig=5|abbr=off}}<!-- Extra settings added to enhance the illustration. Don't know if this is ideal way of documenting. DePiep, August 2014. -->
:<code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> &rarr; {{convert|1|mi|m|order=flip|sigfig=5|abbr=off}} <!-- Extra settings added to enhance the illustration. Don't know if this is ideal way of documenting. DePiep, August 2014. --></small>
Default behaviour, for comparison:
* <code><nowiki>{{convert|1|mi|m}}</nowiki></code> → {{convert|1|mi|m|sigfig=5|abbr=off}}
 
When converting to multiple units, the effect is:
* <code><nowiki>{{convert|10|km|mi nmi|order=flip}}</nowiki></code> → {{convert|10|km|mi nmi|order=flip|sigfig=5|abbr=off}}
* <code><nowiki>{{convert|10|km|nmi mi|order=flip}}</nowiki></code> {{convert|10|km|nmi mi|order=flip|sigfig=5|abbr=off}}
 
===Fixed ordering of output units: ''{{convert|100|C|F C K|abbr=on|order=out}}'' ===
Setting {{para|order|out}} shows the output-units as ordered; the input unit is skipped:
*<code><nowiki>{{convert|100|C|F C K|abbr=on|order=out}}</nowiki></code> &rarr; {{convert|100|C|F C K|abbr=on|order=out}}
*<code><nowiki>{{convert|200|PS|kW hp|0|abbr=on|order=out}}</nowiki></code> → {{convert|200|PS|kW hp|0|abbr=on|order=out}}
 
''See also: [[Template:Convert#Displaying_parts_of_the_result:_2_(1.5)|§ Displaying parts of the output]]''.


=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
Line 239: Line 424:


{| class="wikitable"
{| class="wikitable"
! Convert !! Output !! Description
! Convert !! Output !! Returns
|-
|-
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}} || Default, to compare
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}}
| Regular output (for comparison)
|-
|-
| <code><nowiki>{{convert|2|cuyd|m3|abbr=values}}</nowiki></code> || {{convert|2|cuyd|m3|abbr=values}} || Input and output values
| <code><nowiki>{{convert|2|cuyd|m3|abbr=values}}</nowiki></code>
| {{convert|2|cuyd|m3|abbr=values}} || Input and output numbers
|-
|-
| <code><nowiki>{{convert|2|cuyd|m3|disp=unit}}</nowiki></code> || {{convert|2|cuyd|m3|disp=unit}} || Input unit
| <code><nowiki>{{convert|2|cuyd|m3|disp=unit}}</nowiki></code> || {{convert|2|cuyd|m3|disp=unit}}
| Input unit
|-
|-
| <code><nowiki>{{convert|2|cuyd|m3|disp=unit|adj=on}}</nowiki></code> || {{convert|2|cuyd|m3|disp=unit|adj=on}} || Input unit, adjective (hyphenated)
| <code><nowiki>{{convert|2|cuyd|m3|disp=unit|adj=on}}</nowiki></code> || {{convert|2|cuyd|m3|disp=unit|adj=on}}
| Input unit, adjective (hyphenated)
|-
|-
| <code><nowiki>{{convert|2|cuyd|cuyd|0|disp=out|abbr=off}}</nowiki></code> || {{convert|2|cuyd|cuyd|0|disp=out|abbr=off}} || Input (''workaround'')
| <code><nowiki>{{convert|2|cuyd|cuyd|disp=out}}</nowiki></code> || {{convert|2|cuyd|cuyd|disp=out}} || Input (''workaround''. {{nowrap|1=Note repetition of unit in input}})
|-
| <code><nowiki>{{convert|2|cuyd|m3|abbr=~}}</nowiki></code> || {{convert|2|cuyd|m3|abbr=~}}
| Input: both name and symbol
|-
|-
| <code><nowiki>{{convert|2|cuyd|m3|disp=unit2}}</nowiki></code> || {{convert|2|cuyd|m3|disp=unit2}} || Output unit (symbol)
| <code><nowiki>{{convert|2|cuyd|m3|disp=unit2}}</nowiki></code> || {{convert|2|cuyd|m3|disp=unit2}} || Output unit (symbol)
Line 255: Line 447:
| <code><nowiki>{{convert|2|cuyd|m3|disp=unit2|abbr=off}}</nowiki></code> || {{convert|2|cuyd|m3|disp=unit2|abbr=off}} || Output unit (name)
| <code><nowiki>{{convert|2|cuyd|m3|disp=unit2|abbr=off}}</nowiki></code> || {{convert|2|cuyd|m3|disp=unit2|abbr=off}} || Output unit (name)
|-
|-
| <code><nowiki>{{convert|2|cuyd|m3|disp=number}}</nowiki></code> || {{convert|2|cuyd|m3|disp=number}} || Output value
| <code><nowiki>{{convert|2|cuyd|m3|disp=number}}</nowiki></code> || {{convert|2|cuyd|m3|disp=number}}
| Output value
|-
|-
| <code><nowiki>{{convert|2|cuyd|m3|disp=out}}</nowiki></code> || {{convert|2|cuyd|m3|disp=out}} || Output value and unit
| <code><nowiki>{{convert|2|cuyd|m3|disp=out}}</nowiki></code> || {{convert|2|cuyd|m3|disp=out}}
| Output value and unit name
|-
|-
| <code><nowiki>{{convert|2|cuyd|m3|abbr=off|disp=out}}</nowiki></code> || {{convert|2|cuyd|m3|abbr=off|disp=out}} || Output value and unit
| <code><nowiki>{{convert|2|cuyd|m3|disp=out|abbr=off}}</nowiki></code> || {{convert|2|cuyd|m3|disp=out|abbr=off}}
| Output value and unit symbol
|}
|}


== Table options ==
===Display both input name and symbol: ''2 kilopascals [kPa]''===
For the [[Help:Table/Manual tables|wikitable]] structure, there are two options: split over columns and make the table sortable.
Setting {{para|abbr|~}} returns both name and  symbol of the first (input) unit:
=== Show numbers only in columns in a table ===
* <code><nowiki>{{convert|2|kPa|psi|abbr=~}}</nowiki></code> → {{convert|2|kPa|psi|abbr=~}}
Using {convert} in a table cell, with {{para|disp|table}} splits the result over two columns:
* <code><nowiki>A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure</nowiki></code> → {{nowrap|A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure}}
:<code><nowiki>{{convert|10|m|ft|disp=table}}</nowiki></code> &rarr; {{convert|10|m|ft|disp=table}}
 
==Table options==
For the [[Help:Table/Manual tables|wikitable]] structure, there are three options: add a line-break, split the result over columns and make the table sortable.
 
===Enforced line break===
{{para|disp|br}} adds a line-break and omits brackets.
 
{{para|disp|br()}} adds a line-break and does add brackets to the converted value. This may be useful in tables:
{| class=wikitable
! {{para|disp|br}} !! {{para|disp|br()}}
|-
|{{convert|100|km|mi|disp=br}}
|{{convert|100|km|mi|disp=br()}}
|}
 
===Table columns ===
Using {convert} in a table cell, with {{para|disp|table}} splits the result over two (or more) columns. By default units are not included in the table, however, they can be added using the {{para|abbr|}} parameter. Multiple-unit outputs, like <code>ftin</code>, always output their units to the table.
 
:<code><nowiki>{{convert|10|m|ft|disp=table}}</nowiki></code>
<code>{{convert|10|m|ft|disp=table}}</code>


{{para|disp|tablecen}} does the same, and also centers the text:
{{para|disp|tablecen}} does the same, and also centers the text:
:<code><nowiki>{{convert|20|m|ft|disp=tablecen}}</nowiki></code> &rarr; {{convert|20|m|ft|disp=tablecen}}
:<code><nowiki>{{convert|20|m|ft|disp=tablecen}}</nowiki></code>
<code>{{convert|20|m|ft|disp=tablecen}}</code>


The units are added as a column header:
The units are added as a column header:
:{| class=wikitable
:{| class=wikitable
! style="width:10em;" | &nbsp;
! style="width:10em;" | &nbsp;
! style="width:10em;" | m
! style="width:10em;" | kilograms
! style="width:10em;" | ft
! style="width:10em;" | pounds
! style="width:10em;" | stone and pounds
|-
|-
| {{para|disp|table}}
| {{para|disp|table}}
| {{convert|10|m|ft|disp=table}}
| {{convert|10|kg|lb stlb|disp=table}}
|-
|{{para|disp|table}} and {{para|abbr|on}}
| {{convert|20|kg|lb stlb|disp=table|abbr=on}}
|-
|{{para|disp|table}} and {{para|abbr|off}}
| {{convert|30|kg|lb stlb|disp=table|abbr=off}}
|-
|-
|{{para|disp|tablecen}}
|{{para|disp|tablecen}}
| {{convert|20|m|ft|disp=tablecen}}
| {{convert|40|kg|lb stlb|disp=tablecen}}
|-
|-
|{{para|disp|&lt;other>}} <small>(default)</small>
|{{para|disp|&lt;other>}} <small>(default)</small>
|{{convert|30|m|ft|disp=}}
|{{convert|50|kg|lb stlb|disp=}}
|-
|}
|}


=== Sorting ===
===Sorting===
:Use both {{para|disp|table}} {{para|sortable|on}} to make a table column sortable. Only the first column will sort correct.
Use {{para|sortable|on}} to include a ''hidden numerical sortkey'' in the output, suitable for use in a [[Help:Sorting|table with sortable columns]]. Technically, this places a hidden string before the actual displayed values:
:<code><nowiki>{{convert|10|m|ft|sortable=on}}</nowiki></code> {{nowrap|1=→ <code>&lt;span data-sort-value="7001100000000000000♠">&lt;/span>10 metres (33&nbsp;ft)</code>}}
:showing: {{convert|10|m|ft|sortable=on}}.


:<nowiki>{{convert|10|m|ft|disp=table|sortable=on}}</nowiki> &rarr; ''<small>(don't let this frighten you)</small>''
Use both {{para|disp|table}} and {{para|sortable|on}} together to produce table columns (pipe symbols) for each value in sortable columns:
{{convert|10|m|ft|disp=table|sortable=on}}


:{| class="wikitable sortable"
:{| class="wikitable sortable"
!
! m
! m
! m
! ft
! ft
|-
|-
| {{convert|10|m|ft|disp=table|sortable=on}}
| A
| {{val|15.75|u=m}}
| {{convert|15+3/4|m|ft|disp=table|sortable=on}}
|-
|-
| {{convert|20|m|ft|disp=table|sortable=on}}
| B
| {{val|15.5|u=m}}
| {{convert|15.5|m|ft|disp=table|sortable=on}}
|-
|-
| {{convert|30|m|ft|disp=table|sortable=on}}
| C
| {{val|16|u=m}}
| {{convert|16.0|m|ft|disp=table|sortable=on}}
|-
| D
| {{val|16|u=m}}
| {{convert|16|m|ft|disp=table|sortable=on}}
|}
|}


==Units overview==
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.
{{selfref|See also: complete [[Template:Convert/list of units|Convert/list of units]]}}
 
<div style="height: 400px; overflow: auto; padding: 3px; border: 1px solid #aaa;">
==Units==
The conversion factors and physical constants are sourced [[Module:Convert/documentation/conversion data introduction/doc#Conversion factors and physical constants|here]].
 
===All units===
{{selfref|See also: [[Template:Convert/list of units|Convert/list of units]]}}
{{hatnote|Units are case-sensitive: use {{xt|kW}}, not {{!xt|KW}} or {{!xt|kw}}}}
{{Convert/list of units}}
{{Convert/list of units}}
</div>
 
==={{anchor|per}}'per' units: ''kg/hl'', ''miles per gallon''===
When using a slash (<code>/</code>), a unit like <code>kg/hl</code> is recognized as kilograms ''per'' hectolitre and will be converted with other mass/volume units.
* <code><nowiki>{{convert|1000|kg/hl}}</nowiki></code> → {{convert|1000|kg/hl}}
 
Population density (''inhabitants per square mile'') can be converted using
* <code><nowiki>{{convert|10|PD/sqmi|PD/km2}}</nowiki></code> → {{convert|10|PD/sqmi|PD/km2}}
 
Vehicular fuel efficiency, commonly expressed in ''miles per gallon'' or ''litres per 100 km'' can also be converted
* <code><nowiki>{{convert|26|mpgUS|l/100km mpgimp}}</nowiki></code> → {{convert|26|mpgUS|l/100km mpgimp}}
 
==={{anchor|Units of difference}}Units of difference: Expressing a change or difference in temperature===
We have already discussed standard temperature conversions (°C, °F, K), as shown in these two examples:
* {{#invoke:DemoTemplate|convert|10|C}} (standard temperature conversion)
* {{#invoke:DemoTemplate|convert|10–15|C}} (standard temperature range conversion)
 
When expressing a temperature ''change'' (e.g., "The temperature ''increased'' by 10&nbsp;°C"), or when ''comparing'' temperatures (e.g., "10 to 15&nbsp;°C ''warmer''"), we cannot use the standard temperature units ({{para||C}}, {{para||F}} and {{para||K}}), which refer to points on the respective scale. Instead, we must use one of the following "units of difference": {{para||C-change}}, {{para||F-change}} and {{para||K-change}}.
 
Compare the following two examples with the two above:
 
* {{#invoke:DemoTemplate|convert|10|C-change}} increase in temperature
* {{#invoke:DemoTemplate|convert|10–15|C-change}} warmer than normal
 
To produce multiple units in the output:
* {{#invoke:DemoTemplate|convert|10|C-change|F-change K-change}} difference
 
===Multiple units: ''1 ft 5 in''===
====In input====
Base document {{section link|Module:Convert/documentation/conversion data/doc|Input multiples|nopage=y}} lists options for ''multiple unit input'' (like <code>ft,in</code>). It can catch predefined sets only (units that can be subdivided; e.g., yd into ft):
* <code><nowiki>{{convert|1|yd|2|ft|3|in}}</nowiki></code> → {{convert|1|yd|2|ft|3|in}}
* <code><nowiki>{{convert|2|ft|3|in|cm}}</nowiki></code> → {{convert|2|ft|3|in|cm}}
* <code><nowiki>{{convert|1|lb|5|oz|g}}</nowiki></code> → {{convert|1|lb|5|oz|g}}
 
====In output====
Available multiple-unit output options predefined, like <code>ftin</code> and <code>ydftin</code>. The full list is at {{section link|Module:Convert/documentation/conversion data/doc|Output multiples|nopage=y}}.
* <code><nowiki>{{convert|2|m|ftin}}</nowiki></code> → {{convert|2|m|ftin}}
* <code><nowiki>{{convert|2|m|ft in}}</nowiki></code> → {{convert|2|m|ft in}}, using a space, returns the decimal point
Default behaviour, for comparison:
* <code><nowiki>{{convert|2|m}}</nowiki></code> → {{convert|2|m}}
 
See also:
* {{tl|hands}} a length used to measure horses
* {{tl|Long ton}} a weight in ton, cwt, qr and lb
<!-- todo: mention the 0-3 limits -->
 
===Currency per unit: ''$/mi &rarr; $/km''===
Using currency symbols in a ''$ per unit'' value, you can convert the per-unit:
* <code><nowiki>{{convert|10|$/mi|$/km}}</nowiki></code> → {{convert|10|$/mi|$/km}}
* <code><nowiki>{{convert|1500|$/ozt|$/g}}</nowiki></code> → {{convert|1500|$/ozt|$/g}}
 
You can set the currency in ''both'' values using {{para|$|€}}:
* <code><nowiki>{{convert|10|$/mi|$/km|$=€}}</nowiki></code> → {{convert|10|$/mi|$/km|$=€}}
 
It is ''not'' possible to convert the currency. So, this result (mixed currencies) is ''not'' possible: {{!mxt|1=$15 per mile (€8.6/km)}} {{nay}}
 
==Using convert inside templates==
For usage in template code, like infoboxes, {{tlf|Convert}} has these options:
;Pre-formatting fraction input
* [[Module:Convert/helper]] can read regular input and pre-format it into {{tlf|Convert}}-accepted input.
:Your template can accept {{para|input|16 7/8}} and use <nowiki>{{#invoke:Convert/helper|number|16 7/8}}</nowiki> &rarr; {{#invoke:Convert/helper|number|16 7/8}}
 
;Using a Wikidata property
* Adding the Wikidata property code, like code {{para|input|P2073}}, 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 {{para|qid}}.
 
Example for {{Wikidata property link|P2073}}:
Note: this example uses {{para|qid|Q1056131}} (testing for {{Wikidata entity link|Q1056131}})
* <code><nowiki>{{convert|input=P2073|qid=Q1056131|ftin|abbr=on}}</nowiki></code>  &rarr; {{convert|input=P2073|qid=Q1056131|ftin|abbr=on}}
* <code><nowiki>{{convert|input=P2073|qid=Q1056131|km|abbr=on}}</nowiki></code>  &rarr; {{convert|input=P2073|qid=Q1056131|km|abbr=on}}
* <code><nowiki>{{convert|input=P2073|qid=Q1056131|km|abbr=on|disp=out}}</nowiki></code>  &rarr; {{convert|input=P2073|qid=Q1056131|km|abbr=on|disp=out}}
:For example see [[template:Infobox Telescope]].
 
Sometimes a property may have more than one value against it in Wikidata. You can use the {{para|qual}} parameter to specify which of the values you want to use.
 
Example for {{Wikidata property link|P2386}}:
Note: this example uses {{para|qid|Q1513315}} (testing for {{Wikidata entity link|Q1513315}})
* {{Wikidata entity link|Q613628}}: <code><nowiki>{{convert|input=P2386|qual=Q613628|ft|abbr=on}}</nowiki></code> → {{convert|input=P2386|qid=Q1513315|qual=Q613628|ft|abbr=on}}
* {{Wikidata entity link|Q1395645}}: <code><nowiki>{{convert|input=P2386|qual=Q1395645|ft|abbr=on}}</nowiki></code> → {{convert|input=P2386|qid=Q1513315|qual=Q1395645|ft|abbr=on}}


==Parameter list==
==Parameter list==
Line 314: Line 632:


==Deprecated options==
==Deprecated options==
Deprecated options should not be used. There is no guarantee that they will be supported in the future.
{{Convert/doc/deprecations list}}
<!-- see for example [[Template_talk:Convert/Archive_September_2014#Next_grand_step:_.7Bconvert.7D_3.0]] -->
* {{!xt|1=disp=slash}}, {{!xt|1=disp=s}}, {{!xt|1=disp=/}} are deprecated. Use {{xt|1=disp=or}} instead
* {{!xt|1=disp=flip}}, {{!xt|1=adj=flip}} are deprecated. Use {{xt|1=order=flip}} instead
* {{!xt|1=disp=flip5}} is deprecated. Use {{xt|1=order=flip}} {{xt|1={{!}}round=5}} instead
* {{!xt|1=disp=5}}, {{!xt|1=near=5}}, is deprecated. Use {{xt|1=round=5}} instead
* {{!xt|1=abbr=comma}} is deprecated. Use {{xt|1=adj=nocomma}} instead
* {{!xt|1=disp=2}} is deprecated. Use {{xt|1=disp=output only}} instead
* {{!xt|1=disp=u2}} is deprecated. Use {{xt|1=disp=unit2}} instead
* {{!xt|1=abbr=mos}} is deprecated (will be ignored). Use range separator {{xt|<nowiki>|by|</nowiki>}} ''or'' {{xt|<nowiki>|x|</nowiki>}} instead
* Range separator {{!xt|<nowiki>|xx|</nowiki>}} is deprecated (not [[MOS:UNITS|MOS]]). Use {{xt|<nowiki>|x|</nowiki>}} instead
* Range separator {{!xt|<nowiki>|*|</nowiki>}} is deprecated (not [[MOS:UNITS|MOS]]). Use {{xt|<nowiki>|x|</nowiki>}} instead


==TemplateData==
==TemplateData==
{{TemplateDataHeader}}
{{TemplateData header}}


<templatedata>{
<templatedata>
"description": "Converts measurements to other units.",
{
"params": {
"description": "Converts measurements to other units.",
"1": {
"params": {
  "label": "value",
"1": {
  "description": "the value to convert",
"label": "Value",
  "type": "number"
"description": "The value to convert.",
},
"type": "number",
"2": {
"required": true
  "label": "from unit",
},
  "description": "",
"2": {
  "type": "string/line"
"label": "From unit",
},
"description": "The unit for the provided value.",
"3": {
"type": "string",
  "label": "to units",
"example": "km",
  "description": "",
"required": true
  "type": "string/line"
},
},
"3": {
"4": {
"label": "To units",
  "label": "precision or suffix",
"description": "The units to convert into. Separate units by a space for multiple outputs. In an output unit, use + for a multiplication space.",
  "description": "significant digits after decimal dot or, if negative, exponent of ten",
"type": "string",
  "type": "number"
"example": "mi nmi",
},
"suggested": true
"lk": {
},
  "label": "link units",
"4": {
  "description": "“on” all, “in” input, “out” output or “off” no units",
"label": "Precision or suffix",
  "default": "off",
"description": "Significant digits after decimal dot or, if negative, exponent of ten.",
  "type": "string/line"
"type": "number"
},
},
"abbr": {
"lk": {
  "label": "abbreviation",
"label": "Link units",
  "description": "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",
"description": "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.",
  "default": "out",
"default": "off",
  "type": "string/line"
"type": "string",
},
"example": "on"
"sp": {
},
  "label": "spelling",
"abbr": {
  "description": "“us” display U.S. spelling of unit names",
"label": "Abbreviation",
  "type": "string/line"
"description": "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).",
},
"default": "out",
"adj": {
"type": "string",
  "label": "adjective",
"example": "on, unit, in, out, off",
  "description": "adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end",
"suggested": true
  "type": "string/line"
},
},
"sp": {
"disp": {
"label": "Spelling",
  "label": "conversion",
"description": "Spelling of units. Use “us” to display unit names using U.S. spelling.",
  "description": "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",
"type": "string",
  "default": "b",
"example": "us"
  "type": "string/line"
},
},
"adj": {
"order": {
"label": "Adjective",
  "label": "ordering",
"description": "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.",
  "description": "“flip” returns converted value first, input value second.",
"type": "unbalanced-wikitext",
  "type": "string/line"
"example": "on",
},
"default": "off"
"sigfig": {
},
  "label": "significant figures",
"disp": {
  "description": "number that sets the number of significant figures",
"label": "Conversion",
  "type": "number"
"description": "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.",
},
"type": "string",
"round": {
"example": "b"
  "label": "rounding output",
},
  "description": "“5” rounds the output number to nearest multiple of 5, “25” to nearest multiple of 25, “each” rounds each number in a range",
"order": {
  "type": "string/line"
"label": "Ordering",
},
"description": "“flip” returns converted value first, input value second.",
"sortable": {
"type": "string",
  "label": "sort key",
"example": "flip"
  "description": "“on” generates a hidden sort key",
},
  "type": "string/line"
"sigfig": {
"label": "Significant figures",
"description": "Indicates the number of significant figures to be used in rounding.",
"type": "number"
},
"round": {
"label": "Rounding output",
"description": "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.",
"type": "number"
},
"comma": {
"label": "Thousands separator",
"description": "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",
"type": "string",
"example": "off"
},
"sortable": {
"label": "Sort key",
"description": "“on” generates a hidden sort key",
"type": "string",
"example": "on"
},
"spell": {
"label": "Spell numbers?",
"description": "If used, spells input or input and output numbers in words, optionally capitalizing the first",
"example": "'in', 'In', 'on', or 'On'",
"type": "string"
},
"sing": {
"type": "string",
"deprecated": "use adj=",
"label": "Singular?",
"description": "If 'yes', uses singular form of units (deprecated)",
"example": "yes"
},
"frac": {
"label": "Fraction?",
"description": "fraction as rounding unit",
"type": "number"
},
"$": {
"label": "Currency symbol",
"description": "sets currency symbol in both units",
"example": "$=€ will show \" €10 per mile (€6.2/km)\"",
"type": "string"
},
"input": {
"label": "WD property",
"description": "Reads the property value of the item (article), then converts it",
"example": "{{convert|input=P2046}} (P2046=area)",
"type": "string"
}
},
"format": "inline"
}
}
}}</templatedata>
</templatedata>
 
<!--''to be added''
==Glossary==
==Glossary==
:''to be added''
;unit code
:
;unit symbol
:
-->


==See also==
==See also==
* [[Template:Convert/old]]&nbsp;— Version as used until December 2013
* {{tl|Cvt}}
* [[Template:Convert/units not supported]]
* {{tl|SI units}}
* [[:Category:Convert error categories]]
* {{tl|Inflation}} to convert historical prices to their current equivalent.
{{Math templates|conversion}}<noinclude>
{{Convert/documentation navbox}}
<noinclude>
[[Category:Convert by module documentation| ]]
[[Category:Convert by module documentation| ]]
</noinclude><includeonly>
</noinclude><includeonly>{{Sandbox other||{{#ifeq:{{SUBPAGENAME}}|doc||
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Convert templates| ]]
[[Category:Convert templates| ]]
[[Category:Inline cleanup templates]]
[[Category:Conversion templates]]
[[Category:Numbers as words conversion templates]]
[[Category:Numbers as words conversion templates]]
</includeonly>
[[Category:Sorting templates]]
}}}}</includeonly>

Latest revision as of 01:05, 3 September 2020

For currency conversion into US dollars, see Template:To USD

Template {{convert}} calculates from one measurement unit to another one, and then presents the results formatted. The complete list of unit symbols recognized by the template is at Module:Convert/documentation/conversion data.

For example:

{{convert|2|km|mi}} → 2 kilometres (1.2 mi) (km entered, so converted into mile)
{{convert|7|mi|km}} → 7 miles (11 km) (mi entered, so 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)
See Help:Convert for more detailed, technical information

Units to convert

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
For three-unit units, etc., see Category:Convert-like templates

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

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 |abbr=in is the reverse behaviour to the default:

  • {{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: {{cvt}} has |abbr=on by default

Template {{cvt}} is the same as {{convert}}, except that it has |abbr=on as the default behaviour. In {{cvt}}, 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

Use |adj=on to produce the adjectival (hyphenated) form:

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

Default behaviour, for comparison:

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

|adj=on 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?

See Help:Convert § Rounding for a more mathematical description of the rounding options

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 {{Convert}} 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) The more-exact value is 37.4904 m or so, which gets converted 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

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 multiple of ​110 to the 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>:

  • {{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 behaviour, for comparison:

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

Setting |sigfig= to a value less than 1 is meaningless:

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

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)

Default behaviour, 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 |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: 2 316 inch

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

  • {{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 behaviour uses decimal notation:

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

Rounding temperatures: °C, °F and K

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 |sigfig=:

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

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 {{#expr:}} 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:

  • |adj=ri0
  • |adj=ri1
  • |adj=ri2
  • |adj=ri3

Note that there is no |adj=ri-1Red XN or similar for rounding above the decimal place. 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:

  • {{convert|4.14159|mi|km|adj=ri0}} → 4 miles (6.66524 km) Red XN (precisions are mismatched)
  • {{convert|4.14159|mi|km|0|adj=ri0}} → 4 miles (7 km) Green tickY

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

  • {{convert|{{#expr:4.14159 round 0}}|mi|km|0}} → 4 miles (6 km) Red XN (double rounding)

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)

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

See also:

Ranges of values

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)

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

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
 &ndash; (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) |abbr=on abbreviates the first unit
and(-)|abbr=on {{convert|3|and(-)|6|ft|abbr=on}} 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) |abbr=on 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}} 3 to about 6 feet (0.91 to about 1.83 m)
+/- {{convert|3|+/-|6|ft}} 3 ± 6 feet (0.91 ± 1.83 m)
± &plusmn; {{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}} 3, and 6 feet (0.91, and 1.83 m)
, 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) |abbr=on abbreviates and repeats the first unit
× &times; {{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 |xx| is deprecated. Use |x| instead
* |*| is deprecated. Use |x| instead

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 ×, 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 |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)

Lists of values: 20, 40, or 60 miles

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

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:

Default behaviour, for comparison:

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

However, converting metric units into feet and inches with |order=flip 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

Spelling of unit name: international metre or US meter?

Default spelling of units is in the en (generic) locale. 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}} → ten miles (16,000 m)

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

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

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

  • {{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 |abbr=. To the extreme:

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

Inserted before units: 4 planted acres

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

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

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)

Fractions: one-eighth of an imperial pint

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

See Help:Convert § Wrapping and line breaking

Spelling out "thousands", "millions", etc.

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 |abbr=on

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

To spell out "thousands", "millions", etc., |abbr=unit abbreviates the unit; |abbr=off 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

Using an SI prefix: gigametre (Gm), or micrometre (μm)

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)

Engineering notation: 7 × 106 m

In the unit: e6m

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

In scientific notation, a number is written like 1.23×10−14. The plain number has exactly one digit before the decimal point.

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}} → 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)

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] Red XN This is neither a mixed number nor a range, and mathematical expressions requiring calculations are not allowed here.

Horizontal fraction bar: 1/2 inch

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

Using a negative value for |frac= provides a horizontal fraction bar for the converted (output) unit:

Thousands separator: 1,000 mi or 1000 mi

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 |comma=off to remove the separator from the output:

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

Use |comma=gaps to use digit grouping by gap (thin space) as a thousands separator:

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

Default behaviour, for comparison:

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

Setting |comma=5 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 behaviour, for comparison:

  • {{convert|1234|m|ft}} → 1,234 metres (4,049 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, 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 behaviour, for comparison:

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

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 (useful in tables):

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

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

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

Default behaviour, 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)

Setting |order=out 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)

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

Convert Output Returns
{{convert|2|cuyd|m3}} 2 cubic yards (1.5 m3) Regular output (for comparison)
{{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|disp=out}} 2.0 cu yd Input (workaround. Note repetition of unit in input)
{{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 name
{{convert|2|cuyd|m3|disp=out|abbr=off}} 1.5 cubic metres Output value and unit symbol

Display both 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}} pressureA 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

Using {convert} in a table cell, with |disp=table splits the result over two (or more) columns. By default units are not included in the table, however, they can be added using the |abbr= 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

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

  kilograms pounds stone and pounds
|disp=table 10 22 1 st 8 lb
|disp=table and |abbr=on 20 kg 44 lb 3 st 2 lb
|disp=table and |abbr=off 30 kilograms 66 pounds 4 stone 10 pounds
|disp=tablecen 40 88 6 st 4 lb
|disp=<other> (default) 50 kilograms (110 lb; 7 st 12 lb)

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 data-sort-value="7001100000000000000♠"></span>10 metres (33 ft)
showing: 10 metres (33 ft).

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

m m ft
A 15.75 m 15+34 52
B 15.5 m 15.5 51
C 16 m 16.0 52.5
D 16 m 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

The conversion factors and physical constants are sourced here.

All units

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

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

Page Template:Divbox/styles.css has no content.

{{Convert}} 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 {{convert}} as the second and third unnamed parameters:

  • {{convert|100|kg|lb}} → 100 kilograms (220 lb)
  • {{convert|100|lb|kg}} → 100 pounds (45 kg)

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

  • {{convert|100|Mm|mm}} → 100 megametres (1.0×1011 mm)

The output of {{convert}} 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.

  • {{convert|55|nmi|km mi}} → 55 nautical miles (102 km; 63 mi)
  • {{convert|1|oz|ozt g gr}} → 1 ounce (0.91 ozt; 28 g; 440 gr)

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


AREA
(Full list)
system unit unit-
code
abbrev-
iation
notes sample default
conversion
combination
output units
SI square kilometre km2 km2 US spelling: square kilometer
1.0 km2 (0.39 sq mi)
  • km2 sqmi
square metre m2 m2 US spelling: square meter
1.0 m2 (11 sq ft)
  • m2 sqft
square centimetre cm2 cm2 US spelling: square centimeter
1.0 cm2 (0.16 sq in)
  • cm2 sqin
square millimetre mm2 mm2 US spelling: square millimeter
1.0 mm2 (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 km2)
  • sqmi km2
acre acre (none) 1.0 acre (0.40 ha)
square yard sqyd sq yd 1.0 sq yd (0.84 m2)
square foot sqft
(sqfoot)
sq ft long code "sqfoot" outputs square foot (and never feet) 1.0 sq ft (0.093 m2)
  • sqft m2 (sqfoot m2)
square inch sqin sq in 1.0 sq in (6.5 cm2)
  • sqin cm2
Other square nautical mile sqnmi sq nmi 1.0 sq nmi (3.4 km2; 1.3 sq mi)
dunam dunam (none) For alternative spellings and definitions see the full list 1.0 dunam (0.0010 km2; 0.00039 sq mi)
tsubo tsubo (none) 1.0 tsubo (3.3 m2)


DENSITY
system unit unit-
code
abbrev-
iation
notes sample default
conversion
combination
output units
Metric kilogram per cubic metre kg/m3 kg/m3 1.0 kg/m3 (1.7 lb/cu yd)
  • kg/m3 lb/ft3 (kg/m3 lb/cuft)
  • kg/m3 lb/yd3 (kg/m3 lb/cuyd)
gram per cubic metre g/m3 g/m3 1.0 g/m3 (0.0017 lb/cu yd)
  • g/m3 kg/m3
  • g/m3 lb/ft3 (g/cm3 lb/cuft)
  • g/m3 lb/yd3 (g/cm3 lb/cuyd)
Imperial
&
US customary
pound per cubic foot lb/ft3 lb/cu ft 1.0 lb/cu ft (0.016 g/cm3)
  • lb/ft3 kg/m3 (lb/cu ft g/m3)
  • lb/ft3 g/m3 (lb/cu ft g/m3)
pound per cubic yard lb/yd3 lb/cu yd 1.0 lb/cu yd (0.59 kg/m3)
  • lb/yd3 kg/m3 (lb/cuyd kg/m3)
  • lb/yd3 g/m3 (lb/cuyd g/m3)


ENERGY
(Full list)
system unit unit-
code
abbrev-
iation
notes sample default
conversion
combination
output units
SI gigajoule GJ GJ 1.0 GJ (280 kWh)
megajoule MJ MJ 1.0 MJ (0.28 kWh)
kilojoule kJ kJ 1.0 kJ (240 cal)
hectojoule hJ hJ 1.0 hJ (24 cal)
decajoule daJ daJ 1.0 daJ (2.4 cal)
joule J J 1.0 J (0.24 cal)
decijoule dJ dJ 1.0 dJ (0.024 cal)
centijoule cJ cJ 1.0 cJ (0.0024 cal)
millijoule mJ mJ 1.0 mJ (0.00024 cal)
microjoule μJ (uJ) μJ 1.0 μJ (2.4×10−7 cal)
nanojoule nJ nJ 1.0 nJ (2.4×10−10 cal)
cgs megaerg Merg Merg 1.0 Merg (0.10 J)
kiloerg kerg kerg 1.0 kerg (0.10 mJ)
erg erg (none) 1.0 erg (0.10 μJ)
Watt-hour multiples terawatt-hour TWh TWh 1.0 TWh (3.6 PJ)
TW.h TW⋅h
gigawatt-hour GWh GWh 1.0 GWh (3.6 TJ)
GW.h GW⋅h
megawatt-hour MWh MWh 1.0 MWh (3.6 GJ)
MW.h MW⋅h
kilowatt-hour kWh kWh 1.0 kWh (3.6 MJ)
kW.h kW⋅h
watt-hour Wh Wh 1.0 Wh (3.6 kJ)
W.h W⋅h
Electron-
volt
multiples
gigaelectronvolt GeV GeV 1.0 GeV (0.16 nJ)
megaelectronvolt MeV MeV 1.0 MeV (0.16 pJ)
kiloelectronvolt keV keV 1.0 keV (0.16 fJ)
electronvolt eV eV 1.0 eV (0.16 aJ)
millielectronvolt meV meV 1.0 meV (0.16 zJ)
Calorie multiples calorie Cal Cal The thermo-chemical calorie is the default definition. For others, see the full list. 1.0 Cal (4.2 kJ)
megacalorie Mcal Mcal 1.0 Mcal (4.2 MJ)
kilocalorie kcal kcal 1.0 kcal (4.2 kJ)
calorie cal cal 1.0 cal (4.2 J)
millicalorie mcal mcal 1.0 mcal (4.2 mJ)
pound/
ounce
-foot/
inch-hour-minute-second
foot-poundal ftpdl ft⋅pdl 1.0 ft⋅pdl (0.042 J)
foot-pound force ftlbf ft⋅lbf 1.0 ft⋅lbf (1.4 J)
ftlb-f ft⋅lbf
inch-pound force inlbf in⋅lbf 1.0 in⋅lbf (110 mJ)
inlb-f in⋅lbf
inch-ounce force inozf in⋅ozf 1.0 in⋅ozf (7.1 mJ)
inoz-f in⋅ozf
horsepower-hour hph hp⋅h 1.0 hp⋅h (0.75 kWh)
British thermal unit British thermal unit Btu Btu The International Steam Table British thermal unit is used. For others, see the full list. 1.0 Btu (1.1 kJ)
BTU BTU
TNT-based units gigatonne of TNT GtTNT (none) 1.0 gigatonne of TNT (4.2 EJ)
gigaton of TNT GtonTNT (none)
megatonne of TNT MtTNT (none) 1.0 megatonne of TNT (4.2 PJ)
megaton of TNT MtonTNT Mt
kilotonne of TNT ktTNT (none) 1.0 kilotonne of TNT (4.2 TJ)
kiloton of TNT ktonTNT kt
tonne of TNT tTNT (none) 1.0 tonne of TNT (4.2 GJ)
ton of TNT tonTNT (none)
Other
Hartree Eh Eh 1.0 Eh (27 eV)
rydberg Ry Ry 1.0 Ry (14 eV)
tonne of oil equivalent toe toe 1.0 toe (42 GJ)
barrel of oil equivalent BOE BOE 1.0 BOE (6.1 GJ)
cubic foot of natural gas cuftnaturalgas (cufootnaturalgas) Unit-code cufootnaturalgas will show "cubic foot of natural gas" if plural. 1.0 cubic foot of natural gas (1.1 MJ)
latm[convert: unknown unit] latm (none) 1.0 latm[convert: unknown unit]
Latm Latm[convert: unknown unit]
impgalatm[convert: unknown unit] impgalatm (none) 1.0 impgalatm[convert: unknown unit]
USgalatm[convert: unknown unit] USgalatm
(usgalatm)
(none) 1.0 USgalatm[convert: unknown unit]
U.S.galatm
(usgalatm)
U.S.galatm[convert: unknown unit]


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 lbf)
  • 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 lbf)
  • MN LT-f
  • MN LTf
  • MN ST-f
  • MN STf
kilonewton kN kN Allows triple output units. See: full list. 1.0 kN (220 lbf)
  • kN LT-f
  • kN LTf
  • kN ST-f
  • kN STf
newton N N 1.0 N (0.22 lbf)
  • N lb-f
  • N lbf
  • N oz-f
  • N ozf
millinewton mN mN 1.0 mN (0.0036 ozf)
  • mN oz-f
  • mN ozf
  • mN gr-f
  • mN grf
micronewton μN (uN) μN 1.0 μN (0.0016 grf)
  • μN gr-f
  • μN grf
nanonewton nN nN 1.0 nN (1.6×10−6 grf)
  • nN gr-f
  • nN grf
cgs megadyne Mdyn Mdyn 1.0 Mdyn (2.2 lbf)
kilodyne kdyn kdyn 1.0 kdyn (0.036 ozf)
dyne dyn
(dyne)
dyn 1.0 dyn (0.016 grf)
millidyne mdyn mdyn 1.0 mdyn (1.6×10−5 grf)
Metric gravitational units tonne-force t-f tf 1.0 tf (9.8 kN; 0.98 LTf; 1.1 STf)
tf tf
kilogram-force kg-f kgf 1.0 kgf (9.8 N; 2.2 lbf)
kgf kgf
gram-force g-f gf 1.0 gf (9.8 mN; 0.035 ozf)
gf gf
milligram-force mg-f mgf 1.0 mgf (9.8 μN; 0.015 grf)
mgf mgf
Avoirdupois-based units poundal pdl pdl 1.0 pdl (0.14 N)
long ton-force LT-f LTf 1.0 LTf (10.0 kN)
  • LT-f ST-f
LTf long ton-force
  • LTf STf
short ton-force ST-f STf 1.0 STf (8.9 kN)
  • ST-f LT-f
STf short ton-force
  • STf LTf
pound-force lb-f lbf 1.0 lbf (4.4 N)
lbf lbf
grain-force gr-f grf 1.0 grf (640 μN)
grf grf


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 ftin)
  • 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−5 in)
nanometre nm nm US spelling: nanometer
1.0 nm (3.9×10−8 in)
non-SI metric ångström Å
(angstrom)
Å 1.0 Å (3.9×10−9 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) 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 long code "foot" outputs foot (and never feet) 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)


MASS
(Full list)
system unit unit-
code
abbrev-
iation
notes sample default
conversion
combination
output units
SI kilogram kg kg Allows triple output units. See: full list. 1.0 kg (2.2 lb)
  • kg lb
  • kg st
gram g g 1.0 g (0.035 oz)
  • g oz
milligram mg mg 1.0 mg (0.015 gr)
  • mg gr
microgram μg (ug) μg 1.0 μg (1.5×10−5 gr)
non-SI metric tonne t t Allows triple output units. See: full list. 1.0 t (0.98 long tons; 1.1 short tons)
  • t LT
  • t ST
metric ton MT t
  • MT LT
  • MT ST
Avoirdupois long ton LT (none) 2,240 lb
used mostly in the British Commonwealth.
Allows triple output units. See: full list.
1.0 long ton (1.0 t)
  • LT t
  • LT MT
  • LT ST
long ton long ton
short ton ST (none) 2,000 lb
used mostly in the US.
Allows triple output units. See: full list.
1.0 short ton (0.91 t)
  • ST t
  • ST MT
  • ST LT
short ton short ton
stone st st 14 lb
used mostly in the British Commonwealth except Canada.
Allows triple output units. See: full list.
1.0 st (14 lb; 6.4 kg)
  • st kg
  • st lb
pound lb lb Allows triple output units. See: full list. 1.0 lb (0.45 kg)
  • lb kg
  • lb st
ounce oz oz 1.0 oz (28 g)
  • oz g
drachm drachm (none) 1.0 drachm (1.8 g)
drachm dram (none)
grain gr gr equivalent to the troy grain 1.0 gr (0.065 g)
Troy troy ounce ozt ozt 1.0 ozt (1.1 oz; 31 g)
other carat carat (none) 1.0 carat (0.20 g)


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
foot per second ft/s (foot/s) ft/s long code "foot/s" outputs foot per second (and never feet) 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


TEMPERATURE
(Full list)
system unit unit-
code
abbrev-
iation
notes sample default
conversion
combination
output units
SI K K K Allows triple output units. See: full list. 1.0 K (−272.15 °C; −457.87 °F)
  • K °C (K C)
  • K °R (K R)
  • K °F (K F)
°C °C (C) °C 1.0 °C (33.8 °F)
  • °C K (C K)
  • °C °R (C R)
  • °C °F (C F)
Imperial
&
US customary
°R °R (R) °R 1.0 °R (0.556 K; −458.670 °F; −272.594 °C)
  • °R K (R K)
  • °R °C (R C)
  • °R °F (R F)
°F °F (F) °F 1.0 °F (−17.2 °C)
  • °F K (F K)
  • °F °C (F C)
  • °F °R (F R)
Celsius change C-change Used for temperature intervals instead of actual temperatures
Example:  {{convert|5|C-change|0}} warmer
Result: 5 °C (9 °F) warmer
Fahrenheit change F-change Used for temperature intervals instead of actual temperatures
Example:  {{convert|10|F-change|0}} colder
Result: 10 °F (6 °C) colder


TORQUE
(Full list)
system unit unit-
code
abbrev-
iation
notes sample default
conversion
combination
output units
Industrial
SI newton-metre Nm N⋅m Triple combinations are also possible. See the full list. 1.0 N⋅m (0.74 lbf⋅ft)
  • Nm kg.m
  • Nm lb.ft
Non-SI metric kilogram metre kg.m kg⋅m 1.0 kg⋅m (9.8 N⋅m; 7.2 lb⋅ft)
  • kg.m Nm
  • kg.m lb.ft
Imperial
&
US customary
pound force-foot lb.ft lb⋅ft 1.0 lb⋅ft (1.4 N⋅m)
  • lb.ft Nm
  • lb.ft kg-m
Scientific
SI newton-metre N.m N⋅m Triple combinations are also possible. See the full list. 1.0 N⋅m (0.74 lbf⋅ft)
  • N.m kgf.m
  • N.m lbf.ft
Non-SI metric kilogram force-metre kgf.m kgf⋅m 1.0 kgf⋅m (9.8 N⋅m; 7.2 lbf⋅ft)
  • kgf.m N.m
  • kgf.m lbf.ft
Imperial
&
US customary
pound force-foot lbf.ft lbf⋅ft 1.0 lbf⋅ft (1.4 N⋅m)
  • lbf.ft N.m
  • lbf.ft kgf.m


VOLUME
(Full list)
system unit unit-
code
abbrev-
iation
notes sample default
conversion
combination
output units
SI cubic metre m3 m3 US spelling: cubic meter
one kilolitre
1.0 m3 (35 cu ft)
cubic centimetre cm3 cm3 US spelling: cubic centimeter
one millilitre
1.0 cm3 (0.061 cu in)
cc cc
cubic millimetre mm3 mm3 US spelling: cubic millimeter
1.0 mm3 (6.1×10−5 cu in)
non-SI metric kilolitre kl kl US spelling: kiloliter
one cubic metre
1.0 kl (35 cu ft)
kL kL
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
L L
  • 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)
cL cL
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
mL mL
  • mL impoz
  • mL USoz
  • mL U.S.oz
Imperial
&
US customary
cubic yard cuyd cu yd 1.0 cu yd (0.76 m3)
cubic foot cuft (cufoot) cu ft long code "cufoot" outputs cubic foot (and never feet) 1.0 cu ft (0.028 m3)
cubic inch cuin cu in 1.0 cu in (16 cm3)
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)
impbu imp bu
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)
U.S.bbl U.S. bbl
barrel oilbbl bbl 42 US gal 1.0 bbl (0.16 m3)
US beer barrel USbeerbbl
(usbeerbbl)
US bbl 1.0 US bbl (120 l; 31 US gal; 26 imp gal)
U.S.beerbbl
(usbeerbbl)
U.S. bbl
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
U.S.gal U.S. 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)
U.S.qt U.S. qt
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)
U.S.pt U.S. 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
U.S.oz
(U.S.floz)
U.S. fl oz
  • 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 m3)
U.S.drybbl U.S. dry bbl
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)
U.S.bsh U.S. bsh
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)
U.S.bu U.S. bu
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
U.S.drygal U.S. dry gal
  • 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)
U.S.dryqt U.S. dry qt
US dry pint USdrypt US dry pt 1/32 US bsh 1.0 US dry pt (550 ml)
U.S.drypt U.S. dry pt


PRESSURE
unit unit-
code
abbrev-
iation
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)
mb mb
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)
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).
POPULATION DENSITY
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
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)

'per' units: kg/hl, miles per gallon

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)

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

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 (|C, |F and |K), which refer to points on the respective scale. Instead, we must use one of the following "units of difference": |C-change, |F-change and |K-change.

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

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

Default behaviour, 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

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 |$=€:

  • {{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: $15 per mile (€8.6/km) Red XN

Using convert inside templates

For usage in template code, like infoboxes, {{Convert}} has these options:

Pre-formatting fraction input
Your template can accept |input=16 7/8 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 |input=P2073, 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 |qid=.

Example for (P2073): Note: this example uses |qid=Q1056131 (testing for (Q1056131))

  • {{convert|input=P2073|qid=Q1056131|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 |qual= parameter to specify which of the values you want to use.

Example for (P2386): Note: this example uses |qid=Q1513315 (testing for (Q1513315))

  • (Q613628): {{convert|input=P2386|qual=Q613628|ft|abbr=on}} → P2386
  • (Q1395645): {{convert|input=P2386|qual=Q1395645|ft|abbr=on}} → P2386

Parameter list

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

Deprecated options

This list: 

Deprecated options should not be used. They may produce incorrect or undesired results and there is no guarantee that they will be supported in the future.

  • disp=flip is deprecated. Use order=flip instead
  • sing= is deprecated in any situation. Use adj= instead
  • Range separator |xx| is deprecated (not MOS compliant). Use |x| instead
  • Range separator |*| is deprecated (not MOS compliant). Use |x| instead

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for Convert

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.

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.

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.

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

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.

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.

Example
b
Stringoptional
Orderingorder

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

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
Stringoptional
Sort keysortable

“on” generates a hidden sort key

Example
on
Stringoptional
Spell numbers?spell

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

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

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

Example
yes
Stringdeprecated
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
WD propertyinput

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

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

See also