Zoophilia Wiki - User contributions [en]

Template:Convert/doc/range separator list

2016-06-21T08:23:32Z

178.16.7.96:

{| class="wikitable sortable collapsible {{{state|uncollapsed}}}" style="width:100%;"
! colspan=4 style="background:#eee" | {{navbar-collapsible|'''Range separators in <nowiki>{{convert}}</nowiki>'''|Convert/doc/range separator list}}
|-
! Separator
! Convert
! Result
! Notes
|-
| <code>-</code>
| <code><nowiki>{{convert|3|-|6|ft}}</nowiki></code>
| {{convert|3|-|6|ft}}
| rowspan=2 | Input can be hyphen (-) or [[Dash#En dash|en dash]] (–), output uses en dash
|-
| {{hidden sort key|-}}<code>–</code> <code>&ndash;</code> (en dash)
| <code><nowiki>{{convert|3|–|6|ft}}</nowiki></code>
| {{convert|3|–|6|ft}}
|-
| <code>and</code>
| <code><nowiki>{{convert|3|and|6|ft}}</nowiki></code>
| {{convert|3|and|6|ft}}
|-
| {{hidden sort key|and&}}<code>&</code>
| <code><nowiki>{{convert|3|&|6|ft}}</nowiki></code>
| {{convert|3|&|6|ft}}
| Same as <code>and</code>
|-
| <code>and(-)</code>
| <code><nowiki>{{convert|3|and(-)|6|ft}}</nowiki></code>
| {{convert|3|and(-)|6|ft}}
| rowspan=2 | {{para|abbr|on}} alters the punctuation(how?)
|-
| <code>and(-)|abbr=on</code>
| <code><nowiki>{{convert|3|and(-)|6|ft|abbr=on}}</nowiki></code>
| {{convert|3|and(-)|6|ft|abbr=on}}
|-
| <code>or</code>
| <code><nowiki>{{convert|3|or|6|ft}}</nowiki></code>
| {{convert|3|or|6|ft}}
|-
| <code>to</code>
| <code><nowiki>{{convert|3|to|6|ft}}</nowiki></code>
| {{convert|3|to|6|ft}}
|-
| <code>to(-)</code>
| <code><nowiki>{{convert|3|to(-)|6|ft}}</nowiki></code>
| {{convert|3|to(-)|6|ft}}
| rowspan=2 | {{para|abbr|on}} alters the punctuation(how?)
|-
| <code>to(-)|abbr=on</code>
| <code><nowiki>{{convert|3|to(-)|6|ft|abbr=on}}</nowiki></code>
| {{convert|3|to(-)|6|ft|abbr=on}}
|-
| <code>to about</code>
| <code><nowiki>{{convert|3|to about|6|ft}}</nowiki></code>
| {{nowrap|{{convert|3|to about|6|ft}}}}
|-
| <code>+/-</code>
| <code><nowiki>{{convert|3|+/-|6|ft}}</nowiki></code>
| {{convert|3|+/-|6|ft}}
|-
| {{hidden sort key|1=+/-}}<code>±</code> <code>&plusmn;</code>
| <code><nowiki>{{convert|3|±|6|ft}}</nowiki></code>
| {{convert|3|±|6|ft}}
|-
| <code>+</code>
| <code><nowiki>{{convert|3|+|6|ft}}</nowiki></code>
| {{convert|3|+|6|ft}}
|-
| <code>,</code>
| <code><nowiki>{{convert|3|,|6|ft}}</nowiki></code>
| {{convert|3|,|6|ft}}
|-
| <code>, and</code>
| <code><nowiki>{{convert|3|, and|6|ft}}</nowiki></code>
| {{nowrap|{{convert|3|, and|6|ft}}}}
|-
| <code>, or</code>
| <code><nowiki>{{convert|3|, or|6|ft}}</nowiki></code>
| {{convert|3|, or|6|ft}}
|-
| <code>by</code>
| <code><nowiki>{{convert|3|by|6|ft}}</nowiki></code>
| {{convert|3|by|6|ft}}
|-
| <code>x</code>
| <code><nowiki>{{convert|3|x|6|ft}}</nowiki></code>
| {{convert|3|x|6|ft}}
| rowspan=3 | Scientific notation. {{para|abbr|on}} alters the punctuation
|-
| <code>×</code> <code>&times;</code>
| <code><nowiki>{{convert|3|×|6|ft}}</nowiki></code>
| {{convert|3|×|6|ft}}
|-
| <code>x|abbr=on</code>
| <code><nowiki>{{convert|3|x|6|ft|abbr=on}}</nowiki></code>
| {{convert|3|x|6|ft|abbr=on}}
|- class="sortbottom"
| <code>xx</code>
| colspan=3 | {{!xt|1=|xx|}} is '''deprecated'''. Use {{xt|1=|x|}} instead
|- class="sortbottom"
| <code>*</code>
| colspan=3 | {{!xt|1=|*|}} is '''deprecated'''. Use {{xt|1=|x|}} instead
|- class="sortbottom"
| <code>to-</code>
| colspan=3 | {{!xt|1=|to-|}} is '''deprecated'''. Use {{xt|1=|to(-)|}} instead
|- class="sortbottom"
| <code>&</code>
| colspan=3 | {{!xt|1=|&|}} is '''deprecated'''. Use {{xt|1=|and|}} instead
|- class="sortbottom"
| <code>abbr=mos</code>
| colspan=3 | {{!xt|1=|abbr=mos}} is '''deprecated'''. Use {{xt|1=|x|}} or {{xt||by|}} instead
|}<noinclude>
{{documentation}}

==Later more==
The following ranges provide different output when units are abbreviated.

{| <code>class="wikitable"
! Convert !! Output
|-
| <code><nowiki>{{convert|3|and(-)|6|ft|abbr=on}}</nowiki></code>
| {{convert|3|and(-)|6|ft|abbr=on}}
|-
| <code><nowiki>{{convert|3|to(-)|6|ft|abbr=on}}</nowiki></code>
| {{convert|3|to(-)|6|ft|abbr=on}}
|-
| <code><nowiki>{{convert|3|x|6|ft|abbr=on}}</nowiki></code>
| {{convert|3|x|6|ft|abbr=on}}
|}

Ranges can use more than two values.

{| <code>class="wikitable"
! Convert !! Output
|-
| <code><nowiki>{{convert|3|x|4|x|24|in}}</nowiki></code>
| {{convert|3|x|4|x|24|in}}
|-
| <code><nowiki>{{convert|3|x|4|to|6+1/2|x|8+3/4|in}}</nowiki></code>
| {{convert|3|x|4|to|6+1/2|x|8+3/4|in}}
|}

Ranges can be specified in the first parameter.

{| <code>class="wikitable"
! Convert !! Output
|-
| <code><nowiki>{{convert|3.2-7.5|ha}}</nowiki></code>
| {{convert|3.2-7.5|ha}}
|-
| <code><nowiki>{{convert|3x4x24|in}}</nowiki></code>
| {{convert|3x4x24|in}}
|}

;From module:convert/text
range_words = { '+/-', 'to(-)', 'xx', 'x', '*', 'to', 'or', 'by', '–' , '-' }
So:
* {{convert|1+/-2|m|ft}}
* to(-) {{convert|1to(-)2|m|ft}}
* to(-) a {{convert|1to(-)2|m|ft|abbr=on}}
* and(-) {{convert|1and(-)2|m|ft}}
* {{convert|1xx2|m|ft}}
* {{convert|1x2|m|ft}}
* a {{convert|1x2|m|ft|abbr=on}}
* {{convert|1to2|m|ft}}
* {{convert|1or2|m|ft}}
* {{convert|1by2|m|ft}}
* {{convert|1–2|m|ft}}
* {{convert|1-2|m|ft}}
* {{convert|1|-|2|m|ft}}

</noinclude>

Template:Convert/doc

2016-06-21T08:21:14Z

178.16.7.96: /* Into multiple units: {{convert|10|C|F K}} */

{{documentation subpage}}
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk| {{formatnum:789000}}+ }}}}
{{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}}
'''Template {{tl|convert}}''' ''calculates'' measurements from one unit (you can enter) to another one, and then ''presents the results''. For example:
:<code><nowiki>{{convert|2|km|mi}}</nowiki></code> → {{convert|2|km|mi}}
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> → {{convert|7|mi|km}}

The available '''units''' are listed [[#Units|below]]. Units are case-sensitive always ({{xt|kW}}, ''not'' {{!xt|KW}} and ''not'' {{!xt|kw}}). Multiple '''formatting''' and calculation options are listed below.

{{hatnote|See [[Help:Convert]] for more complete information}}
{{hatnote|For currency conversion into US dollars, see [[Template:To USD]]}}

==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
By default, the first value shows unit name spelled out, the second the symbol (or abbreviation). Use {{para|abbr|on/off}} to change this behaviour:
* <code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}

To abbreviate both:
* <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}}

{{para|abbr|in}} is the reverse behaviour to the default, {{para|abbr|out}}:
*<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{convert|1|lb|kg|abbr=in}}

===Convenience: {{tlf|cvt}} has {{para|abbr|on}} by default===
Template {{tl|cvt}} is similar to {{tlf|convert}}, but 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 equal to:
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{cvt|1|lb|kg|abbr=on}}

==Adjective: ''a 10-mile distance''==
Use {{para|adj|on}} to produce the adjective form:
* <code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> → A {{convert|10|mi|km|adj=on}} distance.
Default behaviour, for comparison:
* <code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> → {{convert|10|mi|km}} to go.

This option does not work with {{para|abbr|on}}.

==Rounding: ''100 ft'' is ''30 m'' or ''30.5 m'' or ''30.48 m''?==
By definition, 100 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===
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 figures, whichever is more precise. An exception to this is ''rounding temperatures'' (see [[#Rounding temperatures|below]]).

{| class="wikitable"
|-
! colspan="3" | Examples of rounding
|-
|'''Input'''||'''Displays as'''||'''Note'''
|-
|<code><nowiki>{{convert|123|ft|m|-1}}</nowiki></code> || {{convert|123|ft|m|-1}} ||
|-
|<code><nowiki>{{convert|123|ft|m|0}}</nowiki></code> || {{convert|123|ft|m|0}} ||
|-
|<code><nowiki>{{convert|123|ft|m|1}}</nowiki></code> || {{convert|123|ft|m|1}} ||
|-
|<code><nowiki>{{convert|550|ft|m|0}}</nowiki></code> || {{convert|550|ft|m|0}} || Approximate value is 167.64 m
|-
|<code><nowiki>{{convert|550|ft|m}}</nowiki></code> || {{convert|550|ft|m}} || Rounds to 170, when approximate value is 167.64 m
|-
|<code><nowiki>{{convert|500|ft|m|0}}</nowiki></code> || {{convert|500|ft|m|0}} || Approximate value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|m}}</nowiki></code> || {{convert|500|ft|m}} || Rounds to 150, when approximate value is 152.4 m
|}

''Convert'' supports four types of rounding:

===Round to a given precision: ''use {{para|precision|}}''===
Specify the desired precision with the fourth unnamed parameter (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest 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: ''{{para|sigfig|}}''===
To specify the output number to be with ''n'' significant figures use {{para|sigfig|<number>}}:
* <code><nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki></code> → {{convert|1200|ft|m|sigfig=4}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=3}}</nowiki></code> → {{convert|1200|ft|m|sigfig=3}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=2}}</nowiki></code> → {{convert|1200|ft|m|sigfig=2}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki></code> → {{convert|1200|ft|m|sigfig=1}}
Default behaviour, for comparison:
* <code><nowiki>{{convert|1200|ft|m}}</nowiki></code> → {{convert|1200|ft|m}}
Setting {{para|sigfig|<=0}} is meaningless
* <code><nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki></code> → {{convert|1200|ft|m|sigfig=0}}

===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
Using {{para|round|5}} rounds the outcome to a multiple of 5.
* <code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
* <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.
* <code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
* <code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> → {{convert|10|m|ft|round=25}}
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}}:
* <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> → {{convert|10 x 200 x 3000|m|ft|round=each}}

===Round to a multiple of a given fraction: ''{{frac|2|3|16}} inch''===
Specify the desired ''denominator'' using {{para|frac|<some positive integer>}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|3}}).
* <code><nowiki>{{convert|5.56|cm|in|frac=16}}</nowiki></code> → {{convert|5.56|cm|in|frac=16}}
* <code><nowiki>{{convert|8|cm|in|frac=4}}</nowiki></code> → {{convert|8|cm|in|frac=4}}
The fraction is reduced when possible:
* <code><nowiki>{{convert|8|cm|in|frac=100}}</nowiki></code> → {{convert|8|cm|in|frac=100}}
Default behaviour, for comparison:
* <code><nowiki>{{convert|8|cm|in}}</nowiki></code> → {{convert|8|cm|in|sigfig=4}}

==={{anchor|Rounding temperatures}}In temperatures: rounding ''°C'', ''°F'' and ''K''===
In temperatures, the conversion will be rounded either to precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.

#{{#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|-300|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}}

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 into five significant output digits because of the two numbers 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.

==Into multiple units: ''{{convert|10|C|F K}}''==
Separate the multiple output units by a space:
* <code><nowiki>{{convert|10|C|F K}}</nowiki></code> → {{convert|10|C|F K}}
* <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 [[#In input]] and [[#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: 
{{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}}

In science, the formal way is to set <code>|x|</code> and {{para|abbr|on}} (keeping dimensions right, like in ''area = x km2''):
* <code><nowiki>{{convert|6|x|12|m|ft|abbr=on}}</nowiki></code> → {{convert|6|x|12|m|ft|abbr=on}}

===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:
* <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}}
Default behaviour, for comparison:
* <code><nowiki>{{convert|1|ft|3|in|mm}}</nowiki></code> → {{convert|1|ft|3|in|mm}}

==Words==
===Spelling of unit name: UK ''metre'' or US ''meter''?===
Default spelling of units is en-UK. 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}}

===Spell out numbers: ''ten miles''===
To write a number in words, use {{para|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}}:
* <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}}
* <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> → {{convert|10|mi|m|spell=On}}

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> → {{convert|10|mi|m|spell=on|abbr=off|sp=us}}

===Inserted before units: ''4 planted acres''===
*<code><nowiki>{{convert|4|acre||adj=pre|planted}}</nowiki></code> → {{convert|4|acre||adj=pre|planted}}
<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|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-}}

===After adjective unit: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
:<code><nowiki>{{convert|10|ft|m|adj=mid|-long}}</nowiki></code> → {{convert|10|ft|m|adj=mid|-long}}

===Plurals: ''1 inch, 2 inches''===
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}}

;Exception:
Entering the unit spelled <code>|foot|</code> forces singular output "foot", whatever the number is.
* <code><nowiki>{{convert|100|foot|abbr=off}}</nowiki></code> → {{convert|100|foot|abbr=off}}

==Numbers==

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

To illustrate, these are trivial calculations (from meter to meter), showing the multiplication factor:
* {{convert|12|Gm|m|abbr=on}}
* {{convert|12|μm|m|abbr=on}}

The prefix can be added before the SI unit (here: unit <code>m</code> for meter):
* <code><nowiki>{{convert|12|Gm|mi|abbr=on}}</nowiki></code> → {{convert|12|Gm|mi|abbr=on}}
* <code>Mm</code>: {{convert|12|Mm|mi|abbr=on}}
* <code>km</code>: {{convert|12|km|ft|abbr=on}}
* <code>mm</code>: {{convert|12|mm|in|abbr=on}}
* <code>μm</code>: {{convert|12|μm|mm|abbr=on}}
* <code>um</code>: {{convert|12|um|mm|abbr=on}} (letter "u" can be used for "μ" here)

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

As an exception, the non-SI unit "inch" can have the "μ" prefix too)
* <code><nowiki>{{convert|12|μm|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}

{{further|Help:Convert units#SI prefixes}}

===Engineering notation: ''7 × 106 m''===

====In the unit: ''e6m''====
[[Engineering notation|Engineering number notations]] like ''7{{smallcaps|E}}6'' (for 7 × 106) can be entered as a "prefix" to the unit:
* <code><nowiki>{{convert|7|e6m}}</nowiki></code> → {{convert|7|e6m}}

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−14''===
In [[scientific notation]], a number is written like {{rnd|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}}

===Input with fractions: ''{{convert|1+1/2|in|mm|1}}''===
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}}

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 (do not require a calculation)

===Output with horizontal fraction bar in: ''{{sfrac|1|2}} inch''===

Using a double slash (<code>//</code>) returns a horizontal bar fraction:
* <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}}

===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}}
* <code><nowiki>{{convert|1 234 567|m|ft}}</nowiki></code> → {{convert|1 234 567|m|ft}} {{nay}}

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}} or {{para|comma|gaps5}} 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}}
* <code><nowiki>{{convert|1234|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234|m|ft|comma=gaps5}}
* <code><nowiki>{{convert|1234567|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps5}}
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]''===
Punctuation that distinguishes the two measurements is set by {{para|disp|}}. 
Options are: <code>b</code> (the default), <code>sqbr</code>, <code>comma</code>, <code>or</code>, <code>br</code>, <code>x{{!}}…</code>:
* <code><nowiki>{{convert|10|m|ft|disp=sqbr}}</nowiki></code> → {{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=or}}</nowiki></code> → {{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> </code>)
* <code><nowiki>{{convert|10|m|ft|disp=br}}</nowiki></code> → {{convert|10|m|ft|disp=br}}

Also {{para|disp|br()}} will force a new line, and keep the brackets:
* <code><nowiki>{{convert|10|m|ft|disp=br()}}</nowiki></code> → {{convert|10|m|ft|disp=br()}}

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_}}—(To display spaces, use <code>&nbsp;</code>)

===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:
* <code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> → {{convert|1|mi|m|order=flip|sigfig=5|abbr=off}}
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}}

=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
It is possible to display only parts of the conversion result:


{| class="wikitable"
! Convert !! Output !! Description
|-
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}}
| Default behaviour, for comparison
|-
| <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|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|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|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=out}}</nowiki></code> || {{convert|2|cuyd|m3|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
|}
===Display both input name and symbol: ''2 kilopascals [kPa]''===
Setting {{para|abbr|~}} returns both name and symbol of the first (input) unit:
* <code><nowiki>{{convert|2|kPa|psi|abbr=~}}</nowiki></code> → {{convert|2|kPa|psi|abbr=~}}
* <code><nowiki>A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure</nowiki></code> → {{nowrap|A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure}}

==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 showing numbers only===
Using {convert} in a table cell, with {{para|disp|table}} splits the result over two columns:
:<code><nowiki>{{convert|10|m|ft|disp=table}}</nowiki></code> → {{convert|10|m|ft|disp=table}}

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

The units are added as a column header:
:{| class=wikitable
! style="width:10em;" |  
! style="width:10em;" | m
! style="width:10em;" | ft
|-
| {{para|disp|table}}
| {{convert|10|m|ft|disp=table}}
|-
|{{para|disp|tablecen}}
| {{convert|20|m|ft|disp=tablecen}}
|-
|{{para|disp|<other>}} (default)
|{{convert|30|m|ft|disp=}}
|}

===Sorting===
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=700110000000000000010 metres (33&nbsp;ft)}}

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

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

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==
===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}}}}
<div style="height: 400px; overflow: auto; padding: 3px; border: 1px solid #aaa;">
{{Convert/list of units}}
</div>

==='per' units: ''kg/hl''===
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}}

===Units of difference===
When a number is the measurement for a ''difference'', one conversion is done. This may occur in temperatures (°C, °F, K). Compare this to a ''range'', when two conversions are done.

The only available units of difference are: {{para|C-change}}, {{para|F-change}} and {{para|K-change}}.
* {{#invoke:DemoTemplate|convert|10|C}}, regular temperature
* {{#invoke:DemoTemplate|convert|10|C-change}}, difference (e.g., "The temperature changed from 30 into 40 °C")
* {{#invoke:DemoTemplate|convert|10-15|C}}, range (e.g., "The temperature is between 10 and 15 °C")

Consistently, into multiple units:
* <code><nowiki>A rise of {{convert|10|C-change|F-change K-change}}</nowiki></code> → A rise of {{convert|10|C-change|F-change K-change}}

===Multiple units: ''1 ft 5 in''===
====In input====
Base document {{slink|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 {{slink|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


===Currency per unit: ''$/mi, €/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}}

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

==Parameter list==
{{convert/doc/parameter list}}

==Deprecated options==
{{Convert/doc/deprecations list}}

==TemplateData==
{{TemplateDataHeader}}

<templatedata>{
"description": "Converts measurements to other units.",
"params": {
"1": {
"label": "value",
"description": "the value to convert",
"type": "number"
},
"2": {
"label": "from unit",
"description": "",
"type": "string/line"
},
"3": {
"label": "to units",
"description": "the unit to convert into",
"type": "string/line"
},
"4": {
"label": "precision or suffix",
"description": "significant digits after decimal dot or, if negative, exponent of ten",
"type": "number"
},
"lk": {
"label": "link units",
"description": "“on” all, “in” input, “out” output or “off” no units",
"default": "off",
"type": "string/line"
},
"abbr": {
"label": "abbreviation",
"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",
"default": "out",
"type": "string/line"
},
"sp": {
"label": "spelling",
"description": "“us” display U.S. spelling of unit names",
"type": "string/line"
},
"adj": {
"label": "adjective",
"description": "adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end",
"type": "string/line"
},
"disp": {
"label": "conversion",
"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",
"default": "b",
"type": "string/line"
},
"order": {
"label": "ordering",
"description": "“flip” returns converted value first, input value second.",
"type": "string/line"
},
"sigfig": {
"label": "significant figures",
"description": "number that sets the number of significant figures",
"type": "number"
},
"round": {
"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",
"type": "string/line"
},
"comma": {
"label": "thousands separator",
"description": "Sets or suppresses thousand separator in the numbers. “off” = no separator; “gaps”: use space not comma; “5” and “gaps5”: only add separator when number > 5 positions (10,000 or more)",
"default": "on",
"type": "string/line"
},
"sortable": {
"label": "sort key",
"description": "“on” generates a hidden sort key",
"type": "string/line"
}
}}</templatedata>


==See also==
* {{Temp|Cvt}}
* {{Temp|SI units}}
{{Convert navs}}
<noinclude>
[[Category:Convert by module documentation| ]]
</noinclude><includeonly>
[[Category:Convert templates| ]]
[[Category:Conversion templates]]
[[Category:Numbers as words conversion templates]]
[[Category:Sorting templates]]
</includeonly>

Template:Convert/doc

2016-06-21T06:05:01Z

178.16.7.96:

{{documentation subpage}}
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk| {{formatnum:789000}}+ }}}}
{{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}}
'''Template {{tl|convert}}''' ''calculates'' measurements from one unit (you can enter) to another one, and then ''presents the results''. For example:
:<code><nowiki>{{convert|2|km|mi}}</nowiki></code> → {{convert|2|km|mi}}
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> → {{convert|7|mi|km}}

The available '''units''' are listed [[#Units|below]]. Units are case-sensitive always ({{xt|kW}}, ''not'' {{!xt|KW}} and ''not'' {{!xt|kw}}). Multiple '''formatting''' and calculation options are listed below.

{{hatnote|See [[Help:Convert]] for more complete information}}
{{hatnote|For currency conversion into US dollars, see [[Template:To USD]]}}

==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
By default, the first value shows unit name spelled out, the second the symbol (or abbreviation). Use {{para|abbr|on/off}} to change this behaviour:
* <code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}

To abbreviate both:
* <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}}

{{para|abbr|in}} is the reverse behaviour to the default, {{para|abbr|out}}:
*<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{convert|1|lb|kg|abbr=in}}

===Convenience: {{tlf|cvt}} has {{para|abbr|on}} by default===
Template {{tl|cvt}} is similar to {{tlf|convert}}, but 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 equal to:
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{cvt|1|lb|kg|abbr=on}}

==Adjective: ''a 10-mile distance''==
Use {{para|adj|on}} to produce the adjective form:
* <code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> → A {{convert|10|mi|km|adj=on}} distance.
Default behaviour, for comparison:
* <code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> → {{convert|10|mi|km}} to go.

This option does not work with {{para|abbr|on}}.

==Rounding: ''100 ft'' is ''30 m'' or ''30.5 m'' or ''30.48 m''?==
By definition, 100 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===
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 figures, whichever is more precise. An exception to this is ''rounding temperatures'' (see [[#Rounding temperatures|below]]).

{| class="wikitable"
|-
! colspan="3" | Examples of rounding
|-
|'''Input'''||'''Displays as'''||'''Note'''
|-
|<code><nowiki>{{convert|123|ft|m|-1}}</nowiki></code> || {{convert|123|ft|m|-1}} ||
|-
|<code><nowiki>{{convert|123|ft|m|0}}</nowiki></code> || {{convert|123|ft|m|0}} ||
|-
|<code><nowiki>{{convert|123|ft|m|1}}</nowiki></code> || {{convert|123|ft|m|1}} ||
|-
|<code><nowiki>{{convert|550|ft|m|0}}</nowiki></code> || {{convert|550|ft|m|0}} || Approximate value is 167.64 m
|-
|<code><nowiki>{{convert|550|ft|m}}</nowiki></code> || {{convert|550|ft|m}} || Rounds to 170, when approximate value is 167.64 m
|-
|<code><nowiki>{{convert|500|ft|m|0}}</nowiki></code> || {{convert|500|ft|m|0}} || Approximate value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|m}}</nowiki></code> || {{convert|500|ft|m}} || Rounds to 150, when approximate value is 152.4 m
|}

''Convert'' supports four types of rounding:

===Round to a given precision: ''use {{para|precision|}}''===
Specify the desired precision with the fourth unnamed parameter (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest 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: ''{{para|sigfig|}}''===
To specify the output number to be with ''n'' significant figures use {{para|sigfig|<number>}}:
* <code><nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki></code> → {{convert|1200|ft|m|sigfig=4}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=3}}</nowiki></code> → {{convert|1200|ft|m|sigfig=3}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=2}}</nowiki></code> → {{convert|1200|ft|m|sigfig=2}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki></code> → {{convert|1200|ft|m|sigfig=1}}
Default behaviour, for comparison:
* <code><nowiki>{{convert|1200|ft|m}}</nowiki></code> → {{convert|1200|ft|m}}
Setting {{para|sigfig|<=0}} is meaningless
* <code><nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki></code> → {{convert|1200|ft|m|sigfig=0}}

===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
Using {{para|round|5}} rounds the outcome to a multiple of 5.
* <code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
* <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.
* <code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
* <code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> → {{convert|10|m|ft|round=25}}
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}}:
* <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> → {{convert|10 x 200 x 3000|m|ft|round=each}}

===Round to a multiple of a given fraction: ''{{frac|2|3|16}} inch''===
Specify the desired ''denominator'' using {{para|frac|<some positive integer>}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|3}}).
* <code><nowiki>{{convert|5.56|cm|in|frac=16}}</nowiki></code> → {{convert|5.56|cm|in|frac=16}}
* <code><nowiki>{{convert|8|cm|in|frac=4}}</nowiki></code> → {{convert|8|cm|in|frac=4}}
The fraction is reduced when possible:
* <code><nowiki>{{convert|8|cm|in|frac=100}}</nowiki></code> → {{convert|8|cm|in|frac=100}}
Default behaviour, for comparison:
* <code><nowiki>{{convert|8|cm|in}}</nowiki></code> → {{convert|8|cm|in|sigfig=4}}

==={{anchor|Rounding temperatures}}In temperatures: rounding ''°C'', ''°F'' and ''K''===
In temperatures, the conversion will be rounded either to precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.

#{{#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|-300|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}}

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 into five significant output digits because of the two numbers 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.

==Into multiple units: ''{{convert|10|C|F K}}''==
Separate the multiple output units by a space:
* <code><nowiki>{{convert|10|C|F K}}</nowiki></code> → {{convert|10|C|F K}}
* <code><nowiki>{{convert|5|km|mi nmi}}</nowiki></code> → {{convert|5|km|mi nmi}}
If the output unit names contain spaces, use a '+' separator.

See also:
* For multiple-unit options like ''1 ft 5 in'', see [[#In input]] and [[#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: 
{{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}}

In science, the formal way is to set <code>|x|</code> and {{para|abbr|on}} (keeping dimensions right, like in ''area = x km2''):
* <code><nowiki>{{convert|6|x|12|m|ft|abbr=on}}</nowiki></code> → {{convert|6|x|12|m|ft|abbr=on}}

===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:
* <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}}
Default behaviour, for comparison:
* <code><nowiki>{{convert|1|ft|3|in|mm}}</nowiki></code> → {{convert|1|ft|3|in|mm}}

==Words==
===Spelling of unit name: UK ''metre'' or US ''meter''?===
Default spelling of units is en-UK. 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}}

===Spell out numbers: ''ten miles''===
To write a number in words, use {{para|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}}:
* <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}}
* <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> → {{convert|10|mi|m|spell=On}}

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> → {{convert|10|mi|m|spell=on|abbr=off|sp=us}}

===Inserted before units: ''4 planted acres''===
*<code><nowiki>{{convert|4|acre||adj=pre|planted}}</nowiki></code> → {{convert|4|acre||adj=pre|planted}}
<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|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-}}

===After adjective unit: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
:<code><nowiki>{{convert|10|ft|m|adj=mid|-long}}</nowiki></code> → {{convert|10|ft|m|adj=mid|-long}}

===Plurals: ''1 inch, 2 inches''===
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}}

;Exception:
Entering the unit spelled <code>|foot|</code> forces singular output "foot", whatever the number is.
* <code><nowiki>{{convert|100|foot|abbr=off}}</nowiki></code> → {{convert|100|foot|abbr=off}}

==Numbers==

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

To illustrate, these are trivial calculations (from meter to meter), showing the multiplication factor:
* {{convert|12|Gm|m|abbr=on}}
* {{convert|12|μm|m|abbr=on}}

The prefix can be added before the SI unit (here: unit <code>m</code> for meter):
* <code><nowiki>{{convert|12|Gm|mi|abbr=on}}</nowiki></code> → {{convert|12|Gm|mi|abbr=on}}
* <code>Mm</code>: {{convert|12|Mm|mi|abbr=on}}
* <code>km</code>: {{convert|12|km|ft|abbr=on}}
* <code>mm</code>: {{convert|12|mm|in|abbr=on}}
* <code>μm</code>: {{convert|12|μm|mm|abbr=on}}
* <code>um</code>: {{convert|12|um|mm|abbr=on}} (letter "u" can be used for "μ" here)

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

As an exception, the non-SI unit "inch" can have the "μ" prefix too)
* <code><nowiki>{{convert|12|μm|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}

{{further|Help:Convert units#SI prefixes}}

===Engineering notation: ''7 × 106 m''===

====In the unit: ''e6m''====
[[Engineering notation|Engineering number notations]] like ''7{{smallcaps|E}}6'' (for 7 × 106) can be entered as a "prefix" to the unit:
* <code><nowiki>{{convert|7|e6m}}</nowiki></code> → {{convert|7|e6m}}

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−14''===
In [[scientific notation]], a number is written like {{rnd|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}}

===Input with fractions: ''{{convert|1+1/2|in|mm|1}}''===
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}}

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 (do not require a calculation)

===Output with horizontal fraction bar in: ''{{sfrac|1|2}} inch''===

Using a double slash (<code>//</code>) returns a horizontal bar fraction:
* <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}}

===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}}
* <code><nowiki>{{convert|1 234 567|m|ft}}</nowiki></code> → {{convert|1 234 567|m|ft}} {{nay}}

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}} or {{para|comma|gaps5}} 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}}
* <code><nowiki>{{convert|1234|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234|m|ft|comma=gaps5}}
* <code><nowiki>{{convert|1234567|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps5}}
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]''===
Punctuation that distinguishes the two measurements is set by {{para|disp|}}. 
Options are: <code>b</code> (the default), <code>sqbr</code>, <code>comma</code>, <code>or</code>, <code>br</code>, <code>x{{!}}…</code>:
* <code><nowiki>{{convert|10|m|ft|disp=sqbr}}</nowiki></code> → {{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=or}}</nowiki></code> → {{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> </code>)
* <code><nowiki>{{convert|10|m|ft|disp=br}}</nowiki></code> → {{convert|10|m|ft|disp=br}}

Also {{para|disp|br()}} will force a new line, and keep the brackets:
* <code><nowiki>{{convert|10|m|ft|disp=br()}}</nowiki></code> → {{convert|10|m|ft|disp=br()}}

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_}}—(To display spaces, use <code>&nbsp;</code>)

===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:
* <code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> → {{convert|1|mi|m|order=flip|sigfig=5|abbr=off}}
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}}

=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
It is possible to display only parts of the conversion result:


{| class="wikitable"
! Convert !! Output !! Description
|-
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}}
| Default behaviour, for comparison
|-
| <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|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|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|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=out}}</nowiki></code> || {{convert|2|cuyd|m3|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
|}
===Display both input name and symbol: ''2 kilopascals [kPa]''===
Setting {{para|abbr|~}} returns both name and symbol of the first (input) unit:
* <code><nowiki>{{convert|2|kPa|psi|abbr=~}}</nowiki></code> → {{convert|2|kPa|psi|abbr=~}}
* <code><nowiki>A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure</nowiki></code> → {{nowrap|A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure}}

==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 showing numbers only===
Using {convert} in a table cell, with {{para|disp|table}} splits the result over two columns:
:<code><nowiki>{{convert|10|m|ft|disp=table}}</nowiki></code> → {{convert|10|m|ft|disp=table}}

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

The units are added as a column header:
:{| class=wikitable
! style="width:10em;" |  
! style="width:10em;" | m
! style="width:10em;" | ft
|-
| {{para|disp|table}}
| {{convert|10|m|ft|disp=table}}
|-
|{{para|disp|tablecen}}
| {{convert|20|m|ft|disp=tablecen}}
|-
|{{para|disp|<other>}} (default)
|{{convert|30|m|ft|disp=}}
|}

===Sorting===
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=700110000000000000010 metres (33&nbsp;ft)}}

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

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

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==
===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}}}}
<div style="height: 400px; overflow: auto; padding: 3px; border: 1px solid #aaa;">
{{Convert/list of units}}
</div>

==='per' units: ''kg/hl''===
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}}

===Units of difference===
When a number is the measurement for a ''difference'', one conversion is done. This may occur in temperatures (°C, °F, K). Compare this to a ''range'', when two conversions are done.

The only available units of difference are: {{para|C-change}}, {{para|F-change}} and {{para|K-change}}.
* {{#invoke:DemoTemplate|convert|10|C}}, regular temperature
* {{#invoke:DemoTemplate|convert|10|C-change}}, difference (e.g., "The temperature changed from 30 into 40 °C")
* {{#invoke:DemoTemplate|convert|10-15|C}}, range (e.g., "The temperature is between 10 and 15 °C")

Consistently, into multiple units:
* <code><nowiki>A rise of {{convert|10|C-change|F-change K-change}}</nowiki></code> → A rise of {{convert|10|C-change|F-change K-change}}

===Multiple units: ''1 ft 5 in''===
====In input====
Base document {{slink|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 {{slink|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


===Currency per unit: ''$/mi, €/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}}

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

==Parameter list==
{{convert/doc/parameter list}}

==Deprecated options==
{{Convert/doc/deprecations list}}

==TemplateData==
{{TemplateDataHeader}}

<templatedata>{
"description": "Converts measurements to other units.",
"params": {
"1": {
"label": "value",
"description": "the value to convert",
"type": "number"
},
"2": {
"label": "from unit",
"description": "",
"type": "string/line"
},
"3": {
"label": "to units",
"description": "the unit to convert into",
"type": "string/line"
},
"4": {
"label": "precision or suffix",
"description": "significant digits after decimal dot or, if negative, exponent of ten",
"type": "number"
},
"lk": {
"label": "link units",
"description": "“on” all, “in” input, “out” output or “off” no units",
"default": "off",
"type": "string/line"
},
"abbr": {
"label": "abbreviation",
"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",
"default": "out",
"type": "string/line"
},
"sp": {
"label": "spelling",
"description": "“us” display U.S. spelling of unit names",
"type": "string/line"
},
"adj": {
"label": "adjective",
"description": "adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end",
"type": "string/line"
},
"disp": {
"label": "conversion",
"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",
"default": "b",
"type": "string/line"
},
"order": {
"label": "ordering",
"description": "“flip” returns converted value first, input value second.",
"type": "string/line"
},
"sigfig": {
"label": "significant figures",
"description": "number that sets the number of significant figures",
"type": "number"
},
"round": {
"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",
"type": "string/line"
},
"comma": {
"label": "thousands separator",
"description": "Sets or suppresses thousand separator in the numbers. “off” = no separator; “gaps”: use space not comma; “5” and “gaps5”: only add separator when number > 5 positions (10,000 or more)",
"default": "on",
"type": "string/line"
},
"sortable": {
"label": "sort key",
"description": "“on” generates a hidden sort key",
"type": "string/line"
}
}}</templatedata>


==See also==
* {{Temp|Cvt}}
* {{Temp|SI units}}
{{Convert navs}}
<noinclude>
[[Category:Convert by module documentation| ]]
</noinclude><includeonly>
[[Category:Convert templates| ]]
[[Category:Conversion templates]]
[[Category:Numbers as words conversion templates]]
[[Category:Sorting templates]]
</includeonly>

Template:Convert/doc

2016-06-21T00:25:23Z

178.16.7.96: /* Multiple dimensions: {{convert|6|x|12|m|ft|abbr=on}} */

{{documentation subpage}}
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk| {{formatnum:789000}}+ }}}}
{{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}}
'''Template {{tl|convert}}''' ''calculates'' measurements from one unit (you can enter) to another one, and then ''presents the results''. For example:
:<code><nowiki>{{convert|2|km|mi}}</nowiki></code> → {{convert|2|km|mi}}
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> → {{convert|7|mi|km}}

The available '''units''' are listed [[#Units|below]]. Units are case-sensitive always ({{xt|kW}}, ''not'' {{!xt|KW}} and ''not'' {{!xt|kw}}). Multiple '''formatting''' and calculation options are listed below.

{{hatnote|See [[Help:Convert]] for more complete information}}
{{hatnote|For currency conversion into US dollars, see [[Template:To USD]]}}

==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
By default, the first value shows unit name spelled out, the second the symbol (or abbreviation). Use {{para|abbr|on/off}} to change this behaviour:
* <code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}

To abbreviate both:
* <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}}

{{para|abbr|in}} is the reverse behaviour to the default, {{para|abbr|out}}:
*<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{convert|1|lb|kg|abbr=in}}

===Convenience: {{tlf|cvt}} has {{para|abbr|on}} by default===
Template {{tl|cvt}} is similar to {{tlf|convert}}, but 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 equal to:
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{cvt|1|lb|kg|abbr=on}}

==Adjective: ''a 10-mile distance''==
Use {{para|adj|on}} to produce the adjective form. The difference:
:<code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> → {{convert|10|mi|km}} to go. ''(To compare, default)''
:<code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> → A {{convert|10|mi|km|adj=on}} distance. ''(Adjective form)''
This option does not work with {{para|abbr|on}}.

==Rounding: ''100 ft'' is ''30 m'' or ''30.5 m'' or ''30.48 m''?==
By definition, 100 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===
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 figures, whichever is more precise. An exception to this is ''rounding temperatures'' (see [[#Rounding temperatures|below]]).

{| class="wikitable"
|-
! colspan="3" | Examples of rounding
|-
|'''Input'''||'''Displays as'''||'''Note'''
|-
|<code><nowiki>{{convert|123|ft|m|-1}}</nowiki></code> || {{convert|123|ft|m|-1}} ||
|-
|<code><nowiki>{{convert|123|ft|m|0}}</nowiki></code> || {{convert|123|ft|m|0}} ||
|-
|<code><nowiki>{{convert|123|ft|m|1}}</nowiki></code> || {{convert|123|ft|m|1}} ||
|-
|<code><nowiki>{{convert|550|ft|m|0}}</nowiki></code> || {{convert|550|ft|m|0}} || Approximate value is 167.64 m
|-
|<code><nowiki>{{convert|550|ft|m}}</nowiki></code> || {{convert|550|ft|m}} || Rounds to 170, when approximate value is 167.64 m
|-
|<code><nowiki>{{convert|500|ft|m|0}}</nowiki></code> || {{convert|500|ft|m|0}} || Approximate value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|m}}</nowiki></code> || {{convert|500|ft|m}} || Rounds to 150, when approximate value is 152.4 m
|}

''Convert'' supports four types of rounding:

===Round to a given precision: ''use {{para|precision|}}''===
Specify the desired precision with the fourth unnamed parameter (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest 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: ''{{para|sigfig|}}''===
To specify the output number to be with ''n'' significant figures use {{para|sigfig|<number>}}:
* To compare: <code><nowiki>{{convert|1200|ft|m}}</nowiki></code> → {{convert|1200|ft|m}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki></code> → {{convert|1200|ft|m|sigfig=4}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=3}}</nowiki></code> → {{convert|1200|ft|m|sigfig=3}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=2}}</nowiki></code> → {{convert|1200|ft|m|sigfig=2}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki></code> → {{convert|1200|ft|m|sigfig=1}}
Setting {{para|sigfig|<=0}} is meaningless
* <code><nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki></code> → {{convert|1200|ft|m|sigfig=0}}

===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
Using {{para|round|5}} rounds the outcome to a multiple of 5.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<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.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> → {{convert|10|m|ft|round=25}}
:To compare: <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}}:
:<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> → {{convert|10 x 200 x 3000|m|ft|round=each}}

===Round to a multiple of a given fraction: ''{{frac|2|3|16}} inch''===
Specify the desired ''denominator'' using {{para|frac|<some positive integer>}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|3}}).
:<code><nowiki>{{convert|5.56|cm|in|frac=16}}</nowiki></code> → {{convert|5.56|cm|in|frac=16}}
:<code><nowiki>{{convert|8|cm|in|frac=4}}</nowiki></code> → {{convert|8|cm|in|frac=4}}
The fraction is reduced when possible:
:<code><nowiki>{{convert|8|cm|in|frac=100}}</nowiki></code> → {{convert|8|cm|in|frac=100}}
:<code><nowiki>{{convert|8|cm|in}}</nowiki></code> → {{convert|8|cm|in|sigfig=4}} (To compare)

==={{anchor|Rounding temperatures}}In temperatures: rounding ''°C'', ''°F'' and ''K''===
In temperatures, the conversion will be rounded either to precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.

#{{#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|-300|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}}

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 into five significant output digits because of the two numbers 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.

==Into multiple units: ''{{convert|10|C|F K}}''==
Separate the multiple output units by a space:
* <code><nowiki>{{convert|10|C|F K}}</nowiki></code> → {{convert|10|C|F K}}
* <code><nowiki>{{convert|5|km|mi nmi}}</nowiki></code> → {{convert|5|km|mi nmi}}
If the output unit names contain spaces, use a '+' separator.

See also:
* For multiple-unit options like ''1 ft 5 in'', see [[#In input]] and [[#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: 
{{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}}

In science, the formal way is to set <code>|x|</code> and {{para|abbr|on}} (keeping dimensions right, like in ''area = x km2''):
* <code><nowiki>{{convert|6|x|12|m|ft|abbr=on}}</nowiki></code> → {{convert|6|x|12|m|ft|abbr=on}}

===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:
* <code><nowiki>{{convert|1|ft|3|in|mm}}</nowiki></code> → {{convert|1|ft|3|in|mm}} (to compare)
* <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}}

==Words==
===Spelling of unit name: UK ''metre'' or US ''meter''?===
Default spelling of units is en-UK. 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}}

===Spell out numbers: ''ten miles''===
To write a number in words, use {{para|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}}:
* <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}}
* <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> → {{convert|10|mi|m|spell=On}}

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> → {{convert|10|mi|m|spell=on|abbr=off|sp=us}}

===Inserted before units: ''4 planted acres''===
*<code><nowiki>{{convert|4|acre||adj=pre|planted}}</nowiki></code> → {{convert|4|acre||adj=pre|planted}}
<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|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-}}

===After adjective unit: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
:<code><nowiki>{{convert|10|ft|m|adj=mid|-long}}</nowiki></code> → {{convert|10|ft|m|adj=mid|-long}}

===Plurals: ''1 inch, 2 inches''===
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}}

;Exception:
Entering the unit spelled <code>|foot|</code> forces singular output "foot", whatever the number is.
* <code><nowiki>{{convert|100|foot|abbr=off}}</nowiki></code> → {{convert|100|foot|abbr=off}}

==Numbers==

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

To illustrate, these are trivial calculations (from meter to meter), showing the multiplication factor:
* {{convert|12|Gm|m|abbr=on}}
* {{convert|12|μm|m|abbr=on}}

The prefix can be added before the SI unit (here: unit <code>m</code> for meter):
* <code><nowiki>{{convert|12|Gm|mi|abbr=on}}</nowiki></code> → {{convert|12|Gm|mi|abbr=on}}
* <code>Mm</code>: {{convert|12|Mm|mi|abbr=on}}
* <code>km</code>: {{convert|12|km|ft|abbr=on}}
* <code>mm</code>: {{convert|12|mm|in|abbr=on}}
* <code>μm</code>: {{convert|12|μm|mm|abbr=on}}
* <code>um</code>: {{convert|12|um|mm|abbr=on}} (letter "u" can be used for "μ" here)

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

As an exception, the non-SI unit "inch" can have the "μ" prefix too)
* <code><nowiki>{{convert|12|μm|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}

{{further|Help:Convert units#SI prefixes}}

===Engineering notation: ''7 × 106 m''===

====In the unit: ''e6m''====
[[Engineering notation|Engineering number notations]] like ''7{{smallcaps|E}}6'' (for 7 × 106) can be entered as a "prefix" to the unit:
* <code><nowiki>{{convert|7|e6m}}</nowiki></code> → {{convert|7|e6m}}

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−14''===
In [[scientific notation]], a number is written like {{rnd|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}}

===Input with fractions: ''{{convert|1+1/2|in|mm|1}}''===
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}}

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 (do not require a calculation)

===Output with horizontal fraction bar in: ''{{sfrac|1|2}} inch''===

Using a double slash (<code>//</code>) returns a horizontal bar fraction:
* <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}}

===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}}
*<code><nowiki>{{convert|1 234 567|m|ft}}</nowiki></code> → {{convert|1 234 567|m|ft}} {{nay}}

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}}</nowiki></code> → {{convert|1234567|m|ft}} (To compare, default)
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps}}

Setting {{para|comma|5}} or {{para|comma|gaps5}} will only add the separator when the number of digits is 5 or more:
*<code><nowiki>{{convert|1234|m|ft}}</nowiki></code> → {{convert|1234|m|ft}} (To compare, default)
*<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}}
*<code><nowiki>{{convert|1234|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234|m|ft|comma=gaps5}}
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps5}}

==Output manipulation==
===Brackets and separators: ''10 m [33 ft]''===
Punctuation that distinguishes the two measurements is set by {{para|disp|}}. 
Options are: <code>b</code> (the default), <code>sqbr</code>, <code>comma</code>, <code>or</code>, <code>br</code>, <code>x{{!}}…</code>:
* <code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}—''( ) 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=comma}}</nowiki></code> → {{convert|10|m|ft|disp=comma}}
* <code><nowiki>{{convert|10|m|ft|disp=or}}</nowiki></code> → {{convert|10|m|ft|disp=or}}

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

Also {{para|disp|br()}} will force a new line, and keep the brackets:
* <code><nowiki>{{convert|10|m|ft|disp=br()}}</nowiki></code> → {{convert|10|m|ft|disp=br()}}

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_}}—(To display spaces, use <code>&nbsp;</code>)

===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:
* <code><nowiki>{{convert|1|mi|m}}</nowiki></code> → {{convert|1|mi|m|sigfig=5|abbr=off}} (To compare, default)
* <code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> → {{convert|1|mi|m|order=flip|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}}

=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
It is possible to display only parts of the conversion result:


{| class="wikitable"
! Convert !! Output !! Description
|-
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}}
| Default, to compare
|-
| <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|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|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|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=out}}</nowiki></code> || {{convert|2|cuyd|m3|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
|}
===Display both input name and symbol: ''2 kilopascals [kPa]''===
Setting {{para|abbr|~}} returns both name and symbol of the first (input) unit:
* <code><nowiki>{{convert|2|kPa|psi|abbr=~}}</nowiki></code> → {{convert|2|kPa|psi|abbr=~}}
* <code><nowiki>A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure</nowiki></code> → {{nowrap|A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure}}

==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 showing numbers only===
Using {convert} in a table cell, with {{para|disp|table}} splits the result over two columns:
:<code><nowiki>{{convert|10|m|ft|disp=table}}</nowiki></code> → {{convert|10|m|ft|disp=table}}

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

The units are added as a column header:
:{| class=wikitable
! style="width:10em;" |  
! style="width:10em;" | m
! style="width:10em;" | ft
|-
| {{para|disp|table}}
| {{convert|10|m|ft|disp=table}}
|-
|{{para|disp|tablecen}}
| {{convert|20|m|ft|disp=tablecen}}
|-
|{{para|disp|<other>}} (default)
|{{convert|30|m|ft|disp=}}
|}

===Sorting===
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=700110000000000000010 metres (33&nbsp;ft)}}

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

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

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==
===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}}}}
<div style="height: 400px; overflow: auto; padding: 3px; border: 1px solid #aaa;">
{{Convert/list of units}}
</div>

==='per' units: ''kg/hl''===
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}}

===Units of difference===
When a number is the measurement for a ''difference'', one conversion is done. This may occur in temperatures (°C, °F, K). Compare this to a ''range'', when two conversions are done.

The only available units of difference are: {{para|C-change}}, {{para|F-change}} and {{para|K-change}}.
* {{#invoke:DemoTemplate|convert|10|C}}, regular temperature
* {{#invoke:DemoTemplate|convert|10|C-change}}, difference (e.g., "The temperature changed from 30 into 40 °C")
* {{#invoke:DemoTemplate|convert|10-15|C}}, range (e.g., "The temperature is between 10 and 15 °C")

Consistently, into multiple units:
* <code><nowiki>A rise of {{convert|10|C-change|F-change K-change}}</nowiki></code> → A rise of {{convert|10|C-change|F-change K-change}}

===Multiple units: ''1 ft 5 in''===
====In input====
Base document {{slink|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 {{slink|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
* <code><nowiki>{{convert|2|m}}</nowiki></code> → {{convert|2|m}}—the default

See also:
* {{tl|hands}} a length used to measure horses
* {{tl|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:
* <code><nowiki>{{convert|10|$/mi|$/km}}</nowiki></code> → {{convert|10|$/mi|$/km}}

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

==Parameter list==
{{convert/doc/parameter list}}

==Deprecated options==
{{Convert/doc/deprecations list}}

==TemplateData==
{{TemplateDataHeader}}

<templatedata>{
"description": "Converts measurements to other units.",
"params": {
"1": {
"label": "value",
"description": "the value to convert",
"type": "number"
},
"2": {
"label": "from unit",
"description": "",
"type": "string/line"
},
"3": {
"label": "to units",
"description": "the unit to convert into",
"type": "string/line"
},
"4": {
"label": "precision or suffix",
"description": "significant digits after decimal dot or, if negative, exponent of ten",
"type": "number"
},
"lk": {
"label": "link units",
"description": "“on” all, “in” input, “out” output or “off” no units",
"default": "off",
"type": "string/line"
},
"abbr": {
"label": "abbreviation",
"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",
"default": "out",
"type": "string/line"
},
"sp": {
"label": "spelling",
"description": "“us” display U.S. spelling of unit names",
"type": "string/line"
},
"adj": {
"label": "adjective",
"description": "adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end",
"type": "string/line"
},
"disp": {
"label": "conversion",
"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",
"default": "b",
"type": "string/line"
},
"order": {
"label": "ordering",
"description": "“flip” returns converted value first, input value second.",
"type": "string/line"
},
"sigfig": {
"label": "significant figures",
"description": "number that sets the number of significant figures",
"type": "number"
},
"round": {
"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",
"type": "string/line"
},
"comma": {
"label": "thousands separator",
"description": "Sets or suppresses thousand separator in the numbers. “off” = no separator; “gaps”: use space not comma; “5” and “gaps5”: only add separator when number > 5 positions (10,000 or more)",
"default": "on",
"type": "string/line"
},
"sortable": {
"label": "sort key",
"description": "“on” generates a hidden sort key",
"type": "string/line"
}
}}</templatedata>


==See also==
* {{Temp|Cvt}}
* {{Temp|SI units}}
{{Convert navs}}
<noinclude>
[[Category:Convert by module documentation| ]]
</noinclude><includeonly>
[[Category:Convert templates| ]]
[[Category:Conversion templates]]
[[Category:Numbers as words conversion templates]]
[[Category:Sorting templates]]
</includeonly>

Template:Convert/doc

2016-06-21T00:21:23Z

178.16.7.96: /* Units of difference */

{{documentation subpage}}
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk| {{formatnum:789000}}+ }}}}
{{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}}
'''Template {{tl|convert}}''' ''calculates'' measurements from one unit (you can enter) to another one, and then ''presents the results''. For example:
:<code><nowiki>{{convert|2|km|mi}}</nowiki></code> → {{convert|2|km|mi}}
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> → {{convert|7|mi|km}}

The available '''units''' are listed [[#Units|below]]. Units are case-sensitive always ({{xt|kW}}, ''not'' {{!xt|KW}} and ''not'' {{!xt|kw}}). Multiple '''formatting''' and calculation options are listed below.

{{hatnote|See [[Help:Convert]] for more complete information}}
{{hatnote|For currency conversion into US dollars, see [[Template:To USD]]}}

==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
By default, the first value shows unit name spelled out, the second the symbol (or abbreviation). Use {{para|abbr|on/off}} to change this behaviour:
* <code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}

To abbreviate both:
* <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}}

{{para|abbr|in}} is the reverse behaviour to the default, {{para|abbr|out}}:
*<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{convert|1|lb|kg|abbr=in}}

===Convenience: {{tlf|cvt}} has {{para|abbr|on}} by default===
Template {{tl|cvt}} is similar to {{tlf|convert}}, but 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 equal to:
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{cvt|1|lb|kg|abbr=on}}

==Adjective: ''a 10-mile distance''==
Use {{para|adj|on}} to produce the adjective form. The difference:
:<code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> → {{convert|10|mi|km}} to go. ''(To compare, default)''
:<code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> → A {{convert|10|mi|km|adj=on}} distance. ''(Adjective form)''
This option does not work with {{para|abbr|on}}.

==Rounding: ''100 ft'' is ''30 m'' or ''30.5 m'' or ''30.48 m''?==
By definition, 100 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===
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 figures, whichever is more precise. An exception to this is ''rounding temperatures'' (see [[#Rounding temperatures|below]]).

{| class="wikitable"
|-
! colspan="3" | Examples of rounding
|-
|'''Input'''||'''Displays as'''||'''Note'''
|-
|<code><nowiki>{{convert|123|ft|m|-1}}</nowiki></code> || {{convert|123|ft|m|-1}} ||
|-
|<code><nowiki>{{convert|123|ft|m|0}}</nowiki></code> || {{convert|123|ft|m|0}} ||
|-
|<code><nowiki>{{convert|123|ft|m|1}}</nowiki></code> || {{convert|123|ft|m|1}} ||
|-
|<code><nowiki>{{convert|550|ft|m|0}}</nowiki></code> || {{convert|550|ft|m|0}} || Approximate value is 167.64 m
|-
|<code><nowiki>{{convert|550|ft|m}}</nowiki></code> || {{convert|550|ft|m}} || Rounds to 170, when approximate value is 167.64 m
|-
|<code><nowiki>{{convert|500|ft|m|0}}</nowiki></code> || {{convert|500|ft|m|0}} || Approximate value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|m}}</nowiki></code> || {{convert|500|ft|m}} || Rounds to 150, when approximate value is 152.4 m
|}

''Convert'' supports four types of rounding:

===Round to a given precision: ''use {{para|precision|}}''===
Specify the desired precision with the fourth unnamed parameter (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest 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: ''{{para|sigfig|}}''===
To specify the output number to be with ''n'' significant figures use {{para|sigfig|<number>}}:
* To compare: <code><nowiki>{{convert|1200|ft|m}}</nowiki></code> → {{convert|1200|ft|m}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki></code> → {{convert|1200|ft|m|sigfig=4}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=3}}</nowiki></code> → {{convert|1200|ft|m|sigfig=3}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=2}}</nowiki></code> → {{convert|1200|ft|m|sigfig=2}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki></code> → {{convert|1200|ft|m|sigfig=1}}
Setting {{para|sigfig|<=0}} is meaningless
* <code><nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki></code> → {{convert|1200|ft|m|sigfig=0}}

===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
Using {{para|round|5}} rounds the outcome to a multiple of 5.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<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.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> → {{convert|10|m|ft|round=25}}
:To compare: <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}}:
:<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> → {{convert|10 x 200 x 3000|m|ft|round=each}}

===Round to a multiple of a given fraction: ''{{frac|2|3|16}} inch''===
Specify the desired ''denominator'' using {{para|frac|<some positive integer>}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|3}}).
:<code><nowiki>{{convert|5.56|cm|in|frac=16}}</nowiki></code> → {{convert|5.56|cm|in|frac=16}}
:<code><nowiki>{{convert|8|cm|in|frac=4}}</nowiki></code> → {{convert|8|cm|in|frac=4}}
The fraction is reduced when possible:
:<code><nowiki>{{convert|8|cm|in|frac=100}}</nowiki></code> → {{convert|8|cm|in|frac=100}}
:<code><nowiki>{{convert|8|cm|in}}</nowiki></code> → {{convert|8|cm|in|sigfig=4}} (To compare)

==={{anchor|Rounding temperatures}}In temperatures: rounding ''°C'', ''°F'' and ''K''===
In temperatures, the conversion will be rounded either to precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.

#{{#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|-300|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}}

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 into five significant output digits because of the two numbers 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.

==Into multiple units: ''{{convert|10|C|F K}}''==
Separate the multiple output units by a space:
* <code><nowiki>{{convert|10|C|F K}}</nowiki></code> → {{convert|10|C|F K}}
* <code><nowiki>{{convert|5|km|mi nmi}}</nowiki></code> → {{convert|5|km|mi nmi}}
If the output unit names contain spaces, use a '+' separator.

See also:
* For multiple-unit options like ''1 ft 5 in'', see [[#In input]] and [[#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: 
{{Convert/doc/range separator list}}

===Multiple dimensions: ''{{convert|6|x|12|m|ft|abbr=on}}''===
Use "by":
* <code><nowiki>{{convert|6|by|12|ft|m}}</nowiki></code> → {{convert|6|by|12|ft|m}}

Use "×", multiplication sign, or "x", letter:
* <code><nowiki>{{convert|6|x|12|m|ft}}</nowiki></code> → {{convert|6|x|12|m|ft}}

In science, the formal way is to set <code>|x|</code> and {{para|abbr|on}} (keeping dimensions right, like in ''area = x km2''):
* <code><nowiki>{{convert|6|x|12|m|ft|abbr=on}}</nowiki></code> → {{convert|6|x|12|m|ft|abbr=on}}

===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:
* <code><nowiki>{{convert|1|ft|3|in|mm}}</nowiki></code> → {{convert|1|ft|3|in|mm}} (to compare)
* <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}}

==Words==
===Spelling of unit name: UK ''metre'' or US ''meter''?===
Default spelling of units is en-UK. 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}}

===Spell out numbers: ''ten miles''===
To write a number in words, use {{para|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}}:
* <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}}
* <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> → {{convert|10|mi|m|spell=On}}

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> → {{convert|10|mi|m|spell=on|abbr=off|sp=us}}

===Inserted before units: ''4 planted acres''===
*<code><nowiki>{{convert|4|acre||adj=pre|planted}}</nowiki></code> → {{convert|4|acre||adj=pre|planted}}
<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|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-}}

===After adjective unit: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
:<code><nowiki>{{convert|10|ft|m|adj=mid|-long}}</nowiki></code> → {{convert|10|ft|m|adj=mid|-long}}

===Plurals: ''1 inch, 2 inches''===
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}}

;Exception:
Entering the unit spelled <code>|foot|</code> forces singular output "foot", whatever the number is.
* <code><nowiki>{{convert|100|foot|abbr=off}}</nowiki></code> → {{convert|100|foot|abbr=off}}

==Numbers==

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

To illustrate, these are trivial calculations (from meter to meter), showing the multiplication factor:
* {{convert|12|Gm|m|abbr=on}}
* {{convert|12|μm|m|abbr=on}}

The prefix can be added before the SI unit (here: unit <code>m</code> for meter):
* <code><nowiki>{{convert|12|Gm|mi|abbr=on}}</nowiki></code> → {{convert|12|Gm|mi|abbr=on}}
* <code>Mm</code>: {{convert|12|Mm|mi|abbr=on}}
* <code>km</code>: {{convert|12|km|ft|abbr=on}}
* <code>mm</code>: {{convert|12|mm|in|abbr=on}}
* <code>μm</code>: {{convert|12|μm|mm|abbr=on}}
* <code>um</code>: {{convert|12|um|mm|abbr=on}} (letter "u" can be used for "μ" here)

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

As an exception, the non-SI unit "inch" can have the "μ" prefix too)
* <code><nowiki>{{convert|12|μm|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}

{{further|Help:Convert units#SI prefixes}}

===Engineering notation: ''7 × 106 m''===

====In the unit: ''e6m''====
[[Engineering notation|Engineering number notations]] like ''7{{smallcaps|E}}6'' (for 7 × 106) can be entered as a "prefix" to the unit:
* <code><nowiki>{{convert|7|e6m}}</nowiki></code> → {{convert|7|e6m}}

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−14''===
In [[scientific notation]], a number is written like {{rnd|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}}

===Input with fractions: ''{{convert|1+1/2|in|mm|1}}''===
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}}

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 (do not require a calculation)

===Output with horizontal fraction bar in: ''{{sfrac|1|2}} inch''===

Using a double slash (<code>//</code>) returns a horizontal bar fraction:
* <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}}

===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}}
*<code><nowiki>{{convert|1 234 567|m|ft}}</nowiki></code> → {{convert|1 234 567|m|ft}} {{nay}}

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}}</nowiki></code> → {{convert|1234567|m|ft}} (To compare, default)
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps}}

Setting {{para|comma|5}} or {{para|comma|gaps5}} will only add the separator when the number of digits is 5 or more:
*<code><nowiki>{{convert|1234|m|ft}}</nowiki></code> → {{convert|1234|m|ft}} (To compare, default)
*<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}}
*<code><nowiki>{{convert|1234|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234|m|ft|comma=gaps5}}
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps5}}

==Output manipulation==
===Brackets and separators: ''10 m [33 ft]''===
Punctuation that distinguishes the two measurements is set by {{para|disp|}}. 
Options are: <code>b</code> (the default), <code>sqbr</code>, <code>comma</code>, <code>or</code>, <code>br</code>, <code>x{{!}}…</code>:
* <code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}—''( ) 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=comma}}</nowiki></code> → {{convert|10|m|ft|disp=comma}}
* <code><nowiki>{{convert|10|m|ft|disp=or}}</nowiki></code> → {{convert|10|m|ft|disp=or}}

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

Also {{para|disp|br()}} will force a new line, and keep the brackets:
* <code><nowiki>{{convert|10|m|ft|disp=br()}}</nowiki></code> → {{convert|10|m|ft|disp=br()}}

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_}}—(To display spaces, use <code>&nbsp;</code>)

===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:
* <code><nowiki>{{convert|1|mi|m}}</nowiki></code> → {{convert|1|mi|m|sigfig=5|abbr=off}} (To compare, default)
* <code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> → {{convert|1|mi|m|order=flip|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}}

=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
It is possible to display only parts of the conversion result:


{| class="wikitable"
! Convert !! Output !! Description
|-
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}}
| Default, to compare
|-
| <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|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|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|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=out}}</nowiki></code> || {{convert|2|cuyd|m3|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
|}
===Display both input name and symbol: ''2 kilopascals [kPa]''===
Setting {{para|abbr|~}} returns both name and symbol of the first (input) unit:
* <code><nowiki>{{convert|2|kPa|psi|abbr=~}}</nowiki></code> → {{convert|2|kPa|psi|abbr=~}}
* <code><nowiki>A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure</nowiki></code> → {{nowrap|A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure}}

==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 showing numbers only===
Using {convert} in a table cell, with {{para|disp|table}} splits the result over two columns:
:<code><nowiki>{{convert|10|m|ft|disp=table}}</nowiki></code> → {{convert|10|m|ft|disp=table}}

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

The units are added as a column header:
:{| class=wikitable
! style="width:10em;" |  
! style="width:10em;" | m
! style="width:10em;" | ft
|-
| {{para|disp|table}}
| {{convert|10|m|ft|disp=table}}
|-
|{{para|disp|tablecen}}
| {{convert|20|m|ft|disp=tablecen}}
|-
|{{para|disp|<other>}} (default)
|{{convert|30|m|ft|disp=}}
|}

===Sorting===
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=700110000000000000010 metres (33&nbsp;ft)}}

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

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

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==
===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}}}}
<div style="height: 400px; overflow: auto; padding: 3px; border: 1px solid #aaa;">
{{Convert/list of units}}
</div>

==='per' units: ''kg/hl''===
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}}

===Units of difference===
When a number is the measurement for a ''difference'', one conversion is done. This may occur in temperatures (°C, °F, K). Compare this to a ''range'', when two conversions are done.

The only available units of difference are: {{para|C-change}}, {{para|F-change}} and {{para|K-change}}.
* {{#invoke:DemoTemplate|convert|10|C}}, regular temperature
* {{#invoke:DemoTemplate|convert|10|C-change}}, difference (e.g., "The temperature changed from 30 into 40 °C")
* {{#invoke:DemoTemplate|convert|10-15|C}}, range (e.g., "The temperature is between 10 and 15 °C")

Consistently, into multiple units:
* <code><nowiki>A rise of {{convert|10|C-change|F-change K-change}}</nowiki></code> → A rise of {{convert|10|C-change|F-change K-change}}

===Multiple units: ''1 ft 5 in''===
====In input====
Base document {{slink|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 {{slink|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
* <code><nowiki>{{convert|2|m}}</nowiki></code> → {{convert|2|m}}—the default

See also:
* {{tl|hands}} a length used to measure horses
* {{tl|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:
* <code><nowiki>{{convert|10|$/mi|$/km}}</nowiki></code> → {{convert|10|$/mi|$/km}}

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

==Parameter list==
{{convert/doc/parameter list}}

==Deprecated options==
{{Convert/doc/deprecations list}}

==TemplateData==
{{TemplateDataHeader}}

<templatedata>{
"description": "Converts measurements to other units.",
"params": {
"1": {
"label": "value",
"description": "the value to convert",
"type": "number"
},
"2": {
"label": "from unit",
"description": "",
"type": "string/line"
},
"3": {
"label": "to units",
"description": "the unit to convert into",
"type": "string/line"
},
"4": {
"label": "precision or suffix",
"description": "significant digits after decimal dot or, if negative, exponent of ten",
"type": "number"
},
"lk": {
"label": "link units",
"description": "“on” all, “in” input, “out” output or “off” no units",
"default": "off",
"type": "string/line"
},
"abbr": {
"label": "abbreviation",
"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",
"default": "out",
"type": "string/line"
},
"sp": {
"label": "spelling",
"description": "“us” display U.S. spelling of unit names",
"type": "string/line"
},
"adj": {
"label": "adjective",
"description": "adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end",
"type": "string/line"
},
"disp": {
"label": "conversion",
"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",
"default": "b",
"type": "string/line"
},
"order": {
"label": "ordering",
"description": "“flip” returns converted value first, input value second.",
"type": "string/line"
},
"sigfig": {
"label": "significant figures",
"description": "number that sets the number of significant figures",
"type": "number"
},
"round": {
"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",
"type": "string/line"
},
"comma": {
"label": "thousands separator",
"description": "Sets or suppresses thousand separator in the numbers. “off” = no separator; “gaps”: use space not comma; “5” and “gaps5”: only add separator when number > 5 positions (10,000 or more)",
"default": "on",
"type": "string/line"
},
"sortable": {
"label": "sort key",
"description": "“on” generates a hidden sort key",
"type": "string/line"
}
}}</templatedata>


==See also==
* {{Temp|Cvt}}
* {{Temp|SI units}}
{{Convert navs}}
<noinclude>
[[Category:Convert by module documentation| ]]
</noinclude><includeonly>
[[Category:Convert templates| ]]
[[Category:Conversion templates]]
[[Category:Numbers as words conversion templates]]
[[Category:Sorting templates]]
</includeonly>

Template:Convert/doc

2016-06-20T20:54:50Z

178.16.7.96: /* Multiple dimensions: {{convert|6|x|12|m|ft|abbr=on}} */

{{documentation subpage}}
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk| {{formatnum:789000}}+ }}}}
{{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}}
'''Template {{tl|convert}}''' ''calculates'' measurements from one unit (you can enter) to another one, and then ''presents the results''. For example:
:<code><nowiki>{{convert|2|km|mi}}</nowiki></code> → {{convert|2|km|mi}}
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> → {{convert|7|mi|km}}

The available '''units''' are listed [[#Units|below]]. Units are case-sensitive always ({{xt|kW}}, ''not'' {{!xt|KW}} and ''not'' {{!xt|kw}}). Multiple '''formatting''' and calculation options are listed below.

{{hatnote|See [[Help:Convert]] for more complete information}}
{{hatnote|For currency conversion into US dollars, see [[Template:To USD]]}}

==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
By default, the first value shows unit name spelled out, the second the symbol (or abbreviation). Use {{para|abbr|on/off}} to change this behaviour:
* <code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}

To abbreviate both:
* <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}}

{{para|abbr|in}} is the reverse behaviour to the default, {{para|abbr|out}}:
*<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{convert|1|lb|kg|abbr=in}}

===Convenience: {{tlf|cvt}} has {{para|abbr|on}} by default===
Template {{tl|cvt}} is similar to {{tlf|convert}}, but 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 equal to:
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{cvt|1|lb|kg|abbr=on}}

==Adjective: ''a 10-mile distance''==
Use {{para|adj|on}} to produce the adjective form. The difference:
:<code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> → {{convert|10|mi|km}} to go. ''(To compare, default)''
:<code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> → A {{convert|10|mi|km|adj=on}} distance. ''(Adjective form)''
This option does not work with {{para|abbr|on}}.

==Rounding: ''100 ft'' is ''30 m'' or ''30.5 m'' or ''30.48 m''?==
By definition, 100 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===
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 figures, whichever is more precise. An exception to this is ''rounding temperatures'' (see [[#Rounding temperatures|below]]).

{| class="wikitable"
|-
! colspan="3" | Examples of rounding
|-
|'''Input'''||'''Displays as'''||'''Note'''
|-
|<code><nowiki>{{convert|123|ft|m|-1}}</nowiki></code> || {{convert|123|ft|m|-1}} ||
|-
|<code><nowiki>{{convert|123|ft|m|0}}</nowiki></code> || {{convert|123|ft|m|0}} ||
|-
|<code><nowiki>{{convert|123|ft|m|1}}</nowiki></code> || {{convert|123|ft|m|1}} ||
|-
|<code><nowiki>{{convert|550|ft|m|0}}</nowiki></code> || {{convert|550|ft|m|0}} || Approximate value is 167.64 m
|-
|<code><nowiki>{{convert|550|ft|m}}</nowiki></code> || {{convert|550|ft|m}} || Rounds to 170, when approximate value is 167.64 m
|-
|<code><nowiki>{{convert|500|ft|m|0}}</nowiki></code> || {{convert|500|ft|m|0}} || Approximate value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|m}}</nowiki></code> || {{convert|500|ft|m}} || Rounds to 150, when approximate value is 152.4 m
|}

''Convert'' supports four types of rounding:

===Round to a given precision: ''use {{para|precision|}}''===
Specify the desired precision with the fourth unnamed parameter (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest 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: ''{{para|sigfig|}}''===
To specify the output number to be with ''n'' significant figures use {{para|sigfig|<number>}}:
* To compare: <code><nowiki>{{convert|1200|ft|m}}</nowiki></code> → {{convert|1200|ft|m}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki></code> → {{convert|1200|ft|m|sigfig=4}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=3}}</nowiki></code> → {{convert|1200|ft|m|sigfig=3}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=2}}</nowiki></code> → {{convert|1200|ft|m|sigfig=2}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki></code> → {{convert|1200|ft|m|sigfig=1}}
Setting {{para|sigfig|<=0}} is meaningless
* <code><nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki></code> → {{convert|1200|ft|m|sigfig=0}}

===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
Using {{para|round|5}} rounds the outcome to a multiple of 5.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<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.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> → {{convert|10|m|ft|round=25}}
:To compare: <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}}:
:<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> → {{convert|10 x 200 x 3000|m|ft|round=each}}

===Round to a multiple of a given fraction: ''{{frac|2|3|16}} inch''===
Specify the desired ''denominator'' using {{para|frac|<some positive integer>}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|3}}).
:<code><nowiki>{{convert|5.56|cm|in|frac=16}}</nowiki></code> → {{convert|5.56|cm|in|frac=16}}
:<code><nowiki>{{convert|8|cm|in|frac=4}}</nowiki></code> → {{convert|8|cm|in|frac=4}}
The fraction is reduced when possible:
:<code><nowiki>{{convert|8|cm|in|frac=100}}</nowiki></code> → {{convert|8|cm|in|frac=100}}
:<code><nowiki>{{convert|8|cm|in}}</nowiki></code> → {{convert|8|cm|in|sigfig=4}} (To compare)

==={{anchor|Rounding temperatures}}In temperatures: rounding ''°C'', ''°F'' and ''K''===
In temperatures, the conversion will be rounded either to precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.

#{{#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|-300|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}}

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 into five significant output digits because of the two numbers 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.

==Into multiple units: ''{{convert|10|C|F K}}''==
Separate the multiple output units by a space:
* <code><nowiki>{{convert|10|C|F K}}</nowiki></code> → {{convert|10|C|F K}}
* <code><nowiki>{{convert|5|km|mi nmi}}</nowiki></code> → {{convert|5|km|mi nmi}}
If the output unit names contain spaces, use a '+' separator.

See also:
* For multiple-unit options like ''1 ft 5 in'', see [[#In input]] and [[#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: 
{{Convert/doc/range separator list}}

===Multiple dimensions: ''{{convert|6|x|12|m|ft|abbr=on}}''===
Use "by":
* <code><nowiki>{{convert|6|by|12|ft|m}}</nowiki></code> → {{convert|6|by|12|ft|m}}

Use "×", multiplication sign, or "x", letter:
* <code><nowiki>{{convert|6|x|12|m|ft}}</nowiki></code> → {{convert|6|x|12|m|ft}}

In science, the formal way is to set <code>|x|</code> and {{para|abbr|on}} (keeping dimensions right, like in ''area = x km2''):
* <code><nowiki>{{convert|6|x|12|m|ft|abbr=on}}</nowiki></code> → {{convert|6|x|12|m|ft|abbr=on}}

===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:
* <code><nowiki>{{convert|1|ft|3|in|mm}}</nowiki></code> → {{convert|1|ft|3|in|mm}} (to compare)
* <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}}

==Words==
===Spelling of unit name: UK ''metre'' or US ''meter''?===
Default spelling of units is en-UK. 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}}

===Spell out numbers: ''ten miles''===
To write a number in words, use {{para|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}}:
* <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}}
* <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> → {{convert|10|mi|m|spell=On}}

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> → {{convert|10|mi|m|spell=on|abbr=off|sp=us}}

===Inserted before units: ''4 planted acres''===
*<code><nowiki>{{convert|4|acre||adj=pre|planted}}</nowiki></code> → {{convert|4|acre||adj=pre|planted}}
<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|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-}}

===After adjective unit: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
:<code><nowiki>{{convert|10|ft|m|adj=mid|-long}}</nowiki></code> → {{convert|10|ft|m|adj=mid|-long}}

===Plurals: ''1 inch, 2 inches''===
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}}

;Exception:
Entering the unit spelled <code>|foot|</code> forces singular output "foot", whatever the number is.
* <code><nowiki>{{convert|100|foot|abbr=off}}</nowiki></code> → {{convert|100|foot|abbr=off}}

==Numbers==

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

To illustrate, these are trivial calculations (from meter to meter), showing the multiplication factor:
* {{convert|12|Gm|m|abbr=on}}
* {{convert|12|μm|m|abbr=on}}

The prefix can be added before the SI unit (here: unit <code>m</code> for meter):
* <code><nowiki>{{convert|12|Gm|mi|abbr=on}}</nowiki></code> → {{convert|12|Gm|mi|abbr=on}}
* <code>Mm</code>: {{convert|12|Mm|mi|abbr=on}}
* <code>km</code>: {{convert|12|km|ft|abbr=on}}
* <code>mm</code>: {{convert|12|mm|in|abbr=on}}
* <code>μm</code>: {{convert|12|μm|mm|abbr=on}}
* <code>um</code>: {{convert|12|um|mm|abbr=on}} (letter "u" can be used for "μ" here)

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

As an exception, the non-SI unit "inch" can have the "μ" prefix too)
* <code><nowiki>{{convert|12|μm|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}

{{further|Help:Convert units#SI prefixes}}

===Engineering notation: ''7 × 106 m''===

====In the unit: ''e6m''====
[[Engineering notation|Engineering number notations]] like ''7{{smallcaps|E}}6'' (for 7 × 106) can be entered as a "prefix" to the unit:
* <code><nowiki>{{convert|7|e6m}}</nowiki></code> → {{convert|7|e6m}}

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−14''===
In [[scientific notation]], a number is written like {{rnd|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}}

===Input with fractions: ''{{convert|1+1/2|in|mm|1}}''===
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}}

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 (do not require a calculation)

===Output with horizontal fraction bar in: ''{{sfrac|1|2}} inch''===

Using a double slash (<code>//</code>) returns a horizontal bar fraction:
* <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}}

===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}}
*<code><nowiki>{{convert|1 234 567|m|ft}}</nowiki></code> → {{convert|1 234 567|m|ft}} {{nay}}

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}}</nowiki></code> → {{convert|1234567|m|ft}} (To compare, default)
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps}}

Setting {{para|comma|5}} or {{para|comma|gaps5}} will only add the separator when the number of digits is 5 or more:
*<code><nowiki>{{convert|1234|m|ft}}</nowiki></code> → {{convert|1234|m|ft}} (To compare, default)
*<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}}
*<code><nowiki>{{convert|1234|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234|m|ft|comma=gaps5}}
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps5}}

==Output manipulation==
===Brackets and separators: ''10 m [33 ft]''===
Punctuation that distinguishes the two measurements is set by {{para|disp|}}. 
Options are: <code>b</code> (the default), <code>sqbr</code>, <code>comma</code>, <code>or</code>, <code>br</code>, <code>x{{!}}…</code>:
* <code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}—''( ) 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=comma}}</nowiki></code> → {{convert|10|m|ft|disp=comma}}
* <code><nowiki>{{convert|10|m|ft|disp=or}}</nowiki></code> → {{convert|10|m|ft|disp=or}}

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

Also {{para|disp|br()}} will force a new line, and keep the brackets:
* <code><nowiki>{{convert|10|m|ft|disp=br()}}</nowiki></code> → {{convert|10|m|ft|disp=br()}}

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_}}—(To display spaces, use <code>&nbsp;</code>)

===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:
* <code><nowiki>{{convert|1|mi|m}}</nowiki></code> → {{convert|1|mi|m|sigfig=5|abbr=off}} (To compare, default)
* <code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> → {{convert|1|mi|m|order=flip|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}}

=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
It is possible to display only parts of the conversion result:


{| class="wikitable"
! Convert !! Output !! Description
|-
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}}
| Default, to compare
|-
| <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|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|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|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=out}}</nowiki></code> || {{convert|2|cuyd|m3|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
|}
===Display both input name and symbol: ''2 kilopascals [kPa]''===
Setting {{para|abbr|~}} returns both name and symbol of the first (input) unit:
* <code><nowiki>{{convert|2|kPa|psi|abbr=~}}</nowiki></code> → {{convert|2|kPa|psi|abbr=~}}
* <code><nowiki>A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure</nowiki></code> → {{nowrap|A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure}}

==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 showing numbers only===
Using {convert} in a table cell, with {{para|disp|table}} splits the result over two columns:
:<code><nowiki>{{convert|10|m|ft|disp=table}}</nowiki></code> → {{convert|10|m|ft|disp=table}}

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

The units are added as a column header:
:{| class=wikitable
! style="width:10em;" |  
! style="width:10em;" | m
! style="width:10em;" | ft
|-
| {{para|disp|table}}
| {{convert|10|m|ft|disp=table}}
|-
|{{para|disp|tablecen}}
| {{convert|20|m|ft|disp=tablecen}}
|-
|{{para|disp|<other>}} (default)
|{{convert|30|m|ft|disp=}}
|}

===Sorting===
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=700110000000000000010 metres (33&nbsp;ft)}}

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

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

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==
===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}}}}
<div style="height: 400px; overflow: auto; padding: 3px; border: 1px solid #aaa;">
{{Convert/list of units}}
</div>

==='per' units: ''kg/hl''===
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}}

===Units of difference===
When a number is the measurement for a ''difference'', one conversion is done. This may occur in temperatures (°C, °F, K). Compare this to a ''range'', when two conversions are done.

The only available units of difference are: {{para|C-change}}, {{para|F-change}} and {{para| K-change}}.

:{{#invoke:DemoTemplate|convert|10|C}} -- regular temperature
:{{#invoke:DemoTemplate|convert|10|C-change}} -- difference (e.g., "The temperature changed from 30 into 40 °C")
:{{#invoke:DemoTemplate|convert|10-15|C}} -- range (e.g., "The temperature is between 10 and 15 °C")

Consistently, into multiple units:
:<code><nowiki>A rise of {{convert|10|C-change|F-change K-change}}</nowiki></code> → A rise of {{convert|10|C-change|F-change K-change}}

===Multiple units: ''1 ft 5 in''===
====In input====
Base document {{slink|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 {{slink|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
* <code><nowiki>{{convert|2|m}}</nowiki></code> → {{convert|2|m}}—the default

See also:
* {{tl|hands}} a length used to measure horses
* {{tl|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:
* <code><nowiki>{{convert|10|$/mi|$/km}}</nowiki></code> → {{convert|10|$/mi|$/km}}

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

==Parameter list==
{{convert/doc/parameter list}}

==Deprecated options==
{{Convert/doc/deprecations list}}

==TemplateData==
{{TemplateDataHeader}}

<templatedata>{
"description": "Converts measurements to other units.",
"params": {
"1": {
"label": "value",
"description": "the value to convert",
"type": "number"
},
"2": {
"label": "from unit",
"description": "",
"type": "string/line"
},
"3": {
"label": "to units",
"description": "the unit to convert into",
"type": "string/line"
},
"4": {
"label": "precision or suffix",
"description": "significant digits after decimal dot or, if negative, exponent of ten",
"type": "number"
},
"lk": {
"label": "link units",
"description": "“on” all, “in” input, “out” output or “off” no units",
"default": "off",
"type": "string/line"
},
"abbr": {
"label": "abbreviation",
"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",
"default": "out",
"type": "string/line"
},
"sp": {
"label": "spelling",
"description": "“us” display U.S. spelling of unit names",
"type": "string/line"
},
"adj": {
"label": "adjective",
"description": "adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end",
"type": "string/line"
},
"disp": {
"label": "conversion",
"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",
"default": "b",
"type": "string/line"
},
"order": {
"label": "ordering",
"description": "“flip” returns converted value first, input value second.",
"type": "string/line"
},
"sigfig": {
"label": "significant figures",
"description": "number that sets the number of significant figures",
"type": "number"
},
"round": {
"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",
"type": "string/line"
},
"comma": {
"label": "thousands separator",
"description": "Sets or suppresses thousand separator in the numbers. “off” = no separator; “gaps”: use space not comma; “5” and “gaps5”: only add separator when number > 5 positions (10,000 or more)",
"default": "on",
"type": "string/line"
},
"sortable": {
"label": "sort key",
"description": "“on” generates a hidden sort key",
"type": "string/line"
}
}}</templatedata>


==See also==
* {{Temp|Cvt}}
* {{Temp|SI units}}
{{Convert navs}}
<noinclude>
[[Category:Convert by module documentation| ]]
</noinclude><includeonly>
[[Category:Convert templates| ]]
[[Category:Conversion templates]]
[[Category:Numbers as words conversion templates]]
[[Category:Sorting templates]]
</includeonly>

Template:Convert/doc

2016-06-20T20:54:05Z

178.16.7.96: /* Multiple dimensions: {{convert|6|x|12|m|ft|abbr=on}} */

{{documentation subpage}}
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk| {{formatnum:789000}}+ }}}}
{{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}}
'''Template {{tl|convert}}''' ''calculates'' measurements from one unit (you can enter) to another one, and then ''presents the results''. For example:
:<code><nowiki>{{convert|2|km|mi}}</nowiki></code> → {{convert|2|km|mi}}
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> → {{convert|7|mi|km}}

The available '''units''' are listed [[#Units|below]]. Units are case-sensitive always ({{xt|kW}}, ''not'' {{!xt|KW}} and ''not'' {{!xt|kw}}). Multiple '''formatting''' and calculation options are listed below.

{{hatnote|See [[Help:Convert]] for more complete information}}
{{hatnote|For currency conversion into US dollars, see [[Template:To USD]]}}

==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
By default, the first value shows unit name spelled out, the second the symbol (or abbreviation). Use {{para|abbr|on/off}} to change this behaviour:
* <code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}

To abbreviate both:
* <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}}

{{para|abbr|in}} is the reverse behaviour to the default, {{para|abbr|out}}:
*<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{convert|1|lb|kg|abbr=in}}

===Convenience: {{tlf|cvt}} has {{para|abbr|on}} by default===
Template {{tl|cvt}} is similar to {{tlf|convert}}, but 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 equal to:
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{cvt|1|lb|kg|abbr=on}}

==Adjective: ''a 10-mile distance''==
Use {{para|adj|on}} to produce the adjective form. The difference:
:<code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> → {{convert|10|mi|km}} to go. ''(To compare, default)''
:<code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> → A {{convert|10|mi|km|adj=on}} distance. ''(Adjective form)''
This option does not work with {{para|abbr|on}}.

==Rounding: ''100 ft'' is ''30 m'' or ''30.5 m'' or ''30.48 m''?==
By definition, 100 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===
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 figures, whichever is more precise. An exception to this is ''rounding temperatures'' (see [[#Rounding temperatures|below]]).

{| class="wikitable"
|-
! colspan="3" | Examples of rounding
|-
|'''Input'''||'''Displays as'''||'''Note'''
|-
|<code><nowiki>{{convert|123|ft|m|-1}}</nowiki></code> || {{convert|123|ft|m|-1}} ||
|-
|<code><nowiki>{{convert|123|ft|m|0}}</nowiki></code> || {{convert|123|ft|m|0}} ||
|-
|<code><nowiki>{{convert|123|ft|m|1}}</nowiki></code> || {{convert|123|ft|m|1}} ||
|-
|<code><nowiki>{{convert|550|ft|m|0}}</nowiki></code> || {{convert|550|ft|m|0}} || Approximate value is 167.64 m
|-
|<code><nowiki>{{convert|550|ft|m}}</nowiki></code> || {{convert|550|ft|m}} || Rounds to 170, when approximate value is 167.64 m
|-
|<code><nowiki>{{convert|500|ft|m|0}}</nowiki></code> || {{convert|500|ft|m|0}} || Approximate value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|m}}</nowiki></code> || {{convert|500|ft|m}} || Rounds to 150, when approximate value is 152.4 m
|}

''Convert'' supports four types of rounding:

===Round to a given precision: ''use {{para|precision|}}''===
Specify the desired precision with the fourth unnamed parameter (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest 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: ''{{para|sigfig|}}''===
To specify the output number to be with ''n'' significant figures use {{para|sigfig|<number>}}:
* To compare: <code><nowiki>{{convert|1200|ft|m}}</nowiki></code> → {{convert|1200|ft|m}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki></code> → {{convert|1200|ft|m|sigfig=4}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=3}}</nowiki></code> → {{convert|1200|ft|m|sigfig=3}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=2}}</nowiki></code> → {{convert|1200|ft|m|sigfig=2}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki></code> → {{convert|1200|ft|m|sigfig=1}}
Setting {{para|sigfig|<=0}} is meaningless
* <code><nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki></code> → {{convert|1200|ft|m|sigfig=0}}

===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
Using {{para|round|5}} rounds the outcome to a multiple of 5.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<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.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> → {{convert|10|m|ft|round=25}}
:To compare: <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}}:
:<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> → {{convert|10 x 200 x 3000|m|ft|round=each}}

===Round to a multiple of a given fraction: ''{{frac|2|3|16}} inch''===
Specify the desired ''denominator'' using {{para|frac|<some positive integer>}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|3}}).
:<code><nowiki>{{convert|5.56|cm|in|frac=16}}</nowiki></code> → {{convert|5.56|cm|in|frac=16}}
:<code><nowiki>{{convert|8|cm|in|frac=4}}</nowiki></code> → {{convert|8|cm|in|frac=4}}
The fraction is reduced when possible:
:<code><nowiki>{{convert|8|cm|in|frac=100}}</nowiki></code> → {{convert|8|cm|in|frac=100}}
:<code><nowiki>{{convert|8|cm|in}}</nowiki></code> → {{convert|8|cm|in|sigfig=4}} (To compare)

==={{anchor|Rounding temperatures}}In temperatures: rounding ''°C'', ''°F'' and ''K''===
In temperatures, the conversion will be rounded either to precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.

#{{#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|-300|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}}

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 into five significant output digits because of the two numbers 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.

==Into multiple units: ''{{convert|10|C|F K}}''==
Separate the multiple output units by a space:
* <code><nowiki>{{convert|10|C|F K}}</nowiki></code> → {{convert|10|C|F K}}
* <code><nowiki>{{convert|5|km|mi nmi}}</nowiki></code> → {{convert|5|km|mi nmi}}
If the output unit names contain spaces, use a '+' separator.

See also:
* For multiple-unit options like ''1 ft 5 in'', see [[#In input]] and [[#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: 
{{Convert/doc/range separator list}}

===Multiple dimensions: ''{{convert|6|x|12|m|ft|abbr=on}}''===
Use "by":
* <code><nowiki>{{convert|6|by|12|ft|m}}</nowiki></code> → {{convert|6|by|12|ft|m}}

Use "×" or ""x"":
* <code><nowiki>{{convert|6|x|12|m|ft}}</nowiki></code> → {{convert|6|x|12|m|ft}}

In science, the formal way is to set <code>|x|</code> and {{para|abbr|on}} (keeping dimensions right, like in ''area = x km2''):
* <code><nowiki>{{convert|6|x|12|m|ft|abbr=on}}</nowiki></code> → {{convert|6|x|12|m|ft|abbr=on}}

===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:
* <code><nowiki>{{convert|1|ft|3|in|mm}}</nowiki></code> → {{convert|1|ft|3|in|mm}} (to compare)
* <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}}

==Words==
===Spelling of unit name: UK ''metre'' or US ''meter''?===
Default spelling of units is en-UK. 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}}

===Spell out numbers: ''ten miles''===
To write a number in words, use {{para|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}}:
* <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}}
* <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> → {{convert|10|mi|m|spell=On}}

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> → {{convert|10|mi|m|spell=on|abbr=off|sp=us}}

===Inserted before units: ''4 planted acres''===
*<code><nowiki>{{convert|4|acre||adj=pre|planted}}</nowiki></code> → {{convert|4|acre||adj=pre|planted}}
<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|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-}}

===After adjective unit: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
:<code><nowiki>{{convert|10|ft|m|adj=mid|-long}}</nowiki></code> → {{convert|10|ft|m|adj=mid|-long}}

===Plurals: ''1 inch, 2 inches''===
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}}

;Exception:
Entering the unit spelled <code>|foot|</code> forces singular output "foot", whatever the number is.
* <code><nowiki>{{convert|100|foot|abbr=off}}</nowiki></code> → {{convert|100|foot|abbr=off}}

==Numbers==

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

To illustrate, these are trivial calculations (from meter to meter), showing the multiplication factor:
* {{convert|12|Gm|m|abbr=on}}
* {{convert|12|μm|m|abbr=on}}

The prefix can be added before the SI unit (here: unit <code>m</code> for meter):
* <code><nowiki>{{convert|12|Gm|mi|abbr=on}}</nowiki></code> → {{convert|12|Gm|mi|abbr=on}}
* <code>Mm</code>: {{convert|12|Mm|mi|abbr=on}}
* <code>km</code>: {{convert|12|km|ft|abbr=on}}
* <code>mm</code>: {{convert|12|mm|in|abbr=on}}
* <code>μm</code>: {{convert|12|μm|mm|abbr=on}}
* <code>um</code>: {{convert|12|um|mm|abbr=on}} (letter "u" can be used for "μ" here)

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

As an exception, the non-SI unit "inch" can have the "μ" prefix too)
* <code><nowiki>{{convert|12|μm|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}

{{further|Help:Convert units#SI prefixes}}

===Engineering notation: ''7 × 106 m''===

====In the unit: ''e6m''====
[[Engineering notation|Engineering number notations]] like ''7{{smallcaps|E}}6'' (for 7 × 106) can be entered as a "prefix" to the unit:
* <code><nowiki>{{convert|7|e6m}}</nowiki></code> → {{convert|7|e6m}}

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−14''===
In [[scientific notation]], a number is written like {{rnd|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}}

===Input with fractions: ''{{convert|1+1/2|in|mm|1}}''===
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}}

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 (do not require a calculation)

===Output with horizontal fraction bar in: ''{{sfrac|1|2}} inch''===

Using a double slash (<code>//</code>) returns a horizontal bar fraction:
* <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}}

===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}}
*<code><nowiki>{{convert|1 234 567|m|ft}}</nowiki></code> → {{convert|1 234 567|m|ft}} {{nay}}

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}}</nowiki></code> → {{convert|1234567|m|ft}} (To compare, default)
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps}}

Setting {{para|comma|5}} or {{para|comma|gaps5}} will only add the separator when the number of digits is 5 or more:
*<code><nowiki>{{convert|1234|m|ft}}</nowiki></code> → {{convert|1234|m|ft}} (To compare, default)
*<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}}
*<code><nowiki>{{convert|1234|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234|m|ft|comma=gaps5}}
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps5}}

==Output manipulation==
===Brackets and separators: ''10 m [33 ft]''===
Punctuation that distinguishes the two measurements is set by {{para|disp|}}. 
Options are: <code>b</code> (the default), <code>sqbr</code>, <code>comma</code>, <code>or</code>, <code>br</code>, <code>x{{!}}…</code>:
* <code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}—''( ) 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=comma}}</nowiki></code> → {{convert|10|m|ft|disp=comma}}
* <code><nowiki>{{convert|10|m|ft|disp=or}}</nowiki></code> → {{convert|10|m|ft|disp=or}}

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

Also {{para|disp|br()}} will force a new line, and keep the brackets:
* <code><nowiki>{{convert|10|m|ft|disp=br()}}</nowiki></code> → {{convert|10|m|ft|disp=br()}}

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_}}—(To display spaces, use <code>&nbsp;</code>)

===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:
* <code><nowiki>{{convert|1|mi|m}}</nowiki></code> → {{convert|1|mi|m|sigfig=5|abbr=off}} (To compare, default)
* <code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> → {{convert|1|mi|m|order=flip|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}}

=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
It is possible to display only parts of the conversion result:


{| class="wikitable"
! Convert !! Output !! Description
|-
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}}
| Default, to compare
|-
| <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|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|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|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=out}}</nowiki></code> || {{convert|2|cuyd|m3|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
|}
===Display both input name and symbol: ''2 kilopascals [kPa]''===
Setting {{para|abbr|~}} returns both name and symbol of the first (input) unit:
* <code><nowiki>{{convert|2|kPa|psi|abbr=~}}</nowiki></code> → {{convert|2|kPa|psi|abbr=~}}
* <code><nowiki>A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure</nowiki></code> → {{nowrap|A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure}}

==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 showing numbers only===
Using {convert} in a table cell, with {{para|disp|table}} splits the result over two columns:
:<code><nowiki>{{convert|10|m|ft|disp=table}}</nowiki></code> → {{convert|10|m|ft|disp=table}}

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

The units are added as a column header:
:{| class=wikitable
! style="width:10em;" |  
! style="width:10em;" | m
! style="width:10em;" | ft
|-
| {{para|disp|table}}
| {{convert|10|m|ft|disp=table}}
|-
|{{para|disp|tablecen}}
| {{convert|20|m|ft|disp=tablecen}}
|-
|{{para|disp|<other>}} (default)
|{{convert|30|m|ft|disp=}}
|}

===Sorting===
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=700110000000000000010 metres (33&nbsp;ft)}}

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

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

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==
===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}}}}
<div style="height: 400px; overflow: auto; padding: 3px; border: 1px solid #aaa;">
{{Convert/list of units}}
</div>

==='per' units: ''kg/hl''===
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}}

===Units of difference===
When a number is the measurement for a ''difference'', one conversion is done. This may occur in temperatures (°C, °F, K). Compare this to a ''range'', when two conversions are done.

The only available units of difference are: {{para|C-change}}, {{para|F-change}} and {{para| K-change}}.

:{{#invoke:DemoTemplate|convert|10|C}} -- regular temperature
:{{#invoke:DemoTemplate|convert|10|C-change}} -- difference (e.g., "The temperature changed from 30 into 40 °C")
:{{#invoke:DemoTemplate|convert|10-15|C}} -- range (e.g., "The temperature is between 10 and 15 °C")

Consistently, into multiple units:
:<code><nowiki>A rise of {{convert|10|C-change|F-change K-change}}</nowiki></code> → A rise of {{convert|10|C-change|F-change K-change}}

===Multiple units: ''1 ft 5 in''===
====In input====
Base document {{slink|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 {{slink|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
* <code><nowiki>{{convert|2|m}}</nowiki></code> → {{convert|2|m}}—the default

See also:
* {{tl|hands}} a length used to measure horses
* {{tl|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:
* <code><nowiki>{{convert|10|$/mi|$/km}}</nowiki></code> → {{convert|10|$/mi|$/km}}

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

==Parameter list==
{{convert/doc/parameter list}}

==Deprecated options==
{{Convert/doc/deprecations list}}

==TemplateData==
{{TemplateDataHeader}}

<templatedata>{
"description": "Converts measurements to other units.",
"params": {
"1": {
"label": "value",
"description": "the value to convert",
"type": "number"
},
"2": {
"label": "from unit",
"description": "",
"type": "string/line"
},
"3": {
"label": "to units",
"description": "the unit to convert into",
"type": "string/line"
},
"4": {
"label": "precision or suffix",
"description": "significant digits after decimal dot or, if negative, exponent of ten",
"type": "number"
},
"lk": {
"label": "link units",
"description": "“on” all, “in” input, “out” output or “off” no units",
"default": "off",
"type": "string/line"
},
"abbr": {
"label": "abbreviation",
"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",
"default": "out",
"type": "string/line"
},
"sp": {
"label": "spelling",
"description": "“us” display U.S. spelling of unit names",
"type": "string/line"
},
"adj": {
"label": "adjective",
"description": "adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end",
"type": "string/line"
},
"disp": {
"label": "conversion",
"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",
"default": "b",
"type": "string/line"
},
"order": {
"label": "ordering",
"description": "“flip” returns converted value first, input value second.",
"type": "string/line"
},
"sigfig": {
"label": "significant figures",
"description": "number that sets the number of significant figures",
"type": "number"
},
"round": {
"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",
"type": "string/line"
},
"comma": {
"label": "thousands separator",
"description": "Sets or suppresses thousand separator in the numbers. “off” = no separator; “gaps”: use space not comma; “5” and “gaps5”: only add separator when number > 5 positions (10,000 or more)",
"default": "on",
"type": "string/line"
},
"sortable": {
"label": "sort key",
"description": "“on” generates a hidden sort key",
"type": "string/line"
}
}}</templatedata>


==See also==
* {{Temp|Cvt}}
* {{Temp|SI units}}
{{Convert navs}}
<noinclude>
[[Category:Convert by module documentation| ]]
</noinclude><includeonly>
[[Category:Convert templates| ]]
[[Category:Conversion templates]]
[[Category:Numbers as words conversion templates]]
[[Category:Sorting templates]]
</includeonly>

Template:Convert/doc

2016-06-20T20:50:43Z

178.16.7.96: /* Display both input name and symbol: 2 kilopascals [kPa] */

{{documentation subpage}}
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk| {{formatnum:789000}}+ }}}}
{{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}}
'''Template {{tl|convert}}''' ''calculates'' measurements from one unit (you can enter) to another one, and then ''presents the results''. For example:
:<code><nowiki>{{convert|2|km|mi}}</nowiki></code> → {{convert|2|km|mi}}
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> → {{convert|7|mi|km}}

The available '''units''' are listed [[#Units|below]]. Units are case-sensitive always ({{xt|kW}}, ''not'' {{!xt|KW}} and ''not'' {{!xt|kw}}). Multiple '''formatting''' and calculation options are listed below.

{{hatnote|See [[Help:Convert]] for more complete information}}
{{hatnote|For currency conversion into US dollars, see [[Template:To USD]]}}

==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
By default, the first value shows unit name spelled out, the second the symbol (or abbreviation). Use {{para|abbr|on/off}} to change this behaviour:
* <code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}

To abbreviate both:
* <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}}

{{para|abbr|in}} is the reverse behaviour to the default, {{para|abbr|out}}:
*<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{convert|1|lb|kg|abbr=in}}

===Convenience: {{tlf|cvt}} has {{para|abbr|on}} by default===
Template {{tl|cvt}} is similar to {{tlf|convert}}, but 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 equal to:
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{cvt|1|lb|kg|abbr=on}}

==Adjective: ''a 10-mile distance''==
Use {{para|adj|on}} to produce the adjective form. The difference:
:<code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> → {{convert|10|mi|km}} to go. ''(To compare, default)''
:<code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> → A {{convert|10|mi|km|adj=on}} distance. ''(Adjective form)''
This option does not work with {{para|abbr|on}}.

==Rounding: ''100 ft'' is ''30 m'' or ''30.5 m'' or ''30.48 m''?==
By definition, 100 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===
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 figures, whichever is more precise. An exception to this is ''rounding temperatures'' (see [[#Rounding temperatures|below]]).

{| class="wikitable"
|-
! colspan="3" | Examples of rounding
|-
|'''Input'''||'''Displays as'''||'''Note'''
|-
|<code><nowiki>{{convert|123|ft|m|-1}}</nowiki></code> || {{convert|123|ft|m|-1}} ||
|-
|<code><nowiki>{{convert|123|ft|m|0}}</nowiki></code> || {{convert|123|ft|m|0}} ||
|-
|<code><nowiki>{{convert|123|ft|m|1}}</nowiki></code> || {{convert|123|ft|m|1}} ||
|-
|<code><nowiki>{{convert|550|ft|m|0}}</nowiki></code> || {{convert|550|ft|m|0}} || Approximate value is 167.64 m
|-
|<code><nowiki>{{convert|550|ft|m}}</nowiki></code> || {{convert|550|ft|m}} || Rounds to 170, when approximate value is 167.64 m
|-
|<code><nowiki>{{convert|500|ft|m|0}}</nowiki></code> || {{convert|500|ft|m|0}} || Approximate value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|m}}</nowiki></code> || {{convert|500|ft|m}} || Rounds to 150, when approximate value is 152.4 m
|}

''Convert'' supports four types of rounding:

===Round to a given precision: ''use {{para|precision|}}''===
Specify the desired precision with the fourth unnamed parameter (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest 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: ''{{para|sigfig|}}''===
To specify the output number to be with ''n'' significant figures use {{para|sigfig|<number>}}:
* To compare: <code><nowiki>{{convert|1200|ft|m}}</nowiki></code> → {{convert|1200|ft|m}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki></code> → {{convert|1200|ft|m|sigfig=4}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=3}}</nowiki></code> → {{convert|1200|ft|m|sigfig=3}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=2}}</nowiki></code> → {{convert|1200|ft|m|sigfig=2}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki></code> → {{convert|1200|ft|m|sigfig=1}}
Setting {{para|sigfig|<=0}} is meaningless
* <code><nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki></code> → {{convert|1200|ft|m|sigfig=0}}

===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
Using {{para|round|5}} rounds the outcome to a multiple of 5.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<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.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> → {{convert|10|m|ft|round=25}}
:To compare: <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}}:
:<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> → {{convert|10 x 200 x 3000|m|ft|round=each}}

===Round to a multiple of a given fraction: ''{{frac|2|3|16}} inch''===
Specify the desired ''denominator'' using {{para|frac|<some positive integer>}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|3}}).
:<code><nowiki>{{convert|5.56|cm|in|frac=16}}</nowiki></code> → {{convert|5.56|cm|in|frac=16}}
:<code><nowiki>{{convert|8|cm|in|frac=4}}</nowiki></code> → {{convert|8|cm|in|frac=4}}
The fraction is reduced when possible:
:<code><nowiki>{{convert|8|cm|in|frac=100}}</nowiki></code> → {{convert|8|cm|in|frac=100}}
:<code><nowiki>{{convert|8|cm|in}}</nowiki></code> → {{convert|8|cm|in|sigfig=4}} (To compare)

==={{anchor|Rounding temperatures}}In temperatures: rounding ''°C'', ''°F'' and ''K''===
In temperatures, the conversion will be rounded either to precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.

#{{#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|-300|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}}

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 into five significant output digits because of the two numbers 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.

==Into multiple units: ''{{convert|10|C|F K}}''==
Separate the multiple output units by a space:
* <code><nowiki>{{convert|10|C|F K}}</nowiki></code> → {{convert|10|C|F K}}
* <code><nowiki>{{convert|5|km|mi nmi}}</nowiki></code> → {{convert|5|km|mi nmi}}
If the output unit names contain spaces, use a '+' separator.

See also:
* For multiple-unit options like ''1 ft 5 in'', see [[#In input]] and [[#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: 
{{Convert/doc/range separator list}}

===Multiple dimensions: ''{{convert|6|x|12|m|ft|abbr=on}}''===
; Use "by":
:<code><nowiki>{{convert|6|by|12|ft|m}}</nowiki></code> → {{convert|6|by|12|ft|m}}
;Use "×" or ""x"":
:<code><nowiki>{{convert|6|x|12|m|ft}}</nowiki></code> → {{convert|6|x|12|m|ft}}

In science, the formal way is to set <code>|x|</code> and {{para|abbr|on}} (keeping dimensions right, like in ''area = x km2''):
:<code><nowiki>{{convert|6|x|12|m|ft|abbr=on}}</nowiki></code> → {{convert|6|x|12|m|ft|abbr=on}}

===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:
* <code><nowiki>{{convert|1|ft|3|in|mm}}</nowiki></code> → {{convert|1|ft|3|in|mm}} (to compare)
* <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}}

==Words==
===Spelling of unit name: UK ''metre'' or US ''meter''?===
Default spelling of units is en-UK. 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}}

===Spell out numbers: ''ten miles''===
To write a number in words, use {{para|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}}:
* <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}}
* <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> → {{convert|10|mi|m|spell=On}}

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> → {{convert|10|mi|m|spell=on|abbr=off|sp=us}}

===Inserted before units: ''4 planted acres''===
*<code><nowiki>{{convert|4|acre||adj=pre|planted}}</nowiki></code> → {{convert|4|acre||adj=pre|planted}}
<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|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-}}

===After adjective unit: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
:<code><nowiki>{{convert|10|ft|m|adj=mid|-long}}</nowiki></code> → {{convert|10|ft|m|adj=mid|-long}}

===Plurals: ''1 inch, 2 inches''===
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}}

;Exception:
Entering the unit spelled <code>|foot|</code> forces singular output "foot", whatever the number is.
* <code><nowiki>{{convert|100|foot|abbr=off}}</nowiki></code> → {{convert|100|foot|abbr=off}}

==Numbers==

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

To illustrate, these are trivial calculations (from meter to meter), showing the multiplication factor:
* {{convert|12|Gm|m|abbr=on}}
* {{convert|12|μm|m|abbr=on}}

The prefix can be added before the SI unit (here: unit <code>m</code> for meter):
* <code><nowiki>{{convert|12|Gm|mi|abbr=on}}</nowiki></code> → {{convert|12|Gm|mi|abbr=on}}
* <code>Mm</code>: {{convert|12|Mm|mi|abbr=on}}
* <code>km</code>: {{convert|12|km|ft|abbr=on}}
* <code>mm</code>: {{convert|12|mm|in|abbr=on}}
* <code>μm</code>: {{convert|12|μm|mm|abbr=on}}
* <code>um</code>: {{convert|12|um|mm|abbr=on}} (letter "u" can be used for "μ" here)

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

As an exception, the non-SI unit "inch" can have the "μ" prefix too)
* <code><nowiki>{{convert|12|μm|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}

{{further|Help:Convert units#SI prefixes}}

===Engineering notation: ''7 × 106 m''===

====In the unit: ''e6m''====
[[Engineering notation|Engineering number notations]] like ''7{{smallcaps|E}}6'' (for 7 × 106) can be entered as a "prefix" to the unit:
* <code><nowiki>{{convert|7|e6m}}</nowiki></code> → {{convert|7|e6m}}

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−14''===
In [[scientific notation]], a number is written like {{rnd|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}}

===Input with fractions: ''{{convert|1+1/2|in|mm|1}}''===
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}}

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 (do not require a calculation)

===Output with horizontal fraction bar in: ''{{sfrac|1|2}} inch''===

Using a double slash (<code>//</code>) returns a horizontal bar fraction:
* <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}}

===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}}
*<code><nowiki>{{convert|1 234 567|m|ft}}</nowiki></code> → {{convert|1 234 567|m|ft}} {{nay}}

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}}</nowiki></code> → {{convert|1234567|m|ft}} (To compare, default)
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps}}

Setting {{para|comma|5}} or {{para|comma|gaps5}} will only add the separator when the number of digits is 5 or more:
*<code><nowiki>{{convert|1234|m|ft}}</nowiki></code> → {{convert|1234|m|ft}} (To compare, default)
*<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}}
*<code><nowiki>{{convert|1234|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234|m|ft|comma=gaps5}}
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps5}}

==Output manipulation==
===Brackets and separators: ''10 m [33 ft]''===
Punctuation that distinguishes the two measurements is set by {{para|disp|}}. 
Options are: <code>b</code> (the default), <code>sqbr</code>, <code>comma</code>, <code>or</code>, <code>br</code>, <code>x{{!}}…</code>:
* <code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}—''( ) 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=comma}}</nowiki></code> → {{convert|10|m|ft|disp=comma}}
* <code><nowiki>{{convert|10|m|ft|disp=or}}</nowiki></code> → {{convert|10|m|ft|disp=or}}

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

Also {{para|disp|br()}} will force a new line, and keep the brackets:
* <code><nowiki>{{convert|10|m|ft|disp=br()}}</nowiki></code> → {{convert|10|m|ft|disp=br()}}

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_}}—(To display spaces, use <code>&nbsp;</code>)

===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:
* <code><nowiki>{{convert|1|mi|m}}</nowiki></code> → {{convert|1|mi|m|sigfig=5|abbr=off}} (To compare, default)
* <code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> → {{convert|1|mi|m|order=flip|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}}

=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
It is possible to display only parts of the conversion result:


{| class="wikitable"
! Convert !! Output !! Description
|-
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}}
| Default, to compare
|-
| <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|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|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|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=out}}</nowiki></code> || {{convert|2|cuyd|m3|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
|}
===Display both input name and symbol: ''2 kilopascals [kPa]''===
Setting {{para|abbr|~}} returns both name and symbol of the first (input) unit:
* <code><nowiki>{{convert|2|kPa|psi|abbr=~}}</nowiki></code> → {{convert|2|kPa|psi|abbr=~}}
* <code><nowiki>A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure</nowiki></code> → {{nowrap|A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure}}

==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 showing numbers only===
Using {convert} in a table cell, with {{para|disp|table}} splits the result over two columns:
:<code><nowiki>{{convert|10|m|ft|disp=table}}</nowiki></code> → {{convert|10|m|ft|disp=table}}

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

The units are added as a column header:
:{| class=wikitable
! style="width:10em;" |  
! style="width:10em;" | m
! style="width:10em;" | ft
|-
| {{para|disp|table}}
| {{convert|10|m|ft|disp=table}}
|-
|{{para|disp|tablecen}}
| {{convert|20|m|ft|disp=tablecen}}
|-
|{{para|disp|<other>}} (default)
|{{convert|30|m|ft|disp=}}
|}

===Sorting===
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=700110000000000000010 metres (33&nbsp;ft)}}

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

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

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==
===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}}}}
<div style="height: 400px; overflow: auto; padding: 3px; border: 1px solid #aaa;">
{{Convert/list of units}}
</div>

==='per' units: ''kg/hl''===
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}}

===Units of difference===
When a number is the measurement for a ''difference'', one conversion is done. This may occur in temperatures (°C, °F, K). Compare this to a ''range'', when two conversions are done.

The only available units of difference are: {{para|C-change}}, {{para|F-change}} and {{para| K-change}}.

:{{#invoke:DemoTemplate|convert|10|C}} -- regular temperature
:{{#invoke:DemoTemplate|convert|10|C-change}} -- difference (e.g., "The temperature changed from 30 into 40 °C")
:{{#invoke:DemoTemplate|convert|10-15|C}} -- range (e.g., "The temperature is between 10 and 15 °C")

Consistently, into multiple units:
:<code><nowiki>A rise of {{convert|10|C-change|F-change K-change}}</nowiki></code> → A rise of {{convert|10|C-change|F-change K-change}}

===Multiple units: ''1 ft 5 in''===
====In input====
Base document {{slink|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 {{slink|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
* <code><nowiki>{{convert|2|m}}</nowiki></code> → {{convert|2|m}}—the default

See also:
* {{tl|hands}} a length used to measure horses
* {{tl|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:
* <code><nowiki>{{convert|10|$/mi|$/km}}</nowiki></code> → {{convert|10|$/mi|$/km}}

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

==Parameter list==
{{convert/doc/parameter list}}

==Deprecated options==
{{Convert/doc/deprecations list}}

==TemplateData==
{{TemplateDataHeader}}

<templatedata>{
"description": "Converts measurements to other units.",
"params": {
"1": {
"label": "value",
"description": "the value to convert",
"type": "number"
},
"2": {
"label": "from unit",
"description": "",
"type": "string/line"
},
"3": {
"label": "to units",
"description": "the unit to convert into",
"type": "string/line"
},
"4": {
"label": "precision or suffix",
"description": "significant digits after decimal dot or, if negative, exponent of ten",
"type": "number"
},
"lk": {
"label": "link units",
"description": "“on” all, “in” input, “out” output or “off” no units",
"default": "off",
"type": "string/line"
},
"abbr": {
"label": "abbreviation",
"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",
"default": "out",
"type": "string/line"
},
"sp": {
"label": "spelling",
"description": "“us” display U.S. spelling of unit names",
"type": "string/line"
},
"adj": {
"label": "adjective",
"description": "adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end",
"type": "string/line"
},
"disp": {
"label": "conversion",
"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",
"default": "b",
"type": "string/line"
},
"order": {
"label": "ordering",
"description": "“flip” returns converted value first, input value second.",
"type": "string/line"
},
"sigfig": {
"label": "significant figures",
"description": "number that sets the number of significant figures",
"type": "number"
},
"round": {
"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",
"type": "string/line"
},
"comma": {
"label": "thousands separator",
"description": "Sets or suppresses thousand separator in the numbers. “off” = no separator; “gaps”: use space not comma; “5” and “gaps5”: only add separator when number > 5 positions (10,000 or more)",
"default": "on",
"type": "string/line"
},
"sortable": {
"label": "sort key",
"description": "“on” generates a hidden sort key",
"type": "string/line"
}
}}</templatedata>


==See also==
* {{Temp|Cvt}}
* {{Temp|SI units}}
{{Convert navs}}
<noinclude>
[[Category:Convert by module documentation| ]]
</noinclude><includeonly>
[[Category:Convert templates| ]]
[[Category:Conversion templates]]
[[Category:Numbers as words conversion templates]]
[[Category:Sorting templates]]
</includeonly>

Template:Convert/doc

2016-06-20T20:50:00Z

178.16.7.96: /* In the unit: e6m */

{{documentation subpage}}
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk| {{formatnum:789000}}+ }}}}
{{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}}
'''Template {{tl|convert}}''' ''calculates'' measurements from one unit (you can enter) to another one, and then ''presents the results''. For example:
:<code><nowiki>{{convert|2|km|mi}}</nowiki></code> → {{convert|2|km|mi}}
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> → {{convert|7|mi|km}}

The available '''units''' are listed [[#Units|below]]. Units are case-sensitive always ({{xt|kW}}, ''not'' {{!xt|KW}} and ''not'' {{!xt|kw}}). Multiple '''formatting''' and calculation options are listed below.

{{hatnote|See [[Help:Convert]] for more complete information}}
{{hatnote|For currency conversion into US dollars, see [[Template:To USD]]}}

==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
By default, the first value shows unit name spelled out, the second the symbol (or abbreviation). Use {{para|abbr|on/off}} to change this behaviour:
* <code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}

To abbreviate both:
* <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}}

{{para|abbr|in}} is the reverse behaviour to the default, {{para|abbr|out}}:
*<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{convert|1|lb|kg|abbr=in}}

===Convenience: {{tlf|cvt}} has {{para|abbr|on}} by default===
Template {{tl|cvt}} is similar to {{tlf|convert}}, but 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 equal to:
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{cvt|1|lb|kg|abbr=on}}

==Adjective: ''a 10-mile distance''==
Use {{para|adj|on}} to produce the adjective form. The difference:
:<code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> → {{convert|10|mi|km}} to go. ''(To compare, default)''
:<code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> → A {{convert|10|mi|km|adj=on}} distance. ''(Adjective form)''
This option does not work with {{para|abbr|on}}.

==Rounding: ''100 ft'' is ''30 m'' or ''30.5 m'' or ''30.48 m''?==
By definition, 100 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===
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 figures, whichever is more precise. An exception to this is ''rounding temperatures'' (see [[#Rounding temperatures|below]]).

{| class="wikitable"
|-
! colspan="3" | Examples of rounding
|-
|'''Input'''||'''Displays as'''||'''Note'''
|-
|<code><nowiki>{{convert|123|ft|m|-1}}</nowiki></code> || {{convert|123|ft|m|-1}} ||
|-
|<code><nowiki>{{convert|123|ft|m|0}}</nowiki></code> || {{convert|123|ft|m|0}} ||
|-
|<code><nowiki>{{convert|123|ft|m|1}}</nowiki></code> || {{convert|123|ft|m|1}} ||
|-
|<code><nowiki>{{convert|550|ft|m|0}}</nowiki></code> || {{convert|550|ft|m|0}} || Approximate value is 167.64 m
|-
|<code><nowiki>{{convert|550|ft|m}}</nowiki></code> || {{convert|550|ft|m}} || Rounds to 170, when approximate value is 167.64 m
|-
|<code><nowiki>{{convert|500|ft|m|0}}</nowiki></code> || {{convert|500|ft|m|0}} || Approximate value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|m}}</nowiki></code> || {{convert|500|ft|m}} || Rounds to 150, when approximate value is 152.4 m
|}

''Convert'' supports four types of rounding:

===Round to a given precision: ''use {{para|precision|}}''===
Specify the desired precision with the fourth unnamed parameter (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest 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: ''{{para|sigfig|}}''===
To specify the output number to be with ''n'' significant figures use {{para|sigfig|<number>}}:
* To compare: <code><nowiki>{{convert|1200|ft|m}}</nowiki></code> → {{convert|1200|ft|m}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki></code> → {{convert|1200|ft|m|sigfig=4}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=3}}</nowiki></code> → {{convert|1200|ft|m|sigfig=3}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=2}}</nowiki></code> → {{convert|1200|ft|m|sigfig=2}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki></code> → {{convert|1200|ft|m|sigfig=1}}
Setting {{para|sigfig|<=0}} is meaningless
* <code><nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki></code> → {{convert|1200|ft|m|sigfig=0}}

===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
Using {{para|round|5}} rounds the outcome to a multiple of 5.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<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.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> → {{convert|10|m|ft|round=25}}
:To compare: <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}}:
:<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> → {{convert|10 x 200 x 3000|m|ft|round=each}}

===Round to a multiple of a given fraction: ''{{frac|2|3|16}} inch''===
Specify the desired ''denominator'' using {{para|frac|<some positive integer>}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|3}}).
:<code><nowiki>{{convert|5.56|cm|in|frac=16}}</nowiki></code> → {{convert|5.56|cm|in|frac=16}}
:<code><nowiki>{{convert|8|cm|in|frac=4}}</nowiki></code> → {{convert|8|cm|in|frac=4}}
The fraction is reduced when possible:
:<code><nowiki>{{convert|8|cm|in|frac=100}}</nowiki></code> → {{convert|8|cm|in|frac=100}}
:<code><nowiki>{{convert|8|cm|in}}</nowiki></code> → {{convert|8|cm|in|sigfig=4}} (To compare)

==={{anchor|Rounding temperatures}}In temperatures: rounding ''°C'', ''°F'' and ''K''===
In temperatures, the conversion will be rounded either to precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.

#{{#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|-300|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}}

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 into five significant output digits because of the two numbers 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.

==Into multiple units: ''{{convert|10|C|F K}}''==
Separate the multiple output units by a space:
* <code><nowiki>{{convert|10|C|F K}}</nowiki></code> → {{convert|10|C|F K}}
* <code><nowiki>{{convert|5|km|mi nmi}}</nowiki></code> → {{convert|5|km|mi nmi}}
If the output unit names contain spaces, use a '+' separator.

See also:
* For multiple-unit options like ''1 ft 5 in'', see [[#In input]] and [[#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: 
{{Convert/doc/range separator list}}

===Multiple dimensions: ''{{convert|6|x|12|m|ft|abbr=on}}''===
; Use "by":
:<code><nowiki>{{convert|6|by|12|ft|m}}</nowiki></code> → {{convert|6|by|12|ft|m}}
;Use "×" or ""x"":
:<code><nowiki>{{convert|6|x|12|m|ft}}</nowiki></code> → {{convert|6|x|12|m|ft}}

In science, the formal way is to set <code>|x|</code> and {{para|abbr|on}} (keeping dimensions right, like in ''area = x km2''):
:<code><nowiki>{{convert|6|x|12|m|ft|abbr=on}}</nowiki></code> → {{convert|6|x|12|m|ft|abbr=on}}

===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:
* <code><nowiki>{{convert|1|ft|3|in|mm}}</nowiki></code> → {{convert|1|ft|3|in|mm}} (to compare)
* <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}}

==Words==
===Spelling of unit name: UK ''metre'' or US ''meter''?===
Default spelling of units is en-UK. 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}}

===Spell out numbers: ''ten miles''===
To write a number in words, use {{para|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}}:
* <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}}
* <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> → {{convert|10|mi|m|spell=On}}

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> → {{convert|10|mi|m|spell=on|abbr=off|sp=us}}

===Inserted before units: ''4 planted acres''===
*<code><nowiki>{{convert|4|acre||adj=pre|planted}}</nowiki></code> → {{convert|4|acre||adj=pre|planted}}
<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|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-}}

===After adjective unit: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
:<code><nowiki>{{convert|10|ft|m|adj=mid|-long}}</nowiki></code> → {{convert|10|ft|m|adj=mid|-long}}

===Plurals: ''1 inch, 2 inches''===
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}}

;Exception:
Entering the unit spelled <code>|foot|</code> forces singular output "foot", whatever the number is.
* <code><nowiki>{{convert|100|foot|abbr=off}}</nowiki></code> → {{convert|100|foot|abbr=off}}

==Numbers==

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

To illustrate, these are trivial calculations (from meter to meter), showing the multiplication factor:
* {{convert|12|Gm|m|abbr=on}}
* {{convert|12|μm|m|abbr=on}}

The prefix can be added before the SI unit (here: unit <code>m</code> for meter):
* <code><nowiki>{{convert|12|Gm|mi|abbr=on}}</nowiki></code> → {{convert|12|Gm|mi|abbr=on}}
* <code>Mm</code>: {{convert|12|Mm|mi|abbr=on}}
* <code>km</code>: {{convert|12|km|ft|abbr=on}}
* <code>mm</code>: {{convert|12|mm|in|abbr=on}}
* <code>μm</code>: {{convert|12|μm|mm|abbr=on}}
* <code>um</code>: {{convert|12|um|mm|abbr=on}} (letter "u" can be used for "μ" here)

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

As an exception, the non-SI unit "inch" can have the "μ" prefix too)
* <code><nowiki>{{convert|12|μm|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}

{{further|Help:Convert units#SI prefixes}}

===Engineering notation: ''7 × 106 m''===

====In the unit: ''e6m''====
[[Engineering notation|Engineering number notations]] like ''7{{smallcaps|E}}6'' (for 7 × 106) can be entered as a "prefix" to the unit:
* <code><nowiki>{{convert|7|e6m}}</nowiki></code> → {{convert|7|e6m}}

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−14''===
In [[scientific notation]], a number is written like {{rnd|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}}

===Input with fractions: ''{{convert|1+1/2|in|mm|1}}''===
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}}

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 (do not require a calculation)

===Output with horizontal fraction bar in: ''{{sfrac|1|2}} inch''===

Using a double slash (<code>//</code>) returns a horizontal bar fraction:
* <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}}

===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}}
*<code><nowiki>{{convert|1 234 567|m|ft}}</nowiki></code> → {{convert|1 234 567|m|ft}} {{nay}}

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}}</nowiki></code> → {{convert|1234567|m|ft}} (To compare, default)
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps}}

Setting {{para|comma|5}} or {{para|comma|gaps5}} will only add the separator when the number of digits is 5 or more:
*<code><nowiki>{{convert|1234|m|ft}}</nowiki></code> → {{convert|1234|m|ft}} (To compare, default)
*<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}}
*<code><nowiki>{{convert|1234|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234|m|ft|comma=gaps5}}
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps5}}

==Output manipulation==
===Brackets and separators: ''10 m [33 ft]''===
Punctuation that distinguishes the two measurements is set by {{para|disp|}}. 
Options are: <code>b</code> (the default), <code>sqbr</code>, <code>comma</code>, <code>or</code>, <code>br</code>, <code>x{{!}}…</code>:
* <code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}—''( ) 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=comma}}</nowiki></code> → {{convert|10|m|ft|disp=comma}}
* <code><nowiki>{{convert|10|m|ft|disp=or}}</nowiki></code> → {{convert|10|m|ft|disp=or}}

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

Also {{para|disp|br()}} will force a new line, and keep the brackets:
* <code><nowiki>{{convert|10|m|ft|disp=br()}}</nowiki></code> → {{convert|10|m|ft|disp=br()}}

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_}}—(To display spaces, use <code>&nbsp;</code>)

===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:
* <code><nowiki>{{convert|1|mi|m}}</nowiki></code> → {{convert|1|mi|m|sigfig=5|abbr=off}} (To compare, default)
* <code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> → {{convert|1|mi|m|order=flip|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}}

=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
It is possible to display only parts of the conversion result:


{| class="wikitable"
! Convert !! Output !! Description
|-
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}}
| Default, to compare
|-
| <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|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|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|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=out}}</nowiki></code> || {{convert|2|cuyd|m3|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
|}
===Display both input name and symbol: ''2 kilopascals [kPa]''===
Setting {{para|abbr|~}} returns both name and symbol of the first (input) unit:
:<code><nowiki>{{convert|2|kPa|psi|abbr=~}}</nowiki></code> → {{convert|2|kPa|psi|abbr=~}}
:<code><nowiki>A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure</nowiki></code> → {{nowrap|A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure}}

==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 showing numbers only===
Using {convert} in a table cell, with {{para|disp|table}} splits the result over two columns:
:<code><nowiki>{{convert|10|m|ft|disp=table}}</nowiki></code> → {{convert|10|m|ft|disp=table}}

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

The units are added as a column header:
:{| class=wikitable
! style="width:10em;" |  
! style="width:10em;" | m
! style="width:10em;" | ft
|-
| {{para|disp|table}}
| {{convert|10|m|ft|disp=table}}
|-
|{{para|disp|tablecen}}
| {{convert|20|m|ft|disp=tablecen}}
|-
|{{para|disp|<other>}} (default)
|{{convert|30|m|ft|disp=}}
|}

===Sorting===
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=700110000000000000010 metres (33&nbsp;ft)}}

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

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

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==
===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}}}}
<div style="height: 400px; overflow: auto; padding: 3px; border: 1px solid #aaa;">
{{Convert/list of units}}
</div>

==='per' units: ''kg/hl''===
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}}

===Units of difference===
When a number is the measurement for a ''difference'', one conversion is done. This may occur in temperatures (°C, °F, K). Compare this to a ''range'', when two conversions are done.

The only available units of difference are: {{para|C-change}}, {{para|F-change}} and {{para| K-change}}.

:{{#invoke:DemoTemplate|convert|10|C}} -- regular temperature
:{{#invoke:DemoTemplate|convert|10|C-change}} -- difference (e.g., "The temperature changed from 30 into 40 °C")
:{{#invoke:DemoTemplate|convert|10-15|C}} -- range (e.g., "The temperature is between 10 and 15 °C")

Consistently, into multiple units:
:<code><nowiki>A rise of {{convert|10|C-change|F-change K-change}}</nowiki></code> → A rise of {{convert|10|C-change|F-change K-change}}

===Multiple units: ''1 ft 5 in''===
====In input====
Base document {{slink|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 {{slink|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
* <code><nowiki>{{convert|2|m}}</nowiki></code> → {{convert|2|m}}—the default

See also:
* {{tl|hands}} a length used to measure horses
* {{tl|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:
* <code><nowiki>{{convert|10|$/mi|$/km}}</nowiki></code> → {{convert|10|$/mi|$/km}}

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

==Parameter list==
{{convert/doc/parameter list}}

==Deprecated options==
{{Convert/doc/deprecations list}}

==TemplateData==
{{TemplateDataHeader}}

<templatedata>{
"description": "Converts measurements to other units.",
"params": {
"1": {
"label": "value",
"description": "the value to convert",
"type": "number"
},
"2": {
"label": "from unit",
"description": "",
"type": "string/line"
},
"3": {
"label": "to units",
"description": "the unit to convert into",
"type": "string/line"
},
"4": {
"label": "precision or suffix",
"description": "significant digits after decimal dot or, if negative, exponent of ten",
"type": "number"
},
"lk": {
"label": "link units",
"description": "“on” all, “in” input, “out” output or “off” no units",
"default": "off",
"type": "string/line"
},
"abbr": {
"label": "abbreviation",
"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",
"default": "out",
"type": "string/line"
},
"sp": {
"label": "spelling",
"description": "“us” display U.S. spelling of unit names",
"type": "string/line"
},
"adj": {
"label": "adjective",
"description": "adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end",
"type": "string/line"
},
"disp": {
"label": "conversion",
"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",
"default": "b",
"type": "string/line"
},
"order": {
"label": "ordering",
"description": "“flip” returns converted value first, input value second.",
"type": "string/line"
},
"sigfig": {
"label": "significant figures",
"description": "number that sets the number of significant figures",
"type": "number"
},
"round": {
"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",
"type": "string/line"
},
"comma": {
"label": "thousands separator",
"description": "Sets or suppresses thousand separator in the numbers. “off” = no separator; “gaps”: use space not comma; “5” and “gaps5”: only add separator when number > 5 positions (10,000 or more)",
"default": "on",
"type": "string/line"
},
"sortable": {
"label": "sort key",
"description": "“on” generates a hidden sort key",
"type": "string/line"
}
}}</templatedata>


==See also==
* {{Temp|Cvt}}
* {{Temp|SI units}}
{{Convert navs}}
<noinclude>
[[Category:Convert by module documentation| ]]
</noinclude><includeonly>
[[Category:Convert templates| ]]
[[Category:Conversion templates]]
[[Category:Numbers as words conversion templates]]
[[Category:Sorting templates]]
</includeonly>

Template:Convert/doc

2016-06-20T20:47:38Z

178.16.7.96: /* Flipping (reordering) the two measurements: {{convert|1|mi|m|order=flip|sigfig=5|abbr=off}} */

{{documentation subpage}}
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk| {{formatnum:789000}}+ }}}}
{{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}}
'''Template {{tl|convert}}''' ''calculates'' measurements from one unit (you can enter) to another one, and then ''presents the results''. For example:
:<code><nowiki>{{convert|2|km|mi}}</nowiki></code> → {{convert|2|km|mi}}
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> → {{convert|7|mi|km}}

The available '''units''' are listed [[#Units|below]]. Units are case-sensitive always ({{xt|kW}}, ''not'' {{!xt|KW}} and ''not'' {{!xt|kw}}). Multiple '''formatting''' and calculation options are listed below.

{{hatnote|See [[Help:Convert]] for more complete information}}
{{hatnote|For currency conversion into US dollars, see [[Template:To USD]]}}

==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
By default, the first value shows unit name spelled out, the second the symbol (or abbreviation). Use {{para|abbr|on/off}} to change this behaviour:
* <code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}

To abbreviate both:
* <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}}

{{para|abbr|in}} is the reverse behaviour to the default, {{para|abbr|out}}:
*<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{convert|1|lb|kg|abbr=in}}

===Convenience: {{tlf|cvt}} has {{para|abbr|on}} by default===
Template {{tl|cvt}} is similar to {{tlf|convert}}, but 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 equal to:
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{cvt|1|lb|kg|abbr=on}}

==Adjective: ''a 10-mile distance''==
Use {{para|adj|on}} to produce the adjective form. The difference:
:<code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> → {{convert|10|mi|km}} to go. ''(To compare, default)''
:<code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> → A {{convert|10|mi|km|adj=on}} distance. ''(Adjective form)''
This option does not work with {{para|abbr|on}}.

==Rounding: ''100 ft'' is ''30 m'' or ''30.5 m'' or ''30.48 m''?==
By definition, 100 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===
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 figures, whichever is more precise. An exception to this is ''rounding temperatures'' (see [[#Rounding temperatures|below]]).

{| class="wikitable"
|-
! colspan="3" | Examples of rounding
|-
|'''Input'''||'''Displays as'''||'''Note'''
|-
|<code><nowiki>{{convert|123|ft|m|-1}}</nowiki></code> || {{convert|123|ft|m|-1}} ||
|-
|<code><nowiki>{{convert|123|ft|m|0}}</nowiki></code> || {{convert|123|ft|m|0}} ||
|-
|<code><nowiki>{{convert|123|ft|m|1}}</nowiki></code> || {{convert|123|ft|m|1}} ||
|-
|<code><nowiki>{{convert|550|ft|m|0}}</nowiki></code> || {{convert|550|ft|m|0}} || Approximate value is 167.64 m
|-
|<code><nowiki>{{convert|550|ft|m}}</nowiki></code> || {{convert|550|ft|m}} || Rounds to 170, when approximate value is 167.64 m
|-
|<code><nowiki>{{convert|500|ft|m|0}}</nowiki></code> || {{convert|500|ft|m|0}} || Approximate value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|m}}</nowiki></code> || {{convert|500|ft|m}} || Rounds to 150, when approximate value is 152.4 m
|}

''Convert'' supports four types of rounding:

===Round to a given precision: ''use {{para|precision|}}''===
Specify the desired precision with the fourth unnamed parameter (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest 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: ''{{para|sigfig|}}''===
To specify the output number to be with ''n'' significant figures use {{para|sigfig|<number>}}:
* To compare: <code><nowiki>{{convert|1200|ft|m}}</nowiki></code> → {{convert|1200|ft|m}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki></code> → {{convert|1200|ft|m|sigfig=4}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=3}}</nowiki></code> → {{convert|1200|ft|m|sigfig=3}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=2}}</nowiki></code> → {{convert|1200|ft|m|sigfig=2}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki></code> → {{convert|1200|ft|m|sigfig=1}}
Setting {{para|sigfig|<=0}} is meaningless
* <code><nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki></code> → {{convert|1200|ft|m|sigfig=0}}

===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
Using {{para|round|5}} rounds the outcome to a multiple of 5.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<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.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> → {{convert|10|m|ft|round=25}}
:To compare: <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}}:
:<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> → {{convert|10 x 200 x 3000|m|ft|round=each}}

===Round to a multiple of a given fraction: ''{{frac|2|3|16}} inch''===
Specify the desired ''denominator'' using {{para|frac|<some positive integer>}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|3}}).
:<code><nowiki>{{convert|5.56|cm|in|frac=16}}</nowiki></code> → {{convert|5.56|cm|in|frac=16}}
:<code><nowiki>{{convert|8|cm|in|frac=4}}</nowiki></code> → {{convert|8|cm|in|frac=4}}
The fraction is reduced when possible:
:<code><nowiki>{{convert|8|cm|in|frac=100}}</nowiki></code> → {{convert|8|cm|in|frac=100}}
:<code><nowiki>{{convert|8|cm|in}}</nowiki></code> → {{convert|8|cm|in|sigfig=4}} (To compare)

==={{anchor|Rounding temperatures}}In temperatures: rounding ''°C'', ''°F'' and ''K''===
In temperatures, the conversion will be rounded either to precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.

#{{#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|-300|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}}

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 into five significant output digits because of the two numbers 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.

==Into multiple units: ''{{convert|10|C|F K}}''==
Separate the multiple output units by a space:
* <code><nowiki>{{convert|10|C|F K}}</nowiki></code> → {{convert|10|C|F K}}
* <code><nowiki>{{convert|5|km|mi nmi}}</nowiki></code> → {{convert|5|km|mi nmi}}
If the output unit names contain spaces, use a '+' separator.

See also:
* For multiple-unit options like ''1 ft 5 in'', see [[#In input]] and [[#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: 
{{Convert/doc/range separator list}}

===Multiple dimensions: ''{{convert|6|x|12|m|ft|abbr=on}}''===
; Use "by":
:<code><nowiki>{{convert|6|by|12|ft|m}}</nowiki></code> → {{convert|6|by|12|ft|m}}
;Use "×" or ""x"":
:<code><nowiki>{{convert|6|x|12|m|ft}}</nowiki></code> → {{convert|6|x|12|m|ft}}

In science, the formal way is to set <code>|x|</code> and {{para|abbr|on}} (keeping dimensions right, like in ''area = x km2''):
:<code><nowiki>{{convert|6|x|12|m|ft|abbr=on}}</nowiki></code> → {{convert|6|x|12|m|ft|abbr=on}}

===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:
* <code><nowiki>{{convert|1|ft|3|in|mm}}</nowiki></code> → {{convert|1|ft|3|in|mm}} (to compare)
* <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}}

==Words==
===Spelling of unit name: UK ''metre'' or US ''meter''?===
Default spelling of units is en-UK. 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}}

===Spell out numbers: ''ten miles''===
To write a number in words, use {{para|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}}:
* <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}}
* <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> → {{convert|10|mi|m|spell=On}}

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> → {{convert|10|mi|m|spell=on|abbr=off|sp=us}}

===Inserted before units: ''4 planted acres''===
*<code><nowiki>{{convert|4|acre||adj=pre|planted}}</nowiki></code> → {{convert|4|acre||adj=pre|planted}}
<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|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-}}

===After adjective unit: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
:<code><nowiki>{{convert|10|ft|m|adj=mid|-long}}</nowiki></code> → {{convert|10|ft|m|adj=mid|-long}}

===Plurals: ''1 inch, 2 inches''===
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}}

;Exception:
Entering the unit spelled <code>|foot|</code> forces singular output "foot", whatever the number is.
* <code><nowiki>{{convert|100|foot|abbr=off}}</nowiki></code> → {{convert|100|foot|abbr=off}}

==Numbers==

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

To illustrate, these are trivial calculations (from meter to meter), showing the multiplication factor:
* {{convert|12|Gm|m|abbr=on}}
* {{convert|12|μm|m|abbr=on}}

The prefix can be added before the SI unit (here: unit <code>m</code> for meter):
* <code><nowiki>{{convert|12|Gm|mi|abbr=on}}</nowiki></code> → {{convert|12|Gm|mi|abbr=on}}
* <code>Mm</code>: {{convert|12|Mm|mi|abbr=on}}
* <code>km</code>: {{convert|12|km|ft|abbr=on}}
* <code>mm</code>: {{convert|12|mm|in|abbr=on}}
* <code>μm</code>: {{convert|12|μm|mm|abbr=on}}
* <code>um</code>: {{convert|12|um|mm|abbr=on}} (letter "u" can be used for "μ" here)

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

As an exception, the non-SI unit "inch" can have the "μ" prefix too)
* <code><nowiki>{{convert|12|μm|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}

{{further|Help:Convert units#SI prefixes}}

===Engineering notation: ''7 × 106 m''===

====In the unit: ''e6m''====
[[Engineering notation|Engineering number notations]] like ''7{{smallcaps|E}}6'' (for 7 × 106) can be entered as a "prefix" to the unit:
:<code><nowiki>{{convert|7|e6m}}</nowiki></code> → {{convert|7|e6m}}
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−14''===
In [[scientific notation]], a number is written like {{rnd|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}}

===Input with fractions: ''{{convert|1+1/2|in|mm|1}}''===
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}}

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 (do not require a calculation)

===Output with horizontal fraction bar in: ''{{sfrac|1|2}} inch''===

Using a double slash (<code>//</code>) returns a horizontal bar fraction:
* <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}}

===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}}
*<code><nowiki>{{convert|1 234 567|m|ft}}</nowiki></code> → {{convert|1 234 567|m|ft}} {{nay}}

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}}</nowiki></code> → {{convert|1234567|m|ft}} (To compare, default)
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps}}

Setting {{para|comma|5}} or {{para|comma|gaps5}} will only add the separator when the number of digits is 5 or more:
*<code><nowiki>{{convert|1234|m|ft}}</nowiki></code> → {{convert|1234|m|ft}} (To compare, default)
*<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}}
*<code><nowiki>{{convert|1234|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234|m|ft|comma=gaps5}}
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps5}}

==Output manipulation==
===Brackets and separators: ''10 m [33 ft]''===
Punctuation that distinguishes the two measurements is set by {{para|disp|}}. 
Options are: <code>b</code> (the default), <code>sqbr</code>, <code>comma</code>, <code>or</code>, <code>br</code>, <code>x{{!}}…</code>:
* <code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}—''( ) 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=comma}}</nowiki></code> → {{convert|10|m|ft|disp=comma}}
* <code><nowiki>{{convert|10|m|ft|disp=or}}</nowiki></code> → {{convert|10|m|ft|disp=or}}

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

Also {{para|disp|br()}} will force a new line, and keep the brackets:
* <code><nowiki>{{convert|10|m|ft|disp=br()}}</nowiki></code> → {{convert|10|m|ft|disp=br()}}

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_}}—(To display spaces, use <code>&nbsp;</code>)

===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:
* <code><nowiki>{{convert|1|mi|m}}</nowiki></code> → {{convert|1|mi|m|sigfig=5|abbr=off}} (To compare, default)
* <code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> → {{convert|1|mi|m|order=flip|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}}

=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
It is possible to display only parts of the conversion result:


{| class="wikitable"
! Convert !! Output !! Description
|-
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}}
| Default, to compare
|-
| <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|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|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|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=out}}</nowiki></code> || {{convert|2|cuyd|m3|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
|}
===Display both input name and symbol: ''2 kilopascals [kPa]''===
Setting {{para|abbr|~}} returns both name and symbol of the first (input) unit:
:<code><nowiki>{{convert|2|kPa|psi|abbr=~}}</nowiki></code> → {{convert|2|kPa|psi|abbr=~}}
:<code><nowiki>A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure</nowiki></code> → {{nowrap|A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure}}

==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 showing numbers only===
Using {convert} in a table cell, with {{para|disp|table}} splits the result over two columns:
:<code><nowiki>{{convert|10|m|ft|disp=table}}</nowiki></code> → {{convert|10|m|ft|disp=table}}

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

The units are added as a column header:
:{| class=wikitable
! style="width:10em;" |  
! style="width:10em;" | m
! style="width:10em;" | ft
|-
| {{para|disp|table}}
| {{convert|10|m|ft|disp=table}}
|-
|{{para|disp|tablecen}}
| {{convert|20|m|ft|disp=tablecen}}
|-
|{{para|disp|<other>}} (default)
|{{convert|30|m|ft|disp=}}
|}

===Sorting===
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=700110000000000000010 metres (33&nbsp;ft)}}

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

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

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==
===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}}}}
<div style="height: 400px; overflow: auto; padding: 3px; border: 1px solid #aaa;">
{{Convert/list of units}}
</div>

==='per' units: ''kg/hl''===
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}}

===Units of difference===
When a number is the measurement for a ''difference'', one conversion is done. This may occur in temperatures (°C, °F, K). Compare this to a ''range'', when two conversions are done.

The only available units of difference are: {{para|C-change}}, {{para|F-change}} and {{para| K-change}}.

:{{#invoke:DemoTemplate|convert|10|C}} -- regular temperature
:{{#invoke:DemoTemplate|convert|10|C-change}} -- difference (e.g., "The temperature changed from 30 into 40 °C")
:{{#invoke:DemoTemplate|convert|10-15|C}} -- range (e.g., "The temperature is between 10 and 15 °C")

Consistently, into multiple units:
:<code><nowiki>A rise of {{convert|10|C-change|F-change K-change}}</nowiki></code> → A rise of {{convert|10|C-change|F-change K-change}}

===Multiple units: ''1 ft 5 in''===
====In input====
Base document {{slink|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 {{slink|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
* <code><nowiki>{{convert|2|m}}</nowiki></code> → {{convert|2|m}}—the default

See also:
* {{tl|hands}} a length used to measure horses
* {{tl|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:
* <code><nowiki>{{convert|10|$/mi|$/km}}</nowiki></code> → {{convert|10|$/mi|$/km}}

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

==Parameter list==
{{convert/doc/parameter list}}

==Deprecated options==
{{Convert/doc/deprecations list}}

==TemplateData==
{{TemplateDataHeader}}

<templatedata>{
"description": "Converts measurements to other units.",
"params": {
"1": {
"label": "value",
"description": "the value to convert",
"type": "number"
},
"2": {
"label": "from unit",
"description": "",
"type": "string/line"
},
"3": {
"label": "to units",
"description": "the unit to convert into",
"type": "string/line"
},
"4": {
"label": "precision or suffix",
"description": "significant digits after decimal dot or, if negative, exponent of ten",
"type": "number"
},
"lk": {
"label": "link units",
"description": "“on” all, “in” input, “out” output or “off” no units",
"default": "off",
"type": "string/line"
},
"abbr": {
"label": "abbreviation",
"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",
"default": "out",
"type": "string/line"
},
"sp": {
"label": "spelling",
"description": "“us” display U.S. spelling of unit names",
"type": "string/line"
},
"adj": {
"label": "adjective",
"description": "adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end",
"type": "string/line"
},
"disp": {
"label": "conversion",
"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",
"default": "b",
"type": "string/line"
},
"order": {
"label": "ordering",
"description": "“flip” returns converted value first, input value second.",
"type": "string/line"
},
"sigfig": {
"label": "significant figures",
"description": "number that sets the number of significant figures",
"type": "number"
},
"round": {
"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",
"type": "string/line"
},
"comma": {
"label": "thousands separator",
"description": "Sets or suppresses thousand separator in the numbers. “off” = no separator; “gaps”: use space not comma; “5” and “gaps5”: only add separator when number > 5 positions (10,000 or more)",
"default": "on",
"type": "string/line"
},
"sortable": {
"label": "sort key",
"description": "“on” generates a hidden sort key",
"type": "string/line"
}
}}</templatedata>


==See also==
* {{Temp|Cvt}}
* {{Temp|SI units}}
{{Convert navs}}
<noinclude>
[[Category:Convert by module documentation| ]]
</noinclude><includeonly>
[[Category:Convert templates| ]]
[[Category:Conversion templates]]
[[Category:Numbers as words conversion templates]]
[[Category:Sorting templates]]
</includeonly>

Template:Convert/doc

2016-06-20T20:46:51Z

178.16.7.96: /* Brackets and separators: 10 m [33 ft] */

{{documentation subpage}}
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk| {{formatnum:789000}}+ }}}}
{{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}}
'''Template {{tl|convert}}''' ''calculates'' measurements from one unit (you can enter) to another one, and then ''presents the results''. For example:
:<code><nowiki>{{convert|2|km|mi}}</nowiki></code> → {{convert|2|km|mi}}
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> → {{convert|7|mi|km}}

The available '''units''' are listed [[#Units|below]]. Units are case-sensitive always ({{xt|kW}}, ''not'' {{!xt|KW}} and ''not'' {{!xt|kw}}). Multiple '''formatting''' and calculation options are listed below.

{{hatnote|See [[Help:Convert]] for more complete information}}
{{hatnote|For currency conversion into US dollars, see [[Template:To USD]]}}

==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
By default, the first value shows unit name spelled out, the second the symbol (or abbreviation). Use {{para|abbr|on/off}} to change this behaviour:
* <code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}

To abbreviate both:
* <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}}

{{para|abbr|in}} is the reverse behaviour to the default, {{para|abbr|out}}:
*<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{convert|1|lb|kg|abbr=in}}

===Convenience: {{tlf|cvt}} has {{para|abbr|on}} by default===
Template {{tl|cvt}} is similar to {{tlf|convert}}, but 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 equal to:
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{cvt|1|lb|kg|abbr=on}}

==Adjective: ''a 10-mile distance''==
Use {{para|adj|on}} to produce the adjective form. The difference:
:<code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> → {{convert|10|mi|km}} to go. ''(To compare, default)''
:<code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> → A {{convert|10|mi|km|adj=on}} distance. ''(Adjective form)''
This option does not work with {{para|abbr|on}}.

==Rounding: ''100 ft'' is ''30 m'' or ''30.5 m'' or ''30.48 m''?==
By definition, 100 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===
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 figures, whichever is more precise. An exception to this is ''rounding temperatures'' (see [[#Rounding temperatures|below]]).

{| class="wikitable"
|-
! colspan="3" | Examples of rounding
|-
|'''Input'''||'''Displays as'''||'''Note'''
|-
|<code><nowiki>{{convert|123|ft|m|-1}}</nowiki></code> || {{convert|123|ft|m|-1}} ||
|-
|<code><nowiki>{{convert|123|ft|m|0}}</nowiki></code> || {{convert|123|ft|m|0}} ||
|-
|<code><nowiki>{{convert|123|ft|m|1}}</nowiki></code> || {{convert|123|ft|m|1}} ||
|-
|<code><nowiki>{{convert|550|ft|m|0}}</nowiki></code> || {{convert|550|ft|m|0}} || Approximate value is 167.64 m
|-
|<code><nowiki>{{convert|550|ft|m}}</nowiki></code> || {{convert|550|ft|m}} || Rounds to 170, when approximate value is 167.64 m
|-
|<code><nowiki>{{convert|500|ft|m|0}}</nowiki></code> || {{convert|500|ft|m|0}} || Approximate value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|m}}</nowiki></code> || {{convert|500|ft|m}} || Rounds to 150, when approximate value is 152.4 m
|}

''Convert'' supports four types of rounding:

===Round to a given precision: ''use {{para|precision|}}''===
Specify the desired precision with the fourth unnamed parameter (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest 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: ''{{para|sigfig|}}''===
To specify the output number to be with ''n'' significant figures use {{para|sigfig|<number>}}:
* To compare: <code><nowiki>{{convert|1200|ft|m}}</nowiki></code> → {{convert|1200|ft|m}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki></code> → {{convert|1200|ft|m|sigfig=4}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=3}}</nowiki></code> → {{convert|1200|ft|m|sigfig=3}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=2}}</nowiki></code> → {{convert|1200|ft|m|sigfig=2}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki></code> → {{convert|1200|ft|m|sigfig=1}}
Setting {{para|sigfig|<=0}} is meaningless
* <code><nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki></code> → {{convert|1200|ft|m|sigfig=0}}

===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
Using {{para|round|5}} rounds the outcome to a multiple of 5.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<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.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> → {{convert|10|m|ft|round=25}}
:To compare: <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}}:
:<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> → {{convert|10 x 200 x 3000|m|ft|round=each}}

===Round to a multiple of a given fraction: ''{{frac|2|3|16}} inch''===
Specify the desired ''denominator'' using {{para|frac|<some positive integer>}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|3}}).
:<code><nowiki>{{convert|5.56|cm|in|frac=16}}</nowiki></code> → {{convert|5.56|cm|in|frac=16}}
:<code><nowiki>{{convert|8|cm|in|frac=4}}</nowiki></code> → {{convert|8|cm|in|frac=4}}
The fraction is reduced when possible:
:<code><nowiki>{{convert|8|cm|in|frac=100}}</nowiki></code> → {{convert|8|cm|in|frac=100}}
:<code><nowiki>{{convert|8|cm|in}}</nowiki></code> → {{convert|8|cm|in|sigfig=4}} (To compare)

==={{anchor|Rounding temperatures}}In temperatures: rounding ''°C'', ''°F'' and ''K''===
In temperatures, the conversion will be rounded either to precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.

#{{#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|-300|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}}

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 into five significant output digits because of the two numbers 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.

==Into multiple units: ''{{convert|10|C|F K}}''==
Separate the multiple output units by a space:
* <code><nowiki>{{convert|10|C|F K}}</nowiki></code> → {{convert|10|C|F K}}
* <code><nowiki>{{convert|5|km|mi nmi}}</nowiki></code> → {{convert|5|km|mi nmi}}
If the output unit names contain spaces, use a '+' separator.

See also:
* For multiple-unit options like ''1 ft 5 in'', see [[#In input]] and [[#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: 
{{Convert/doc/range separator list}}

===Multiple dimensions: ''{{convert|6|x|12|m|ft|abbr=on}}''===
; Use "by":
:<code><nowiki>{{convert|6|by|12|ft|m}}</nowiki></code> → {{convert|6|by|12|ft|m}}
;Use "×" or ""x"":
:<code><nowiki>{{convert|6|x|12|m|ft}}</nowiki></code> → {{convert|6|x|12|m|ft}}

In science, the formal way is to set <code>|x|</code> and {{para|abbr|on}} (keeping dimensions right, like in ''area = x km2''):
:<code><nowiki>{{convert|6|x|12|m|ft|abbr=on}}</nowiki></code> → {{convert|6|x|12|m|ft|abbr=on}}

===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:
* <code><nowiki>{{convert|1|ft|3|in|mm}}</nowiki></code> → {{convert|1|ft|3|in|mm}} (to compare)
* <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}}

==Words==
===Spelling of unit name: UK ''metre'' or US ''meter''?===
Default spelling of units is en-UK. 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}}

===Spell out numbers: ''ten miles''===
To write a number in words, use {{para|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}}:
* <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}}
* <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> → {{convert|10|mi|m|spell=On}}

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> → {{convert|10|mi|m|spell=on|abbr=off|sp=us}}

===Inserted before units: ''4 planted acres''===
*<code><nowiki>{{convert|4|acre||adj=pre|planted}}</nowiki></code> → {{convert|4|acre||adj=pre|planted}}
<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|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-}}

===After adjective unit: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
:<code><nowiki>{{convert|10|ft|m|adj=mid|-long}}</nowiki></code> → {{convert|10|ft|m|adj=mid|-long}}

===Plurals: ''1 inch, 2 inches''===
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}}

;Exception:
Entering the unit spelled <code>|foot|</code> forces singular output "foot", whatever the number is.
* <code><nowiki>{{convert|100|foot|abbr=off}}</nowiki></code> → {{convert|100|foot|abbr=off}}

==Numbers==

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

To illustrate, these are trivial calculations (from meter to meter), showing the multiplication factor:
* {{convert|12|Gm|m|abbr=on}}
* {{convert|12|μm|m|abbr=on}}

The prefix can be added before the SI unit (here: unit <code>m</code> for meter):
* <code><nowiki>{{convert|12|Gm|mi|abbr=on}}</nowiki></code> → {{convert|12|Gm|mi|abbr=on}}
* <code>Mm</code>: {{convert|12|Mm|mi|abbr=on}}
* <code>km</code>: {{convert|12|km|ft|abbr=on}}
* <code>mm</code>: {{convert|12|mm|in|abbr=on}}
* <code>μm</code>: {{convert|12|μm|mm|abbr=on}}
* <code>um</code>: {{convert|12|um|mm|abbr=on}} (letter "u" can be used for "μ" here)

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

As an exception, the non-SI unit "inch" can have the "μ" prefix too)
* <code><nowiki>{{convert|12|μm|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}

{{further|Help:Convert units#SI prefixes}}

===Engineering notation: ''7 × 106 m''===

====In the unit: ''e6m''====
[[Engineering notation|Engineering number notations]] like ''7{{smallcaps|E}}6'' (for 7 × 106) can be entered as a "prefix" to the unit:
:<code><nowiki>{{convert|7|e6m}}</nowiki></code> → {{convert|7|e6m}}
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−14''===
In [[scientific notation]], a number is written like {{rnd|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}}

===Input with fractions: ''{{convert|1+1/2|in|mm|1}}''===
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}}

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 (do not require a calculation)

===Output with horizontal fraction bar in: ''{{sfrac|1|2}} inch''===

Using a double slash (<code>//</code>) returns a horizontal bar fraction:
* <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}}

===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}}
*<code><nowiki>{{convert|1 234 567|m|ft}}</nowiki></code> → {{convert|1 234 567|m|ft}} {{nay}}

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}}</nowiki></code> → {{convert|1234567|m|ft}} (To compare, default)
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps}}

Setting {{para|comma|5}} or {{para|comma|gaps5}} will only add the separator when the number of digits is 5 or more:
*<code><nowiki>{{convert|1234|m|ft}}</nowiki></code> → {{convert|1234|m|ft}} (To compare, default)
*<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}}
*<code><nowiki>{{convert|1234|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234|m|ft|comma=gaps5}}
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps5}}

==Output manipulation==
===Brackets and separators: ''10 m [33 ft]''===
Punctuation that distinguishes the two measurements is set by {{para|disp|}}. 
Options are: <code>b</code> (the default), <code>sqbr</code>, <code>comma</code>, <code>or</code>, <code>br</code>, <code>x{{!}}…</code>:
* <code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}—''( ) 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=comma}}</nowiki></code> → {{convert|10|m|ft|disp=comma}}
* <code><nowiki>{{convert|10|m|ft|disp=or}}</nowiki></code> → {{convert|10|m|ft|disp=or}}

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

Also {{para|disp|br()}} will force a new line, and keep the brackets:
* <code><nowiki>{{convert|10|m|ft|disp=br()}}</nowiki></code> → {{convert|10|m|ft|disp=br()}}

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_}}—(To display spaces, use <code>&nbsp;</code>)

===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:
:<code><nowiki>{{convert|1|mi|m}}</nowiki></code> → {{convert|1|mi|m|sigfig=5|abbr=off}} (To compare, default)
:<code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> → {{convert|1|mi|m|order=flip|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}}

=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
It is possible to display only parts of the conversion result:


{| class="wikitable"
! Convert !! Output !! Description
|-
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}}
| Default, to compare
|-
| <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|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|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|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=out}}</nowiki></code> || {{convert|2|cuyd|m3|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
|}
===Display both input name and symbol: ''2 kilopascals [kPa]''===
Setting {{para|abbr|~}} returns both name and symbol of the first (input) unit:
:<code><nowiki>{{convert|2|kPa|psi|abbr=~}}</nowiki></code> → {{convert|2|kPa|psi|abbr=~}}
:<code><nowiki>A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure</nowiki></code> → {{nowrap|A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure}}

==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 showing numbers only===
Using {convert} in a table cell, with {{para|disp|table}} splits the result over two columns:
:<code><nowiki>{{convert|10|m|ft|disp=table}}</nowiki></code> → {{convert|10|m|ft|disp=table}}

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

The units are added as a column header:
:{| class=wikitable
! style="width:10em;" |  
! style="width:10em;" | m
! style="width:10em;" | ft
|-
| {{para|disp|table}}
| {{convert|10|m|ft|disp=table}}
|-
|{{para|disp|tablecen}}
| {{convert|20|m|ft|disp=tablecen}}
|-
|{{para|disp|<other>}} (default)
|{{convert|30|m|ft|disp=}}
|}

===Sorting===
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=700110000000000000010 metres (33&nbsp;ft)}}

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

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

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==
===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}}}}
<div style="height: 400px; overflow: auto; padding: 3px; border: 1px solid #aaa;">
{{Convert/list of units}}
</div>

==='per' units: ''kg/hl''===
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}}

===Units of difference===
When a number is the measurement for a ''difference'', one conversion is done. This may occur in temperatures (°C, °F, K). Compare this to a ''range'', when two conversions are done.

The only available units of difference are: {{para|C-change}}, {{para|F-change}} and {{para| K-change}}.

:{{#invoke:DemoTemplate|convert|10|C}} -- regular temperature
:{{#invoke:DemoTemplate|convert|10|C-change}} -- difference (e.g., "The temperature changed from 30 into 40 °C")
:{{#invoke:DemoTemplate|convert|10-15|C}} -- range (e.g., "The temperature is between 10 and 15 °C")

Consistently, into multiple units:
:<code><nowiki>A rise of {{convert|10|C-change|F-change K-change}}</nowiki></code> → A rise of {{convert|10|C-change|F-change K-change}}

===Multiple units: ''1 ft 5 in''===
====In input====
Base document {{slink|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 {{slink|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
* <code><nowiki>{{convert|2|m}}</nowiki></code> → {{convert|2|m}}—the default

See also:
* {{tl|hands}} a length used to measure horses
* {{tl|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:
* <code><nowiki>{{convert|10|$/mi|$/km}}</nowiki></code> → {{convert|10|$/mi|$/km}}

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

==Parameter list==
{{convert/doc/parameter list}}

==Deprecated options==
{{Convert/doc/deprecations list}}

==TemplateData==
{{TemplateDataHeader}}

<templatedata>{
"description": "Converts measurements to other units.",
"params": {
"1": {
"label": "value",
"description": "the value to convert",
"type": "number"
},
"2": {
"label": "from unit",
"description": "",
"type": "string/line"
},
"3": {
"label": "to units",
"description": "the unit to convert into",
"type": "string/line"
},
"4": {
"label": "precision or suffix",
"description": "significant digits after decimal dot or, if negative, exponent of ten",
"type": "number"
},
"lk": {
"label": "link units",
"description": "“on” all, “in” input, “out” output or “off” no units",
"default": "off",
"type": "string/line"
},
"abbr": {
"label": "abbreviation",
"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",
"default": "out",
"type": "string/line"
},
"sp": {
"label": "spelling",
"description": "“us” display U.S. spelling of unit names",
"type": "string/line"
},
"adj": {
"label": "adjective",
"description": "adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end",
"type": "string/line"
},
"disp": {
"label": "conversion",
"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",
"default": "b",
"type": "string/line"
},
"order": {
"label": "ordering",
"description": "“flip” returns converted value first, input value second.",
"type": "string/line"
},
"sigfig": {
"label": "significant figures",
"description": "number that sets the number of significant figures",
"type": "number"
},
"round": {
"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",
"type": "string/line"
},
"comma": {
"label": "thousands separator",
"description": "Sets or suppresses thousand separator in the numbers. “off” = no separator; “gaps”: use space not comma; “5” and “gaps5”: only add separator when number > 5 positions (10,000 or more)",
"default": "on",
"type": "string/line"
},
"sortable": {
"label": "sort key",
"description": "“on” generates a hidden sort key",
"type": "string/line"
}
}}</templatedata>


==See also==
* {{Temp|Cvt}}
* {{Temp|SI units}}
{{Convert navs}}
<noinclude>
[[Category:Convert by module documentation| ]]
</noinclude><includeonly>
[[Category:Convert templates| ]]
[[Category:Conversion templates]]
[[Category:Numbers as words conversion templates]]
[[Category:Sorting templates]]
</includeonly>

Template:Convert/doc

2016-06-20T20:40:14Z

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

{{documentation subpage}}
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk| {{formatnum:789000}}+ }}}}
{{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}}
'''Template {{tl|convert}}''' ''calculates'' measurements from one unit (you can enter) to another one, and then ''presents the results''. For example:
:<code><nowiki>{{convert|2|km|mi}}</nowiki></code> → {{convert|2|km|mi}}
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> → {{convert|7|mi|km}}

The available '''units''' are listed [[#Units|below]]. Units are case-sensitive always ({{xt|kW}}, ''not'' {{!xt|KW}} and ''not'' {{!xt|kw}}). Multiple '''formatting''' and calculation options are listed below.

{{hatnote|See [[Help:Convert]] for more complete information}}
{{hatnote|For currency conversion into US dollars, see [[Template:To USD]]}}

==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
By default, the first value shows unit name spelled out, the second the symbol (or abbreviation). Use {{para|abbr|on/off}} to change this behaviour:
* <code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}

To abbreviate both:
* <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}}

{{para|abbr|in}} is the reverse behaviour to the default, {{para|abbr|out}}:
*<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{convert|1|lb|kg|abbr=in}}

===Convenience: {{tlf|cvt}} has {{para|abbr|on}} by default===
Template {{tl|cvt}} is similar to {{tlf|convert}}, but 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 equal to:
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{cvt|1|lb|kg|abbr=on}}

==Adjective: ''a 10-mile distance''==
Use {{para|adj|on}} to produce the adjective form. The difference:
:<code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> → {{convert|10|mi|km}} to go. ''(To compare, default)''
:<code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> → A {{convert|10|mi|km|adj=on}} distance. ''(Adjective form)''
This option does not work with {{para|abbr|on}}.

==Rounding: ''100 ft'' is ''30 m'' or ''30.5 m'' or ''30.48 m''?==
By definition, 100 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===
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 figures, whichever is more precise. An exception to this is ''rounding temperatures'' (see [[#Rounding temperatures|below]]).

{| class="wikitable"
|-
! colspan="3" | Examples of rounding
|-
|'''Input'''||'''Displays as'''||'''Note'''
|-
|<code><nowiki>{{convert|123|ft|m|-1}}</nowiki></code> || {{convert|123|ft|m|-1}} ||
|-
|<code><nowiki>{{convert|123|ft|m|0}}</nowiki></code> || {{convert|123|ft|m|0}} ||
|-
|<code><nowiki>{{convert|123|ft|m|1}}</nowiki></code> || {{convert|123|ft|m|1}} ||
|-
|<code><nowiki>{{convert|550|ft|m|0}}</nowiki></code> || {{convert|550|ft|m|0}} || Approximate value is 167.64 m
|-
|<code><nowiki>{{convert|550|ft|m}}</nowiki></code> || {{convert|550|ft|m}} || Rounds to 170, when approximate value is 167.64 m
|-
|<code><nowiki>{{convert|500|ft|m|0}}</nowiki></code> || {{convert|500|ft|m|0}} || Approximate value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|m}}</nowiki></code> || {{convert|500|ft|m}} || Rounds to 150, when approximate value is 152.4 m
|}

''Convert'' supports four types of rounding:

===Round to a given precision: ''use {{para|precision|}}''===
Specify the desired precision with the fourth unnamed parameter (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest 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: ''{{para|sigfig|}}''===
To specify the output number to be with ''n'' significant figures use {{para|sigfig|<number>}}:
* To compare: <code><nowiki>{{convert|1200|ft|m}}</nowiki></code> → {{convert|1200|ft|m}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki></code> → {{convert|1200|ft|m|sigfig=4}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=3}}</nowiki></code> → {{convert|1200|ft|m|sigfig=3}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=2}}</nowiki></code> → {{convert|1200|ft|m|sigfig=2}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki></code> → {{convert|1200|ft|m|sigfig=1}}
Setting {{para|sigfig|<=0}} is meaningless
* <code><nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki></code> → {{convert|1200|ft|m|sigfig=0}}

===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
Using {{para|round|5}} rounds the outcome to a multiple of 5.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<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.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> → {{convert|10|m|ft|round=25}}
:To compare: <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}}:
:<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> → {{convert|10 x 200 x 3000|m|ft|round=each}}

===Round to a multiple of a given fraction: ''{{frac|2|3|16}} inch''===
Specify the desired ''denominator'' using {{para|frac|<some positive integer>}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|3}}).
:<code><nowiki>{{convert|5.56|cm|in|frac=16}}</nowiki></code> → {{convert|5.56|cm|in|frac=16}}
:<code><nowiki>{{convert|8|cm|in|frac=4}}</nowiki></code> → {{convert|8|cm|in|frac=4}}
The fraction is reduced when possible:
:<code><nowiki>{{convert|8|cm|in|frac=100}}</nowiki></code> → {{convert|8|cm|in|frac=100}}
:<code><nowiki>{{convert|8|cm|in}}</nowiki></code> → {{convert|8|cm|in|sigfig=4}} (To compare)

==={{anchor|Rounding temperatures}}In temperatures: rounding ''°C'', ''°F'' and ''K''===
In temperatures, the conversion will be rounded either to precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.

#{{#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|-300|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}}

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 into five significant output digits because of the two numbers 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.

==Into multiple units: ''{{convert|10|C|F K}}''==
Separate the multiple output units by a space:
* <code><nowiki>{{convert|10|C|F K}}</nowiki></code> → {{convert|10|C|F K}}
* <code><nowiki>{{convert|5|km|mi nmi}}</nowiki></code> → {{convert|5|km|mi nmi}}
If the output unit names contain spaces, use a '+' separator.

See also:
* For multiple-unit options like ''1 ft 5 in'', see [[#In input]] and [[#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: 
{{Convert/doc/range separator list}}

===Multiple dimensions: ''{{convert|6|x|12|m|ft|abbr=on}}''===
; Use "by":
:<code><nowiki>{{convert|6|by|12|ft|m}}</nowiki></code> → {{convert|6|by|12|ft|m}}
;Use "×" or ""x"":
:<code><nowiki>{{convert|6|x|12|m|ft}}</nowiki></code> → {{convert|6|x|12|m|ft}}

In science, the formal way is to set <code>|x|</code> and {{para|abbr|on}} (keeping dimensions right, like in ''area = x km2''):
:<code><nowiki>{{convert|6|x|12|m|ft|abbr=on}}</nowiki></code> → {{convert|6|x|12|m|ft|abbr=on}}

===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:
* <code><nowiki>{{convert|1|ft|3|in|mm}}</nowiki></code> → {{convert|1|ft|3|in|mm}} (to compare)
* <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}}

==Words==
===Spelling of unit name: UK ''metre'' or US ''meter''?===
Default spelling of units is en-UK. 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}}

===Spell out numbers: ''ten miles''===
To write a number in words, use {{para|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}}:
* <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}}
* <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> → {{convert|10|mi|m|spell=On}}

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> → {{convert|10|mi|m|spell=on|abbr=off|sp=us}}

===Inserted before units: ''4 planted acres''===
*<code><nowiki>{{convert|4|acre||adj=pre|planted}}</nowiki></code> → {{convert|4|acre||adj=pre|planted}}
<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|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-}}

===After adjective unit: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
:<code><nowiki>{{convert|10|ft|m|adj=mid|-long}}</nowiki></code> → {{convert|10|ft|m|adj=mid|-long}}

===Plurals: ''1 inch, 2 inches''===
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}}

;Exception:
Entering the unit spelled <code>|foot|</code> forces singular output "foot", whatever the number is.
* <code><nowiki>{{convert|100|foot|abbr=off}}</nowiki></code> → {{convert|100|foot|abbr=off}}

==Numbers==

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

To illustrate, these are trivial calculations (from meter to meter), showing the multiplication factor:
* {{convert|12|Gm|m|abbr=on}}
* {{convert|12|μm|m|abbr=on}}

The prefix can be added before the SI unit (here: unit <code>m</code> for meter):
* <code><nowiki>{{convert|12|Gm|mi|abbr=on}}</nowiki></code> → {{convert|12|Gm|mi|abbr=on}}
* <code>Mm</code>: {{convert|12|Mm|mi|abbr=on}}
* <code>km</code>: {{convert|12|km|ft|abbr=on}}
* <code>mm</code>: {{convert|12|mm|in|abbr=on}}
* <code>μm</code>: {{convert|12|μm|mm|abbr=on}}
* <code>um</code>: {{convert|12|um|mm|abbr=on}} (letter "u" can be used for "μ" here)

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

As an exception, the non-SI unit "inch" can have the "μ" prefix too)
* <code><nowiki>{{convert|12|μm|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}

{{further|Help:Convert units#SI prefixes}}

===Engineering notation: ''7 × 106 m''===

====In the unit: ''e6m''====
[[Engineering notation|Engineering number notations]] like ''7{{smallcaps|E}}6'' (for 7 × 106) can be entered as a "prefix" to the unit:
:<code><nowiki>{{convert|7|e6m}}</nowiki></code> → {{convert|7|e6m}}
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−14''===
In [[scientific notation]], a number is written like {{rnd|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}}

===Input with fractions: ''{{convert|1+1/2|in|mm|1}}''===
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}}

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 (do not require a calculation)

===Output with horizontal fraction bar in: ''{{sfrac|1|2}} inch''===

Using a double slash (<code>//</code>) returns a horizontal bar fraction:
* <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}}

===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}}
*<code><nowiki>{{convert|1 234 567|m|ft}}</nowiki></code> → {{convert|1 234 567|m|ft}} {{nay}}

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}}</nowiki></code> → {{convert|1234567|m|ft}} (To compare, default)
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps}}

Setting {{para|comma|5}} or {{para|comma|gaps5}} will only add the separator when the number of digits is 5 or more:
*<code><nowiki>{{convert|1234|m|ft}}</nowiki></code> → {{convert|1234|m|ft}} (To compare, default)
*<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}}
*<code><nowiki>{{convert|1234|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234|m|ft|comma=gaps5}}
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps5}}

==Output manipulation==
===Brackets and separators: ''10 m [33 ft]''===
Punctuation that distinguishes the two measurements is set by {{para|disp|}}. 
Options are: <code>b</code> (the default), <code>sqbr</code>, <code>comma</code>, <code>or</code>, <code>br</code>, <code>x{{!}}≈...</code>:
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}—''( ) 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=comma}}</nowiki></code> → {{convert|10|m|ft|disp=comma}}
:<code><nowiki>{{convert|10|m|ft|disp=or}}</nowiki></code> → {{convert|10|m|ft|disp=or}}

Setting {{para|disp|br}} will force a new line (<code> </code>)
:<code><nowiki>{{convert|10|m|ft|disp=br}}</nowiki></code> → {{convert|10|m|ft|disp=br}}
Also {{para|disp|br()}} will force a new line, and keep the brackets:
:<code><nowiki>{{convert|10|m|ft|disp=br()}}</nowiki></code> → {{convert|10|m|ft|disp=br()}}

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_}}—(To display spaces, use <code>&nbsp;</code>)

===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:
:<code><nowiki>{{convert|1|mi|m}}</nowiki></code> → {{convert|1|mi|m|sigfig=5|abbr=off}} (To compare, default)
:<code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> → {{convert|1|mi|m|order=flip|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}}

=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
It is possible to display only parts of the conversion result:


{| class="wikitable"
! Convert !! Output !! Description
|-
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}}
| Default, to compare
|-
| <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|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|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|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=out}}</nowiki></code> || {{convert|2|cuyd|m3|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
|}
===Display both input name and symbol: ''2 kilopascals [kPa]''===
Setting {{para|abbr|~}} returns both name and symbol of the first (input) unit:
:<code><nowiki>{{convert|2|kPa|psi|abbr=~}}</nowiki></code> → {{convert|2|kPa|psi|abbr=~}}
:<code><nowiki>A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure</nowiki></code> → {{nowrap|A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure}}

==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 showing numbers only===
Using {convert} in a table cell, with {{para|disp|table}} splits the result over two columns:
:<code><nowiki>{{convert|10|m|ft|disp=table}}</nowiki></code> → {{convert|10|m|ft|disp=table}}

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

The units are added as a column header:
:{| class=wikitable
! style="width:10em;" |  
! style="width:10em;" | m
! style="width:10em;" | ft
|-
| {{para|disp|table}}
| {{convert|10|m|ft|disp=table}}
|-
|{{para|disp|tablecen}}
| {{convert|20|m|ft|disp=tablecen}}
|-
|{{para|disp|<other>}} (default)
|{{convert|30|m|ft|disp=}}
|}

===Sorting===
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=700110000000000000010 metres (33&nbsp;ft)}}

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

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

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==
===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}}}}
<div style="height: 400px; overflow: auto; padding: 3px; border: 1px solid #aaa;">
{{Convert/list of units}}
</div>

==='per' units: ''kg/hl''===
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}}

===Units of difference===
When a number is the measurement for a ''difference'', one conversion is done. This may occur in temperatures (°C, °F, K). Compare this to a ''range'', when two conversions are done.

The only available units of difference are: {{para|C-change}}, {{para|F-change}} and {{para| K-change}}.

:{{#invoke:DemoTemplate|convert|10|C}} -- regular temperature
:{{#invoke:DemoTemplate|convert|10|C-change}} -- difference (e.g., "The temperature changed from 30 into 40 °C")
:{{#invoke:DemoTemplate|convert|10-15|C}} -- range (e.g., "The temperature is between 10 and 15 °C")

Consistently, into multiple units:
:<code><nowiki>A rise of {{convert|10|C-change|F-change K-change}}</nowiki></code> → A rise of {{convert|10|C-change|F-change K-change}}

===Multiple units: ''1 ft 5 in''===
====In input====
Base document {{slink|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 {{slink|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
* <code><nowiki>{{convert|2|m}}</nowiki></code> → {{convert|2|m}}—the default

See also:
* {{tl|hands}} a length used to measure horses
* {{tl|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:
* <code><nowiki>{{convert|10|$/mi|$/km}}</nowiki></code> → {{convert|10|$/mi|$/km}}

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

==Parameter list==
{{convert/doc/parameter list}}

==Deprecated options==
{{Convert/doc/deprecations list}}

==TemplateData==
{{TemplateDataHeader}}

<templatedata>{
"description": "Converts measurements to other units.",
"params": {
"1": {
"label": "value",
"description": "the value to convert",
"type": "number"
},
"2": {
"label": "from unit",
"description": "",
"type": "string/line"
},
"3": {
"label": "to units",
"description": "the unit to convert into",
"type": "string/line"
},
"4": {
"label": "precision or suffix",
"description": "significant digits after decimal dot or, if negative, exponent of ten",
"type": "number"
},
"lk": {
"label": "link units",
"description": "“on” all, “in” input, “out” output or “off” no units",
"default": "off",
"type": "string/line"
},
"abbr": {
"label": "abbreviation",
"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",
"default": "out",
"type": "string/line"
},
"sp": {
"label": "spelling",
"description": "“us” display U.S. spelling of unit names",
"type": "string/line"
},
"adj": {
"label": "adjective",
"description": "adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end",
"type": "string/line"
},
"disp": {
"label": "conversion",
"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",
"default": "b",
"type": "string/line"
},
"order": {
"label": "ordering",
"description": "“flip” returns converted value first, input value second.",
"type": "string/line"
},
"sigfig": {
"label": "significant figures",
"description": "number that sets the number of significant figures",
"type": "number"
},
"round": {
"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",
"type": "string/line"
},
"comma": {
"label": "thousands separator",
"description": "Sets or suppresses thousand separator in the numbers. “off” = no separator; “gaps”: use space not comma; “5” and “gaps5”: only add separator when number > 5 positions (10,000 or more)",
"default": "on",
"type": "string/line"
},
"sortable": {
"label": "sort key",
"description": "“on” generates a hidden sort key",
"type": "string/line"
}
}}</templatedata>


==See also==
* {{Temp|Cvt}}
* {{Temp|SI units}}
{{Convert navs}}
<noinclude>
[[Category:Convert by module documentation| ]]
</noinclude><includeonly>
[[Category:Convert templates| ]]
[[Category:Conversion templates]]
[[Category:Numbers as words conversion templates]]
[[Category:Sorting templates]]
</includeonly>

Template:Convert/doc

2016-06-20T20:39:21Z

178.16.7.96: /* Spell out numbers: ten miles */

{{documentation subpage}}
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk| {{formatnum:789000}}+ }}}}
{{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}}
'''Template {{tl|convert}}''' ''calculates'' measurements from one unit (you can enter) to another one, and then ''presents the results''. For example:
:<code><nowiki>{{convert|2|km|mi}}</nowiki></code> → {{convert|2|km|mi}}
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> → {{convert|7|mi|km}}

The available '''units''' are listed [[#Units|below]]. Units are case-sensitive always ({{xt|kW}}, ''not'' {{!xt|KW}} and ''not'' {{!xt|kw}}). Multiple '''formatting''' and calculation options are listed below.

{{hatnote|See [[Help:Convert]] for more complete information}}
{{hatnote|For currency conversion into US dollars, see [[Template:To USD]]}}

==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
By default, the first value shows unit name spelled out, the second the symbol (or abbreviation). Use {{para|abbr|on/off}} to change this behaviour:
* <code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}

To abbreviate both:
* <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}}

{{para|abbr|in}} is the reverse behaviour to the default, {{para|abbr|out}}:
*<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{convert|1|lb|kg|abbr=in}}

===Convenience: {{tlf|cvt}} has {{para|abbr|on}} by default===
Template {{tl|cvt}} is similar to {{tlf|convert}}, but 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 equal to:
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{cvt|1|lb|kg|abbr=on}}

==Adjective: ''a 10-mile distance''==
Use {{para|adj|on}} to produce the adjective form. The difference:
:<code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> → {{convert|10|mi|km}} to go. ''(To compare, default)''
:<code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> → A {{convert|10|mi|km|adj=on}} distance. ''(Adjective form)''
This option does not work with {{para|abbr|on}}.

==Rounding: ''100 ft'' is ''30 m'' or ''30.5 m'' or ''30.48 m''?==
By definition, 100 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===
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 figures, whichever is more precise. An exception to this is ''rounding temperatures'' (see [[#Rounding temperatures|below]]).

{| class="wikitable"
|-
! colspan="3" | Examples of rounding
|-
|'''Input'''||'''Displays as'''||'''Note'''
|-
|<code><nowiki>{{convert|123|ft|m|-1}}</nowiki></code> || {{convert|123|ft|m|-1}} ||
|-
|<code><nowiki>{{convert|123|ft|m|0}}</nowiki></code> || {{convert|123|ft|m|0}} ||
|-
|<code><nowiki>{{convert|123|ft|m|1}}</nowiki></code> || {{convert|123|ft|m|1}} ||
|-
|<code><nowiki>{{convert|550|ft|m|0}}</nowiki></code> || {{convert|550|ft|m|0}} || Approximate value is 167.64 m
|-
|<code><nowiki>{{convert|550|ft|m}}</nowiki></code> || {{convert|550|ft|m}} || Rounds to 170, when approximate value is 167.64 m
|-
|<code><nowiki>{{convert|500|ft|m|0}}</nowiki></code> || {{convert|500|ft|m|0}} || Approximate value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|m}}</nowiki></code> || {{convert|500|ft|m}} || Rounds to 150, when approximate value is 152.4 m
|}

''Convert'' supports four types of rounding:

===Round to a given precision: ''use {{para|precision|}}''===
Specify the desired precision with the fourth unnamed parameter (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest 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: ''{{para|sigfig|}}''===
To specify the output number to be with ''n'' significant figures use {{para|sigfig|<number>}}:
* To compare: <code><nowiki>{{convert|1200|ft|m}}</nowiki></code> → {{convert|1200|ft|m}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki></code> → {{convert|1200|ft|m|sigfig=4}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=3}}</nowiki></code> → {{convert|1200|ft|m|sigfig=3}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=2}}</nowiki></code> → {{convert|1200|ft|m|sigfig=2}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki></code> → {{convert|1200|ft|m|sigfig=1}}
Setting {{para|sigfig|<=0}} is meaningless
* <code><nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki></code> → {{convert|1200|ft|m|sigfig=0}}

===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
Using {{para|round|5}} rounds the outcome to a multiple of 5.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<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.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> → {{convert|10|m|ft|round=25}}
:To compare: <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}}:
:<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> → {{convert|10 x 200 x 3000|m|ft|round=each}}

===Round to a multiple of a given fraction: ''{{frac|2|3|16}} inch''===
Specify the desired ''denominator'' using {{para|frac|<some positive integer>}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|3}}).
:<code><nowiki>{{convert|5.56|cm|in|frac=16}}</nowiki></code> → {{convert|5.56|cm|in|frac=16}}
:<code><nowiki>{{convert|8|cm|in|frac=4}}</nowiki></code> → {{convert|8|cm|in|frac=4}}
The fraction is reduced when possible:
:<code><nowiki>{{convert|8|cm|in|frac=100}}</nowiki></code> → {{convert|8|cm|in|frac=100}}
:<code><nowiki>{{convert|8|cm|in}}</nowiki></code> → {{convert|8|cm|in|sigfig=4}} (To compare)

==={{anchor|Rounding temperatures}}In temperatures: rounding ''°C'', ''°F'' and ''K''===
In temperatures, the conversion will be rounded either to precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.

#{{#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|-300|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}}

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 into five significant output digits because of the two numbers 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.

==Into multiple units: ''{{convert|10|C|F K}}''==
Separate the multiple output units by a space:
* <code><nowiki>{{convert|10|C|F K}}</nowiki></code> → {{convert|10|C|F K}}
* <code><nowiki>{{convert|5|km|mi nmi}}</nowiki></code> → {{convert|5|km|mi nmi}}
If the output unit names contain spaces, use a '+' separator.

See also:
* For multiple-unit options like ''1 ft 5 in'', see [[#In input]] and [[#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: 
{{Convert/doc/range separator list}}

===Multiple dimensions: ''{{convert|6|x|12|m|ft|abbr=on}}''===
; Use "by":
:<code><nowiki>{{convert|6|by|12|ft|m}}</nowiki></code> → {{convert|6|by|12|ft|m}}
;Use "×" or ""x"":
:<code><nowiki>{{convert|6|x|12|m|ft}}</nowiki></code> → {{convert|6|x|12|m|ft}}

In science, the formal way is to set <code>|x|</code> and {{para|abbr|on}} (keeping dimensions right, like in ''area = x km2''):
:<code><nowiki>{{convert|6|x|12|m|ft|abbr=on}}</nowiki></code> → {{convert|6|x|12|m|ft|abbr=on}}

===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:
* <code><nowiki>{{convert|1|ft|3|in|mm}}</nowiki></code> → {{convert|1|ft|3|in|mm}} (to compare)
* <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}}

==Words==
===Spelling of unit name: UK ''metre'' or US ''meter''?===
Default spelling of units is en-UK. 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}}

===Spell out numbers: ''ten miles''===
To write a number in words, use {{para|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}}:
* <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}}
* <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> → {{convert|10|mi|m|spell=On}}

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> → {{convert|10|mi|m|spell=on|abbr=off|sp=us}}

===Inserted before units: ''4 planted acres''===
*<code><nowiki>{{convert|4|acre||adj=pre|planted}}</nowiki></code> → {{convert|4|acre||adj=pre|planted}}
<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|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-}}

===After adjective unit: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
:<code><nowiki>{{convert|10|ft|m|adj=mid|-long}}</nowiki></code> → {{convert|10|ft|m|adj=mid|-long}}

===Plurals: ''1 inch, 2 inches''===
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}}

;Exception:
Entering the unit spelled <code>|foot|</code> forces singular output "foot", whatever the number is.
* <code><nowiki>{{convert|100|foot|abbr=off}}</nowiki></code> → {{convert|100|foot|abbr=off}}

==Numbers==

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

To illustrate, these are trivial calculations (from meter to meter), showing the multiplication factor:
* {{convert|12|Gm|m|abbr=on}}
* {{convert|12|μm|m|abbr=on}}

The prefix can be added before the SI unit (here: unit <code>m</code> for meter):
* <code><nowiki>{{convert|12|Gm|mi|abbr=on}}</nowiki></code> → {{convert|12|Gm|mi|abbr=on}}
* <code>Mm</code>: {{convert|12|Mm|mi|abbr=on}}
* <code>km</code>: {{convert|12|km|ft|abbr=on}}
* <code>mm</code>: {{convert|12|mm|in|abbr=on}}
* <code>μm</code>: {{convert|12|μm|mm|abbr=on}}
* <code>um</code>: {{convert|12|um|mm|abbr=on}} (letter "u" can be used for "μ" here)

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

As an exception, the non-SI unit "inch" can have the "μ" prefix too)
* <code><nowiki>{{convert|12|μm|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}

:{{further|Help:Convert units#SI prefixes}}

===Engineering notation: ''7 × 106 m''===

====In the unit: ''e6m''====
[[Engineering notation|Engineering number notations]] like ''7{{smallcaps|E}}6'' (for 7 × 106) can be entered as a "prefix" to the unit:
:<code><nowiki>{{convert|7|e6m}}</nowiki></code> → {{convert|7|e6m}}
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−14''===
In [[scientific notation]], a number is written like {{rnd|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}}

===Input with fractions: ''{{convert|1+1/2|in|mm|1}}''===
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}}

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 (do not require a calculation)

===Output with horizontal fraction bar in: ''{{sfrac|1|2}} inch''===

Using a double slash (<code>//</code>) returns a horizontal bar fraction:
* <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}}

===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}}
*<code><nowiki>{{convert|1 234 567|m|ft}}</nowiki></code> → {{convert|1 234 567|m|ft}} {{nay}}

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}}</nowiki></code> → {{convert|1234567|m|ft}} (To compare, default)
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps}}

Setting {{para|comma|5}} or {{para|comma|gaps5}} will only add the separator when the number of digits is 5 or more:
*<code><nowiki>{{convert|1234|m|ft}}</nowiki></code> → {{convert|1234|m|ft}} (To compare, default)
*<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}}
*<code><nowiki>{{convert|1234|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234|m|ft|comma=gaps5}}
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps5}}

==Output manipulation==
===Brackets and separators: ''10 m [33 ft]''===
Punctuation that distinguishes the two measurements is set by {{para|disp|}}. 
Options are: <code>b</code> (the default), <code>sqbr</code>, <code>comma</code>, <code>or</code>, <code>br</code>, <code>x{{!}}≈...</code>:
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}—''( ) 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=comma}}</nowiki></code> → {{convert|10|m|ft|disp=comma}}
:<code><nowiki>{{convert|10|m|ft|disp=or}}</nowiki></code> → {{convert|10|m|ft|disp=or}}

Setting {{para|disp|br}} will force a new line (<code> </code>)
:<code><nowiki>{{convert|10|m|ft|disp=br}}</nowiki></code> → {{convert|10|m|ft|disp=br}}
Also {{para|disp|br()}} will force a new line, and keep the brackets:
:<code><nowiki>{{convert|10|m|ft|disp=br()}}</nowiki></code> → {{convert|10|m|ft|disp=br()}}

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_}}—(To display spaces, use <code>&nbsp;</code>)

===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:
:<code><nowiki>{{convert|1|mi|m}}</nowiki></code> → {{convert|1|mi|m|sigfig=5|abbr=off}} (To compare, default)
:<code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> → {{convert|1|mi|m|order=flip|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}}

=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
It is possible to display only parts of the conversion result:


{| class="wikitable"
! Convert !! Output !! Description
|-
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}}
| Default, to compare
|-
| <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|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|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|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=out}}</nowiki></code> || {{convert|2|cuyd|m3|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
|}
===Display both input name and symbol: ''2 kilopascals [kPa]''===
Setting {{para|abbr|~}} returns both name and symbol of the first (input) unit:
:<code><nowiki>{{convert|2|kPa|psi|abbr=~}}</nowiki></code> → {{convert|2|kPa|psi|abbr=~}}
:<code><nowiki>A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure</nowiki></code> → {{nowrap|A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure}}

==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 showing numbers only===
Using {convert} in a table cell, with {{para|disp|table}} splits the result over two columns:
:<code><nowiki>{{convert|10|m|ft|disp=table}}</nowiki></code> → {{convert|10|m|ft|disp=table}}

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

The units are added as a column header:
:{| class=wikitable
! style="width:10em;" |  
! style="width:10em;" | m
! style="width:10em;" | ft
|-
| {{para|disp|table}}
| {{convert|10|m|ft|disp=table}}
|-
|{{para|disp|tablecen}}
| {{convert|20|m|ft|disp=tablecen}}
|-
|{{para|disp|<other>}} (default)
|{{convert|30|m|ft|disp=}}
|}

===Sorting===
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=700110000000000000010 metres (33&nbsp;ft)}}

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

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

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==
===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}}}}
<div style="height: 400px; overflow: auto; padding: 3px; border: 1px solid #aaa;">
{{Convert/list of units}}
</div>

==='per' units: ''kg/hl''===
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}}

===Units of difference===
When a number is the measurement for a ''difference'', one conversion is done. This may occur in temperatures (°C, °F, K). Compare this to a ''range'', when two conversions are done.

The only available units of difference are: {{para|C-change}}, {{para|F-change}} and {{para| K-change}}.

:{{#invoke:DemoTemplate|convert|10|C}} -- regular temperature
:{{#invoke:DemoTemplate|convert|10|C-change}} -- difference (e.g., "The temperature changed from 30 into 40 °C")
:{{#invoke:DemoTemplate|convert|10-15|C}} -- range (e.g., "The temperature is between 10 and 15 °C")

Consistently, into multiple units:
:<code><nowiki>A rise of {{convert|10|C-change|F-change K-change}}</nowiki></code> → A rise of {{convert|10|C-change|F-change K-change}}

===Multiple units: ''1 ft 5 in''===
====In input====
Base document {{slink|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 {{slink|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
* <code><nowiki>{{convert|2|m}}</nowiki></code> → {{convert|2|m}}—the default

See also:
* {{tl|hands}} a length used to measure horses
* {{tl|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:
* <code><nowiki>{{convert|10|$/mi|$/km}}</nowiki></code> → {{convert|10|$/mi|$/km}}

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

==Parameter list==
{{convert/doc/parameter list}}

==Deprecated options==
{{Convert/doc/deprecations list}}

==TemplateData==
{{TemplateDataHeader}}

<templatedata>{
"description": "Converts measurements to other units.",
"params": {
"1": {
"label": "value",
"description": "the value to convert",
"type": "number"
},
"2": {
"label": "from unit",
"description": "",
"type": "string/line"
},
"3": {
"label": "to units",
"description": "the unit to convert into",
"type": "string/line"
},
"4": {
"label": "precision or suffix",
"description": "significant digits after decimal dot or, if negative, exponent of ten",
"type": "number"
},
"lk": {
"label": "link units",
"description": "“on” all, “in” input, “out” output or “off” no units",
"default": "off",
"type": "string/line"
},
"abbr": {
"label": "abbreviation",
"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",
"default": "out",
"type": "string/line"
},
"sp": {
"label": "spelling",
"description": "“us” display U.S. spelling of unit names",
"type": "string/line"
},
"adj": {
"label": "adjective",
"description": "adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end",
"type": "string/line"
},
"disp": {
"label": "conversion",
"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",
"default": "b",
"type": "string/line"
},
"order": {
"label": "ordering",
"description": "“flip” returns converted value first, input value second.",
"type": "string/line"
},
"sigfig": {
"label": "significant figures",
"description": "number that sets the number of significant figures",
"type": "number"
},
"round": {
"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",
"type": "string/line"
},
"comma": {
"label": "thousands separator",
"description": "Sets or suppresses thousand separator in the numbers. “off” = no separator; “gaps”: use space not comma; “5” and “gaps5”: only add separator when number > 5 positions (10,000 or more)",
"default": "on",
"type": "string/line"
},
"sortable": {
"label": "sort key",
"description": "“on” generates a hidden sort key",
"type": "string/line"
}
}}</templatedata>


==See also==
* {{Temp|Cvt}}
* {{Temp|SI units}}
{{Convert navs}}
<noinclude>
[[Category:Convert by module documentation| ]]
</noinclude><includeonly>
[[Category:Convert templates| ]]
[[Category:Conversion templates]]
[[Category:Numbers as words conversion templates]]
[[Category:Sorting templates]]
</includeonly>

Template:Convert/doc

2016-06-20T20:38:21Z

178.16.7.96: /* Into multiple units: {{convert|10|C|F K}} */

{{documentation subpage}}
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk| {{formatnum:789000}}+ }}}}
{{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}}
'''Template {{tl|convert}}''' ''calculates'' measurements from one unit (you can enter) to another one, and then ''presents the results''. For example:
:<code><nowiki>{{convert|2|km|mi}}</nowiki></code> → {{convert|2|km|mi}}
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> → {{convert|7|mi|km}}

The available '''units''' are listed [[#Units|below]]. Units are case-sensitive always ({{xt|kW}}, ''not'' {{!xt|KW}} and ''not'' {{!xt|kw}}). Multiple '''formatting''' and calculation options are listed below.

{{hatnote|See [[Help:Convert]] for more complete information}}
{{hatnote|For currency conversion into US dollars, see [[Template:To USD]]}}

==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
By default, the first value shows unit name spelled out, the second the symbol (or abbreviation). Use {{para|abbr|on/off}} to change this behaviour:
* <code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}

To abbreviate both:
* <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}}

{{para|abbr|in}} is the reverse behaviour to the default, {{para|abbr|out}}:
*<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{convert|1|lb|kg|abbr=in}}

===Convenience: {{tlf|cvt}} has {{para|abbr|on}} by default===
Template {{tl|cvt}} is similar to {{tlf|convert}}, but 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 equal to:
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{cvt|1|lb|kg|abbr=on}}

==Adjective: ''a 10-mile distance''==
Use {{para|adj|on}} to produce the adjective form. The difference:
:<code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> → {{convert|10|mi|km}} to go. ''(To compare, default)''
:<code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> → A {{convert|10|mi|km|adj=on}} distance. ''(Adjective form)''
This option does not work with {{para|abbr|on}}.

==Rounding: ''100 ft'' is ''30 m'' or ''30.5 m'' or ''30.48 m''?==
By definition, 100 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===
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 figures, whichever is more precise. An exception to this is ''rounding temperatures'' (see [[#Rounding temperatures|below]]).

{| class="wikitable"
|-
! colspan="3" | Examples of rounding
|-
|'''Input'''||'''Displays as'''||'''Note'''
|-
|<code><nowiki>{{convert|123|ft|m|-1}}</nowiki></code> || {{convert|123|ft|m|-1}} ||
|-
|<code><nowiki>{{convert|123|ft|m|0}}</nowiki></code> || {{convert|123|ft|m|0}} ||
|-
|<code><nowiki>{{convert|123|ft|m|1}}</nowiki></code> || {{convert|123|ft|m|1}} ||
|-
|<code><nowiki>{{convert|550|ft|m|0}}</nowiki></code> || {{convert|550|ft|m|0}} || Approximate value is 167.64 m
|-
|<code><nowiki>{{convert|550|ft|m}}</nowiki></code> || {{convert|550|ft|m}} || Rounds to 170, when approximate value is 167.64 m
|-
|<code><nowiki>{{convert|500|ft|m|0}}</nowiki></code> || {{convert|500|ft|m|0}} || Approximate value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|m}}</nowiki></code> || {{convert|500|ft|m}} || Rounds to 150, when approximate value is 152.4 m
|}

''Convert'' supports four types of rounding:

===Round to a given precision: ''use {{para|precision|}}''===
Specify the desired precision with the fourth unnamed parameter (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest 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: ''{{para|sigfig|}}''===
To specify the output number to be with ''n'' significant figures use {{para|sigfig|<number>}}:
* To compare: <code><nowiki>{{convert|1200|ft|m}}</nowiki></code> → {{convert|1200|ft|m}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki></code> → {{convert|1200|ft|m|sigfig=4}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=3}}</nowiki></code> → {{convert|1200|ft|m|sigfig=3}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=2}}</nowiki></code> → {{convert|1200|ft|m|sigfig=2}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki></code> → {{convert|1200|ft|m|sigfig=1}}
Setting {{para|sigfig|<=0}} is meaningless
* <code><nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki></code> → {{convert|1200|ft|m|sigfig=0}}

===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
Using {{para|round|5}} rounds the outcome to a multiple of 5.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<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.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> → {{convert|10|m|ft|round=25}}
:To compare: <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}}:
:<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> → {{convert|10 x 200 x 3000|m|ft|round=each}}

===Round to a multiple of a given fraction: ''{{frac|2|3|16}} inch''===
Specify the desired ''denominator'' using {{para|frac|<some positive integer>}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|3}}).
:<code><nowiki>{{convert|5.56|cm|in|frac=16}}</nowiki></code> → {{convert|5.56|cm|in|frac=16}}
:<code><nowiki>{{convert|8|cm|in|frac=4}}</nowiki></code> → {{convert|8|cm|in|frac=4}}
The fraction is reduced when possible:
:<code><nowiki>{{convert|8|cm|in|frac=100}}</nowiki></code> → {{convert|8|cm|in|frac=100}}
:<code><nowiki>{{convert|8|cm|in}}</nowiki></code> → {{convert|8|cm|in|sigfig=4}} (To compare)

==={{anchor|Rounding temperatures}}In temperatures: rounding ''°C'', ''°F'' and ''K''===
In temperatures, the conversion will be rounded either to precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.

#{{#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|-300|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}}

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 into five significant output digits because of the two numbers 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.

==Into multiple units: ''{{convert|10|C|F K}}''==
Separate the multiple output units by a space:
* <code><nowiki>{{convert|10|C|F K}}</nowiki></code> → {{convert|10|C|F K}}
* <code><nowiki>{{convert|5|km|mi nmi}}</nowiki></code> → {{convert|5|km|mi nmi}}
If the output unit names contain spaces, use a '+' separator.

See also:
* For multiple-unit options like ''1 ft 5 in'', see [[#In input]] and [[#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: 
{{Convert/doc/range separator list}}

===Multiple dimensions: ''{{convert|6|x|12|m|ft|abbr=on}}''===
; Use "by":
:<code><nowiki>{{convert|6|by|12|ft|m}}</nowiki></code> → {{convert|6|by|12|ft|m}}
;Use "×" or ""x"":
:<code><nowiki>{{convert|6|x|12|m|ft}}</nowiki></code> → {{convert|6|x|12|m|ft}}

In science, the formal way is to set <code>|x|</code> and {{para|abbr|on}} (keeping dimensions right, like in ''area = x km2''):
:<code><nowiki>{{convert|6|x|12|m|ft|abbr=on}}</nowiki></code> → {{convert|6|x|12|m|ft|abbr=on}}

===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:
* <code><nowiki>{{convert|1|ft|3|in|mm}}</nowiki></code> → {{convert|1|ft|3|in|mm}} (to compare)
* <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}}

==Words==
===Spelling of unit name: UK ''metre'' or US ''meter''?===
Default spelling of units is en-UK. 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}}

===Spell out numbers: ''ten miles''===
To write a number in words, use {{para|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}}:
:<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}}
:<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> → {{convert|10|mi|m|spell=On}}

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> → {{convert|10|mi|m|spell=on|abbr=off|sp=us}}
===Inserted before units: ''4 planted acres''===
*<code><nowiki>{{convert|4|acre||adj=pre|planted}}</nowiki></code> → {{convert|4|acre||adj=pre|planted}}
<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|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-}}

===After adjective unit: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
:<code><nowiki>{{convert|10|ft|m|adj=mid|-long}}</nowiki></code> → {{convert|10|ft|m|adj=mid|-long}}

===Plurals: ''1 inch, 2 inches''===
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}}

;Exception:
Entering the unit spelled <code>|foot|</code> forces singular output "foot", whatever the number is.
* <code><nowiki>{{convert|100|foot|abbr=off}}</nowiki></code> → {{convert|100|foot|abbr=off}}

==Numbers==

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

To illustrate, these are trivial calculations (from meter to meter), showing the multiplication factor:
* {{convert|12|Gm|m|abbr=on}}
* {{convert|12|μm|m|abbr=on}}

The prefix can be added before the SI unit (here: unit <code>m</code> for meter):
* <code><nowiki>{{convert|12|Gm|mi|abbr=on}}</nowiki></code> → {{convert|12|Gm|mi|abbr=on}}
* <code>Mm</code>: {{convert|12|Mm|mi|abbr=on}}
* <code>km</code>: {{convert|12|km|ft|abbr=on}}
* <code>mm</code>: {{convert|12|mm|in|abbr=on}}
* <code>μm</code>: {{convert|12|μm|mm|abbr=on}}
* <code>um</code>: {{convert|12|um|mm|abbr=on}} (letter "u" can be used for "μ" here)

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

As an exception, the non-SI unit "inch" can have the "μ" prefix too)
* <code><nowiki>{{convert|12|μm|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}

:{{further|Help:Convert units#SI prefixes}}

===Engineering notation: ''7 × 106 m''===

====In the unit: ''e6m''====
[[Engineering notation|Engineering number notations]] like ''7{{smallcaps|E}}6'' (for 7 × 106) can be entered as a "prefix" to the unit:
:<code><nowiki>{{convert|7|e6m}}</nowiki></code> → {{convert|7|e6m}}
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−14''===
In [[scientific notation]], a number is written like {{rnd|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}}

===Input with fractions: ''{{convert|1+1/2|in|mm|1}}''===
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}}

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 (do not require a calculation)

===Output with horizontal fraction bar in: ''{{sfrac|1|2}} inch''===

Using a double slash (<code>//</code>) returns a horizontal bar fraction:
* <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}}

===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}}
*<code><nowiki>{{convert|1 234 567|m|ft}}</nowiki></code> → {{convert|1 234 567|m|ft}} {{nay}}

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}}</nowiki></code> → {{convert|1234567|m|ft}} (To compare, default)
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps}}

Setting {{para|comma|5}} or {{para|comma|gaps5}} will only add the separator when the number of digits is 5 or more:
*<code><nowiki>{{convert|1234|m|ft}}</nowiki></code> → {{convert|1234|m|ft}} (To compare, default)
*<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}}
*<code><nowiki>{{convert|1234|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234|m|ft|comma=gaps5}}
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps5}}

==Output manipulation==
===Brackets and separators: ''10 m [33 ft]''===
Punctuation that distinguishes the two measurements is set by {{para|disp|}}. 
Options are: <code>b</code> (the default), <code>sqbr</code>, <code>comma</code>, <code>or</code>, <code>br</code>, <code>x{{!}}≈...</code>:
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}—''( ) 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=comma}}</nowiki></code> → {{convert|10|m|ft|disp=comma}}
:<code><nowiki>{{convert|10|m|ft|disp=or}}</nowiki></code> → {{convert|10|m|ft|disp=or}}

Setting {{para|disp|br}} will force a new line (<code> </code>)
:<code><nowiki>{{convert|10|m|ft|disp=br}}</nowiki></code> → {{convert|10|m|ft|disp=br}}
Also {{para|disp|br()}} will force a new line, and keep the brackets:
:<code><nowiki>{{convert|10|m|ft|disp=br()}}</nowiki></code> → {{convert|10|m|ft|disp=br()}}

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_}}—(To display spaces, use <code>&nbsp;</code>)

===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:
:<code><nowiki>{{convert|1|mi|m}}</nowiki></code> → {{convert|1|mi|m|sigfig=5|abbr=off}} (To compare, default)
:<code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> → {{convert|1|mi|m|order=flip|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}}

=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
It is possible to display only parts of the conversion result:


{| class="wikitable"
! Convert !! Output !! Description
|-
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}}
| Default, to compare
|-
| <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|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|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|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=out}}</nowiki></code> || {{convert|2|cuyd|m3|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
|}
===Display both input name and symbol: ''2 kilopascals [kPa]''===
Setting {{para|abbr|~}} returns both name and symbol of the first (input) unit:
:<code><nowiki>{{convert|2|kPa|psi|abbr=~}}</nowiki></code> → {{convert|2|kPa|psi|abbr=~}}
:<code><nowiki>A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure</nowiki></code> → {{nowrap|A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure}}

==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 showing numbers only===
Using {convert} in a table cell, with {{para|disp|table}} splits the result over two columns:
:<code><nowiki>{{convert|10|m|ft|disp=table}}</nowiki></code> → {{convert|10|m|ft|disp=table}}

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

The units are added as a column header:
:{| class=wikitable
! style="width:10em;" |  
! style="width:10em;" | m
! style="width:10em;" | ft
|-
| {{para|disp|table}}
| {{convert|10|m|ft|disp=table}}
|-
|{{para|disp|tablecen}}
| {{convert|20|m|ft|disp=tablecen}}
|-
|{{para|disp|<other>}} (default)
|{{convert|30|m|ft|disp=}}
|}

===Sorting===
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=700110000000000000010 metres (33&nbsp;ft)}}

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

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

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==
===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}}}}
<div style="height: 400px; overflow: auto; padding: 3px; border: 1px solid #aaa;">
{{Convert/list of units}}
</div>

==='per' units: ''kg/hl''===
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}}

===Units of difference===
When a number is the measurement for a ''difference'', one conversion is done. This may occur in temperatures (°C, °F, K). Compare this to a ''range'', when two conversions are done.

The only available units of difference are: {{para|C-change}}, {{para|F-change}} and {{para| K-change}}.

:{{#invoke:DemoTemplate|convert|10|C}} -- regular temperature
:{{#invoke:DemoTemplate|convert|10|C-change}} -- difference (e.g., "The temperature changed from 30 into 40 °C")
:{{#invoke:DemoTemplate|convert|10-15|C}} -- range (e.g., "The temperature is between 10 and 15 °C")

Consistently, into multiple units:
:<code><nowiki>A rise of {{convert|10|C-change|F-change K-change}}</nowiki></code> → A rise of {{convert|10|C-change|F-change K-change}}

===Multiple units: ''1 ft 5 in''===
====In input====
Base document {{slink|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 {{slink|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
* <code><nowiki>{{convert|2|m}}</nowiki></code> → {{convert|2|m}}—the default

See also:
* {{tl|hands}} a length used to measure horses
* {{tl|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:
* <code><nowiki>{{convert|10|$/mi|$/km}}</nowiki></code> → {{convert|10|$/mi|$/km}}

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

==Parameter list==
{{convert/doc/parameter list}}

==Deprecated options==
{{Convert/doc/deprecations list}}

==TemplateData==
{{TemplateDataHeader}}

<templatedata>{
"description": "Converts measurements to other units.",
"params": {
"1": {
"label": "value",
"description": "the value to convert",
"type": "number"
},
"2": {
"label": "from unit",
"description": "",
"type": "string/line"
},
"3": {
"label": "to units",
"description": "the unit to convert into",
"type": "string/line"
},
"4": {
"label": "precision or suffix",
"description": "significant digits after decimal dot or, if negative, exponent of ten",
"type": "number"
},
"lk": {
"label": "link units",
"description": "“on” all, “in” input, “out” output or “off” no units",
"default": "off",
"type": "string/line"
},
"abbr": {
"label": "abbreviation",
"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",
"default": "out",
"type": "string/line"
},
"sp": {
"label": "spelling",
"description": "“us” display U.S. spelling of unit names",
"type": "string/line"
},
"adj": {
"label": "adjective",
"description": "adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end",
"type": "string/line"
},
"disp": {
"label": "conversion",
"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",
"default": "b",
"type": "string/line"
},
"order": {
"label": "ordering",
"description": "“flip” returns converted value first, input value second.",
"type": "string/line"
},
"sigfig": {
"label": "significant figures",
"description": "number that sets the number of significant figures",
"type": "number"
},
"round": {
"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",
"type": "string/line"
},
"comma": {
"label": "thousands separator",
"description": "Sets or suppresses thousand separator in the numbers. “off” = no separator; “gaps”: use space not comma; “5” and “gaps5”: only add separator when number > 5 positions (10,000 or more)",
"default": "on",
"type": "string/line"
},
"sortable": {
"label": "sort key",
"description": "“on” generates a hidden sort key",
"type": "string/line"
}
}}</templatedata>


==See also==
* {{Temp|Cvt}}
* {{Temp|SI units}}
{{Convert navs}}
<noinclude>
[[Category:Convert by module documentation| ]]
</noinclude><includeonly>
[[Category:Convert templates| ]]
[[Category:Conversion templates]]
[[Category:Numbers as words conversion templates]]
[[Category:Sorting templates]]
</includeonly>

Template:Convert/doc

2016-06-20T20:33:36Z

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

{{documentation subpage}}
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk| {{formatnum:789000}}+ }}}}
{{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}}
'''Template {{tl|convert}}''' ''calculates'' measurements from one unit (you can enter) to another one, and then ''presents the results''. For example:
:<code><nowiki>{{convert|2|km|mi}}</nowiki></code> → {{convert|2|km|mi}}
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> → {{convert|7|mi|km}}

The available '''units''' are listed [[#Units|below]]. Units are case-sensitive always ({{xt|kW}}, ''not'' {{!xt|KW}} and ''not'' {{!xt|kw}}). Multiple '''formatting''' and calculation options are listed below.

{{hatnote|See [[Help:Convert]] for more complete information}}
{{hatnote|For currency conversion into US dollars, see [[Template:To USD]]}}

==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
By default, the first value shows unit name spelled out, the second the symbol (or abbreviation). Use {{para|abbr|on/off}} to change this behaviour:
* <code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}

To abbreviate both:
* <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}}

{{para|abbr|in}} is the reverse behaviour to the default, {{para|abbr|out}}:
*<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{convert|1|lb|kg|abbr=in}}

===Convenience: {{tlf|cvt}} has {{para|abbr|on}} by default===
Template {{tl|cvt}} is similar to {{tlf|convert}}, but 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 equal to:
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{cvt|1|lb|kg|abbr=on}}

==Adjective: ''a 10-mile distance''==
Use {{para|adj|on}} to produce the adjective form. The difference:
:<code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> → {{convert|10|mi|km}} to go. ''(To compare, default)''
:<code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> → A {{convert|10|mi|km|adj=on}} distance. ''(Adjective form)''
This option does not work with {{para|abbr|on}}.

==Rounding: ''100 ft'' is ''30 m'' or ''30.5 m'' or ''30.48 m''?==
By definition, 100 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===
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 figures, whichever is more precise. An exception to this is ''rounding temperatures'' (see [[#Rounding temperatures|below]]).

{| class="wikitable"
|-
! colspan="3" | Examples of rounding
|-
|'''Input'''||'''Displays as'''||'''Note'''
|-
|<code><nowiki>{{convert|123|ft|m|-1}}</nowiki></code> || {{convert|123|ft|m|-1}} ||
|-
|<code><nowiki>{{convert|123|ft|m|0}}</nowiki></code> || {{convert|123|ft|m|0}} ||
|-
|<code><nowiki>{{convert|123|ft|m|1}}</nowiki></code> || {{convert|123|ft|m|1}} ||
|-
|<code><nowiki>{{convert|550|ft|m|0}}</nowiki></code> || {{convert|550|ft|m|0}} || Approximate value is 167.64 m
|-
|<code><nowiki>{{convert|550|ft|m}}</nowiki></code> || {{convert|550|ft|m}} || Rounds to 170, when approximate value is 167.64 m
|-
|<code><nowiki>{{convert|500|ft|m|0}}</nowiki></code> || {{convert|500|ft|m|0}} || Approximate value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|m}}</nowiki></code> || {{convert|500|ft|m}} || Rounds to 150, when approximate value is 152.4 m
|}

''Convert'' supports four types of rounding:

===Round to a given precision: ''use {{para|precision|}}''===
Specify the desired precision with the fourth unnamed parameter (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest 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: ''{{para|sigfig|}}''===
To specify the output number to be with ''n'' significant figures use {{para|sigfig|<number>}}:
* To compare: <code><nowiki>{{convert|1200|ft|m}}</nowiki></code> → {{convert|1200|ft|m}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki></code> → {{convert|1200|ft|m|sigfig=4}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=3}}</nowiki></code> → {{convert|1200|ft|m|sigfig=3}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=2}}</nowiki></code> → {{convert|1200|ft|m|sigfig=2}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki></code> → {{convert|1200|ft|m|sigfig=1}}
Setting {{para|sigfig|<=0}} is meaningless
* <code><nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki></code> → {{convert|1200|ft|m|sigfig=0}}

===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
Using {{para|round|5}} rounds the outcome to a multiple of 5.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<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.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> → {{convert|10|m|ft|round=25}}
:To compare: <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}}:
:<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> → {{convert|10 x 200 x 3000|m|ft|round=each}}

===Round to a multiple of a given fraction: ''{{frac|2|3|16}} inch''===
Specify the desired ''denominator'' using {{para|frac|<some positive integer>}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|3}}).
:<code><nowiki>{{convert|5.56|cm|in|frac=16}}</nowiki></code> → {{convert|5.56|cm|in|frac=16}}
:<code><nowiki>{{convert|8|cm|in|frac=4}}</nowiki></code> → {{convert|8|cm|in|frac=4}}
The fraction is reduced when possible:
:<code><nowiki>{{convert|8|cm|in|frac=100}}</nowiki></code> → {{convert|8|cm|in|frac=100}}
:<code><nowiki>{{convert|8|cm|in}}</nowiki></code> → {{convert|8|cm|in|sigfig=4}} (To compare)

==={{anchor|Rounding temperatures}}In temperatures: rounding ''°C'', ''°F'' and ''K''===
In temperatures, the conversion will be rounded either to precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.

#{{#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|-300|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}}

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 into five significant output digits because of the two numbers 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.

==Into multiple units: ''{{convert|10|C|F K}}''==
Separate the multiple output units by a space:
:<code><nowiki>{{convert|10|C|F K}}</nowiki></code> → {{convert|10|C|F K}}
:<code><nowiki>{{convert|5|km|mi nmi}}</nowiki></code> → {{convert|5|km|mi nmi}}
If the output unit names contain spaces, use a '+' separator.
;See also
For multiple-unit options like ''1 ft 5 in'', see [[#In input]] and [[#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: 
{{Convert/doc/range separator list}}

===Multiple dimensions: ''{{convert|6|x|12|m|ft|abbr=on}}''===
; Use "by":
:<code><nowiki>{{convert|6|by|12|ft|m}}</nowiki></code> → {{convert|6|by|12|ft|m}}
;Use "×" or ""x"":
:<code><nowiki>{{convert|6|x|12|m|ft}}</nowiki></code> → {{convert|6|x|12|m|ft}}

In science, the formal way is to set <code>|x|</code> and {{para|abbr|on}} (keeping dimensions right, like in ''area = x km2''):
:<code><nowiki>{{convert|6|x|12|m|ft|abbr=on}}</nowiki></code> → {{convert|6|x|12|m|ft|abbr=on}}

===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:
* <code><nowiki>{{convert|1|ft|3|in|mm}}</nowiki></code> → {{convert|1|ft|3|in|mm}} (to compare)
* <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}}

==Words==
===Spelling of unit name: UK ''metre'' or US ''meter''?===
Default spelling of units is en-UK. 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}}

===Spell out numbers: ''ten miles''===
To write a number in words, use {{para|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}}:
:<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}}
:<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> → {{convert|10|mi|m|spell=On}}

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> → {{convert|10|mi|m|spell=on|abbr=off|sp=us}}
===Inserted before units: ''4 planted acres''===
*<code><nowiki>{{convert|4|acre||adj=pre|planted}}</nowiki></code> → {{convert|4|acre||adj=pre|planted}}
<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|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-}}

===After adjective unit: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
:<code><nowiki>{{convert|10|ft|m|adj=mid|-long}}</nowiki></code> → {{convert|10|ft|m|adj=mid|-long}}

===Plurals: ''1 inch, 2 inches''===
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}}

;Exception:
Entering the unit spelled <code>|foot|</code> forces singular output "foot", whatever the number is.
* <code><nowiki>{{convert|100|foot|abbr=off}}</nowiki></code> → {{convert|100|foot|abbr=off}}

==Numbers==

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

To illustrate, these are trivial calculations (from meter to meter), showing the multiplication factor:
* {{convert|12|Gm|m|abbr=on}}
* {{convert|12|μm|m|abbr=on}}

The prefix can be added before the SI unit (here: unit <code>m</code> for meter):
* <code><nowiki>{{convert|12|Gm|mi|abbr=on}}</nowiki></code> → {{convert|12|Gm|mi|abbr=on}}
* <code>Mm</code>: {{convert|12|Mm|mi|abbr=on}}
* <code>km</code>: {{convert|12|km|ft|abbr=on}}
* <code>mm</code>: {{convert|12|mm|in|abbr=on}}
* <code>μm</code>: {{convert|12|μm|mm|abbr=on}}
* <code>um</code>: {{convert|12|um|mm|abbr=on}} (letter "u" can be used for "μ" here)

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

As an exception, the non-SI unit "inch" can have the "μ" prefix too)
* <code><nowiki>{{convert|12|μm|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}

:{{further|Help:Convert units#SI prefixes}}

===Engineering notation: ''7 × 106 m''===

====In the unit: ''e6m''====
[[Engineering notation|Engineering number notations]] like ''7{{smallcaps|E}}6'' (for 7 × 106) can be entered as a "prefix" to the unit:
:<code><nowiki>{{convert|7|e6m}}</nowiki></code> → {{convert|7|e6m}}
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−14''===
In [[scientific notation]], a number is written like {{rnd|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}}

===Input with fractions: ''{{convert|1+1/2|in|mm|1}}''===
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}}

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 (do not require a calculation)

===Output with horizontal fraction bar in: ''{{sfrac|1|2}} inch''===

Using a double slash (<code>//</code>) returns a horizontal bar fraction:
* <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}}

===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}}
*<code><nowiki>{{convert|1 234 567|m|ft}}</nowiki></code> → {{convert|1 234 567|m|ft}} {{nay}}

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}}</nowiki></code> → {{convert|1234567|m|ft}} (To compare, default)
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps}}

Setting {{para|comma|5}} or {{para|comma|gaps5}} will only add the separator when the number of digits is 5 or more:
*<code><nowiki>{{convert|1234|m|ft}}</nowiki></code> → {{convert|1234|m|ft}} (To compare, default)
*<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}}
*<code><nowiki>{{convert|1234|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234|m|ft|comma=gaps5}}
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps5}}

==Output manipulation==
===Brackets and separators: ''10 m [33 ft]''===
Punctuation that distinguishes the two measurements is set by {{para|disp|}}. 
Options are: <code>b</code> (the default), <code>sqbr</code>, <code>comma</code>, <code>or</code>, <code>br</code>, <code>x{{!}}≈...</code>:
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}—''( ) 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=comma}}</nowiki></code> → {{convert|10|m|ft|disp=comma}}
:<code><nowiki>{{convert|10|m|ft|disp=or}}</nowiki></code> → {{convert|10|m|ft|disp=or}}

Setting {{para|disp|br}} will force a new line (<code> </code>)
:<code><nowiki>{{convert|10|m|ft|disp=br}}</nowiki></code> → {{convert|10|m|ft|disp=br}}
Also {{para|disp|br()}} will force a new line, and keep the brackets:
:<code><nowiki>{{convert|10|m|ft|disp=br()}}</nowiki></code> → {{convert|10|m|ft|disp=br()}}

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_}}—(To display spaces, use <code>&nbsp;</code>)

===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:
:<code><nowiki>{{convert|1|mi|m}}</nowiki></code> → {{convert|1|mi|m|sigfig=5|abbr=off}} (To compare, default)
:<code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> → {{convert|1|mi|m|order=flip|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}}

=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
It is possible to display only parts of the conversion result:


{| class="wikitable"
! Convert !! Output !! Description
|-
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}}
| Default, to compare
|-
| <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|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|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|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=out}}</nowiki></code> || {{convert|2|cuyd|m3|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
|}
===Display both input name and symbol: ''2 kilopascals [kPa]''===
Setting {{para|abbr|~}} returns both name and symbol of the first (input) unit:
:<code><nowiki>{{convert|2|kPa|psi|abbr=~}}</nowiki></code> → {{convert|2|kPa|psi|abbr=~}}
:<code><nowiki>A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure</nowiki></code> → {{nowrap|A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure}}

==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 showing numbers only===
Using {convert} in a table cell, with {{para|disp|table}} splits the result over two columns:
:<code><nowiki>{{convert|10|m|ft|disp=table}}</nowiki></code> → {{convert|10|m|ft|disp=table}}

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

The units are added as a column header:
:{| class=wikitable
! style="width:10em;" |  
! style="width:10em;" | m
! style="width:10em;" | ft
|-
| {{para|disp|table}}
| {{convert|10|m|ft|disp=table}}
|-
|{{para|disp|tablecen}}
| {{convert|20|m|ft|disp=tablecen}}
|-
|{{para|disp|<other>}} (default)
|{{convert|30|m|ft|disp=}}
|}

===Sorting===
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=700110000000000000010 metres (33&nbsp;ft)}}

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

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

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==
===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}}}}
<div style="height: 400px; overflow: auto; padding: 3px; border: 1px solid #aaa;">
{{Convert/list of units}}
</div>

==='per' units: ''kg/hl''===
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}}

===Units of difference===
When a number is the measurement for a ''difference'', one conversion is done. This may occur in temperatures (°C, °F, K). Compare this to a ''range'', when two conversions are done.

The only available units of difference are: {{para|C-change}}, {{para|F-change}} and {{para| K-change}}.

:{{#invoke:DemoTemplate|convert|10|C}} -- regular temperature
:{{#invoke:DemoTemplate|convert|10|C-change}} -- difference (e.g., "The temperature changed from 30 into 40 °C")
:{{#invoke:DemoTemplate|convert|10-15|C}} -- range (e.g., "The temperature is between 10 and 15 °C")

Consistently, into multiple units:
:<code><nowiki>A rise of {{convert|10|C-change|F-change K-change}}</nowiki></code> → A rise of {{convert|10|C-change|F-change K-change}}

===Multiple units: ''1 ft 5 in''===
====In input====
Base document {{slink|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 {{slink|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
* <code><nowiki>{{convert|2|m}}</nowiki></code> → {{convert|2|m}}—the default

See also:
* {{tl|hands}} a length used to measure horses
* {{tl|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:
* <code><nowiki>{{convert|10|$/mi|$/km}}</nowiki></code> → {{convert|10|$/mi|$/km}}

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

==Parameter list==
{{convert/doc/parameter list}}

==Deprecated options==
{{Convert/doc/deprecations list}}

==TemplateData==
{{TemplateDataHeader}}

<templatedata>{
"description": "Converts measurements to other units.",
"params": {
"1": {
"label": "value",
"description": "the value to convert",
"type": "number"
},
"2": {
"label": "from unit",
"description": "",
"type": "string/line"
},
"3": {
"label": "to units",
"description": "the unit to convert into",
"type": "string/line"
},
"4": {
"label": "precision or suffix",
"description": "significant digits after decimal dot or, if negative, exponent of ten",
"type": "number"
},
"lk": {
"label": "link units",
"description": "“on” all, “in” input, “out” output or “off” no units",
"default": "off",
"type": "string/line"
},
"abbr": {
"label": "abbreviation",
"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",
"default": "out",
"type": "string/line"
},
"sp": {
"label": "spelling",
"description": "“us” display U.S. spelling of unit names",
"type": "string/line"
},
"adj": {
"label": "adjective",
"description": "adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end",
"type": "string/line"
},
"disp": {
"label": "conversion",
"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",
"default": "b",
"type": "string/line"
},
"order": {
"label": "ordering",
"description": "“flip” returns converted value first, input value second.",
"type": "string/line"
},
"sigfig": {
"label": "significant figures",
"description": "number that sets the number of significant figures",
"type": "number"
},
"round": {
"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",
"type": "string/line"
},
"comma": {
"label": "thousands separator",
"description": "Sets or suppresses thousand separator in the numbers. “off” = no separator; “gaps”: use space not comma; “5” and “gaps5”: only add separator when number > 5 positions (10,000 or more)",
"default": "on",
"type": "string/line"
},
"sortable": {
"label": "sort key",
"description": "“on” generates a hidden sort key",
"type": "string/line"
}
}}</templatedata>


==See also==
* {{Temp|Cvt}}
* {{Temp|SI units}}
{{Convert navs}}
<noinclude>
[[Category:Convert by module documentation| ]]
</noinclude><includeonly>
[[Category:Convert templates| ]]
[[Category:Conversion templates]]
[[Category:Numbers as words conversion templates]]
[[Category:Sorting templates]]
</includeonly>

Template:Convert/doc

2016-06-20T20:28:43Z

178.16.7.96: /* Currency per unit: $/mi, €/km */

{{documentation subpage}}
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk| {{formatnum:789000}}+ }}}}
{{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}}
'''Template {{tl|convert}}''' ''calculates'' measurements from one unit (you can enter) to another one, and then ''presents the results''. For example:
:<code><nowiki>{{convert|2|km|mi}}</nowiki></code> → {{convert|2|km|mi}}
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> → {{convert|7|mi|km}}

The available '''units''' are listed [[#Units|below]]. Units are case-sensitive always ({{xt|kW}}, ''not'' {{!xt|KW}} and ''not'' {{!xt|kw}}). Multiple '''formatting''' and calculation options are listed below.

{{hatnote|See [[Help:Convert]] for more complete information}}
{{hatnote|For currency conversion into US dollars, see [[Template:To USD]]}}

==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
By default, the first value shows unit name spelled out, the second the symbol (or abbreviation).
Use {{para|abbr|on/off}} to change this behaviour:
:<code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}
To abbreviate both:
:<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}}
* {{para|abbr|in}} toggles the default behaviour ({{para|abbr|out}}):
:<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{convert|1|lb|kg|abbr=in}}

===Convenience: {{tlf|cvt}} has {{para|abbr|on}} by default===
Template {{tl|cvt}} is similar to {{tlf|convert}}, but has pre-set {{para|abbr|on}}. In {{tlf|cvt}}, all other options are available. So:

:<code><nowiki>{{cvt|1|lb|kg}}</nowiki></code> → {{cvt|1|lb|kg}}
:is equal to:
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{cvt|1|lb|kg|abbr=on}}

==Adjective: ''a 10-mile distance''==
Use {{para|adj|on}} to produce the adjective form. The difference:
:<code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> → {{convert|10|mi|km}} to go. ''(To compare, default)''
:<code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> → A {{convert|10|mi|km|adj=on}} distance. ''(Adjective form)''
This option does not work with {{para|abbr|on}}.

==Rounding: ''100 ft'' is ''30 m'' or ''30.5 m'' or ''30.48 m''?==
By definition, 100 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===
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 figures, whichever is more precise. An exception to this is ''rounding temperatures'' (see [[#Rounding temperatures|below]]).

{| class="wikitable"
|-
! colspan="3" | Examples of rounding
|-
|'''Input'''||'''Displays as'''||'''Note'''
|-
|<code><nowiki>{{convert|123|ft|m|-1}}</nowiki></code> || {{convert|123|ft|m|-1}} ||
|-
|<code><nowiki>{{convert|123|ft|m|0}}</nowiki></code> || {{convert|123|ft|m|0}} ||
|-
|<code><nowiki>{{convert|123|ft|m|1}}</nowiki></code> || {{convert|123|ft|m|1}} ||
|-
|<code><nowiki>{{convert|550|ft|m|0}}</nowiki></code> || {{convert|550|ft|m|0}} || Approximate value is 167.64 m
|-
|<code><nowiki>{{convert|550|ft|m}}</nowiki></code> || {{convert|550|ft|m}} || Rounds to 170, when approximate value is 167.64 m
|-
|<code><nowiki>{{convert|500|ft|m|0}}</nowiki></code> || {{convert|500|ft|m|0}} || Approximate value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|m}}</nowiki></code> || {{convert|500|ft|m}} || Rounds to 150, when approximate value is 152.4 m
|}

''Convert'' supports four types of rounding:

===Round to a given precision: ''use {{para|precision|}}''===
Specify the desired precision with the fourth unnamed parameter (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest 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: ''{{para|sigfig|}}''===
To specify the output number to be with ''n'' significant figures use {{para|sigfig|<number>}}:
* To compare: <code><nowiki>{{convert|1200|ft|m}}</nowiki></code> → {{convert|1200|ft|m}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki></code> → {{convert|1200|ft|m|sigfig=4}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=3}}</nowiki></code> → {{convert|1200|ft|m|sigfig=3}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=2}}</nowiki></code> → {{convert|1200|ft|m|sigfig=2}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki></code> → {{convert|1200|ft|m|sigfig=1}}
Setting {{para|sigfig|<=0}} is meaningless
* <code><nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki></code> → {{convert|1200|ft|m|sigfig=0}}

===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
Using {{para|round|5}} rounds the outcome to a multiple of 5.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<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.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> → {{convert|10|m|ft|round=25}}
:To compare: <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}}:
:<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> → {{convert|10 x 200 x 3000|m|ft|round=each}}

===Round to a multiple of a given fraction: ''{{frac|2|3|16}} inch''===
Specify the desired ''denominator'' using {{para|frac|<some positive integer>}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|3}}).
:<code><nowiki>{{convert|5.56|cm|in|frac=16}}</nowiki></code> → {{convert|5.56|cm|in|frac=16}}
:<code><nowiki>{{convert|8|cm|in|frac=4}}</nowiki></code> → {{convert|8|cm|in|frac=4}}
The fraction is reduced when possible:
:<code><nowiki>{{convert|8|cm|in|frac=100}}</nowiki></code> → {{convert|8|cm|in|frac=100}}
:<code><nowiki>{{convert|8|cm|in}}</nowiki></code> → {{convert|8|cm|in|sigfig=4}} (To compare)

==={{anchor|Rounding temperatures}}In temperatures: rounding ''°C'', ''°F'' and ''K''===
In temperatures, the conversion will be rounded either to precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.

#{{#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|-300|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}}

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 into five significant output digits because of the two numbers 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.

==Into multiple units: ''{{convert|10|C|F K}}''==
Separate the multiple output units by a space:
:<code><nowiki>{{convert|10|C|F K}}</nowiki></code> → {{convert|10|C|F K}}
:<code><nowiki>{{convert|5|km|mi nmi}}</nowiki></code> → {{convert|5|km|mi nmi}}
If the output unit names contain spaces, use a '+' separator.
;See also
For multiple-unit options like ''1 ft 5 in'', see [[#In input]] and [[#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: 
{{Convert/doc/range separator list}}

===Multiple dimensions: ''{{convert|6|x|12|m|ft|abbr=on}}''===
; Use "by":
:<code><nowiki>{{convert|6|by|12|ft|m}}</nowiki></code> → {{convert|6|by|12|ft|m}}
;Use "×" or ""x"":
:<code><nowiki>{{convert|6|x|12|m|ft}}</nowiki></code> → {{convert|6|x|12|m|ft}}

In science, the formal way is to set <code>|x|</code> and {{para|abbr|on}} (keeping dimensions right, like in ''area = x km2''):
:<code><nowiki>{{convert|6|x|12|m|ft|abbr=on}}</nowiki></code> → {{convert|6|x|12|m|ft|abbr=on}}

===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:
* <code><nowiki>{{convert|1|ft|3|in|mm}}</nowiki></code> → {{convert|1|ft|3|in|mm}} (to compare)
* <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}}

==Words==
===Spelling of unit name: UK ''metre'' or US ''meter''?===
Default spelling of units is en-UK. 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}}

===Spell out numbers: ''ten miles''===
To write a number in words, use {{para|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}}:
:<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}}
:<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> → {{convert|10|mi|m|spell=On}}

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> → {{convert|10|mi|m|spell=on|abbr=off|sp=us}}
===Inserted before units: ''4 planted acres''===
*<code><nowiki>{{convert|4|acre||adj=pre|planted}}</nowiki></code> → {{convert|4|acre||adj=pre|planted}}
<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|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-}}

===After adjective unit: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
:<code><nowiki>{{convert|10|ft|m|adj=mid|-long}}</nowiki></code> → {{convert|10|ft|m|adj=mid|-long}}

===Plurals: ''1 inch, 2 inches''===
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}}

;Exception:
Entering the unit spelled <code>|foot|</code> forces singular output "foot", whatever the number is.
* <code><nowiki>{{convert|100|foot|abbr=off}}</nowiki></code> → {{convert|100|foot|abbr=off}}

==Numbers==

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

To illustrate, these are trivial calculations (from meter to meter), showing the multiplication factor:
* {{convert|12|Gm|m|abbr=on}}
* {{convert|12|μm|m|abbr=on}}

The prefix can be added before the SI unit (here: unit <code>m</code> for meter):
* <code><nowiki>{{convert|12|Gm|mi|abbr=on}}</nowiki></code> → {{convert|12|Gm|mi|abbr=on}}
* <code>Mm</code>: {{convert|12|Mm|mi|abbr=on}}
* <code>km</code>: {{convert|12|km|ft|abbr=on}}
* <code>mm</code>: {{convert|12|mm|in|abbr=on}}
* <code>μm</code>: {{convert|12|μm|mm|abbr=on}}
* <code>um</code>: {{convert|12|um|mm|abbr=on}} (letter "u" can be used for "μ" here)

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

As an exception, the non-SI unit "inch" can have the "μ" prefix too)
* <code><nowiki>{{convert|12|μm|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}

:{{further|Help:Convert units#SI prefixes}}

===Engineering notation: ''7 × 106 m''===

====In the unit: ''e6m''====
[[Engineering notation|Engineering number notations]] like ''7{{smallcaps|E}}6'' (for 7 × 106) can be entered as a "prefix" to the unit:
:<code><nowiki>{{convert|7|e6m}}</nowiki></code> → {{convert|7|e6m}}
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−14''===
In [[scientific notation]], a number is written like {{rnd|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}}

===Input with fractions: ''{{convert|1+1/2|in|mm|1}}''===
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}}

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 (do not require a calculation)

===Output with horizontal fraction bar in: ''{{sfrac|1|2}} inch''===

Using a double slash (<code>//</code>) returns a horizontal bar fraction:
* <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}}

===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}}
*<code><nowiki>{{convert|1 234 567|m|ft}}</nowiki></code> → {{convert|1 234 567|m|ft}} {{nay}}

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}}</nowiki></code> → {{convert|1234567|m|ft}} (To compare, default)
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps}}

Setting {{para|comma|5}} or {{para|comma|gaps5}} will only add the separator when the number of digits is 5 or more:
*<code><nowiki>{{convert|1234|m|ft}}</nowiki></code> → {{convert|1234|m|ft}} (To compare, default)
*<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}}
*<code><nowiki>{{convert|1234|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234|m|ft|comma=gaps5}}
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps5}}

==Output manipulation==
===Brackets and separators: ''10 m [33 ft]''===
Punctuation that distinguishes the two measurements is set by {{para|disp|}}. 
Options are: <code>b</code> (the default), <code>sqbr</code>, <code>comma</code>, <code>or</code>, <code>br</code>, <code>x{{!}}≈...</code>:
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}—''( ) 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=comma}}</nowiki></code> → {{convert|10|m|ft|disp=comma}}
:<code><nowiki>{{convert|10|m|ft|disp=or}}</nowiki></code> → {{convert|10|m|ft|disp=or}}

Setting {{para|disp|br}} will force a new line (<code> </code>)
:<code><nowiki>{{convert|10|m|ft|disp=br}}</nowiki></code> → {{convert|10|m|ft|disp=br}}
Also {{para|disp|br()}} will force a new line, and keep the brackets:
:<code><nowiki>{{convert|10|m|ft|disp=br()}}</nowiki></code> → {{convert|10|m|ft|disp=br()}}

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_}}—(To display spaces, use <code>&nbsp;</code>)

===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:
:<code><nowiki>{{convert|1|mi|m}}</nowiki></code> → {{convert|1|mi|m|sigfig=5|abbr=off}} (To compare, default)
:<code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> → {{convert|1|mi|m|order=flip|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}}

=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
It is possible to display only parts of the conversion result:


{| class="wikitable"
! Convert !! Output !! Description
|-
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}}
| Default, to compare
|-
| <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|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|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|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=out}}</nowiki></code> || {{convert|2|cuyd|m3|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
|}
===Display both input name and symbol: ''2 kilopascals [kPa]''===
Setting {{para|abbr|~}} returns both name and symbol of the first (input) unit:
:<code><nowiki>{{convert|2|kPa|psi|abbr=~}}</nowiki></code> → {{convert|2|kPa|psi|abbr=~}}
:<code><nowiki>A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure</nowiki></code> → {{nowrap|A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure}}

==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 showing numbers only===
Using {convert} in a table cell, with {{para|disp|table}} splits the result over two columns:
:<code><nowiki>{{convert|10|m|ft|disp=table}}</nowiki></code> → {{convert|10|m|ft|disp=table}}

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

The units are added as a column header:
:{| class=wikitable
! style="width:10em;" |  
! style="width:10em;" | m
! style="width:10em;" | ft
|-
| {{para|disp|table}}
| {{convert|10|m|ft|disp=table}}
|-
|{{para|disp|tablecen}}
| {{convert|20|m|ft|disp=tablecen}}
|-
|{{para|disp|<other>}} (default)
|{{convert|30|m|ft|disp=}}
|}

===Sorting===
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=700110000000000000010 metres (33&nbsp;ft)}}

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

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

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==
===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}}}}
<div style="height: 400px; overflow: auto; padding: 3px; border: 1px solid #aaa;">
{{Convert/list of units}}
</div>

==='per' units: ''kg/hl''===
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}}

===Units of difference===
When a number is the measurement for a ''difference'', one conversion is done. This may occur in temperatures (°C, °F, K). Compare this to a ''range'', when two conversions are done.

The only available units of difference are: {{para|C-change}}, {{para|F-change}} and {{para| K-change}}.

:{{#invoke:DemoTemplate|convert|10|C}} -- regular temperature
:{{#invoke:DemoTemplate|convert|10|C-change}} -- difference (e.g., "The temperature changed from 30 into 40 °C")
:{{#invoke:DemoTemplate|convert|10-15|C}} -- range (e.g., "The temperature is between 10 and 15 °C")

Consistently, into multiple units:
:<code><nowiki>A rise of {{convert|10|C-change|F-change K-change}}</nowiki></code> → A rise of {{convert|10|C-change|F-change K-change}}

===Multiple units: ''1 ft 5 in''===
====In input====
Base document {{slink|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 {{slink|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
* <code><nowiki>{{convert|2|m}}</nowiki></code> → {{convert|2|m}}—the default

See also:
* {{tl|hands}} a length used to measure horses
* {{tl|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:
* <code><nowiki>{{convert|10|$/mi|$/km}}</nowiki></code> → {{convert|10|$/mi|$/km}}

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

==Parameter list==
{{convert/doc/parameter list}}

==Deprecated options==
{{Convert/doc/deprecations list}}

==TemplateData==
{{TemplateDataHeader}}

<templatedata>{
"description": "Converts measurements to other units.",
"params": {
"1": {
"label": "value",
"description": "the value to convert",
"type": "number"
},
"2": {
"label": "from unit",
"description": "",
"type": "string/line"
},
"3": {
"label": "to units",
"description": "the unit to convert into",
"type": "string/line"
},
"4": {
"label": "precision or suffix",
"description": "significant digits after decimal dot or, if negative, exponent of ten",
"type": "number"
},
"lk": {
"label": "link units",
"description": "“on” all, “in” input, “out” output or “off” no units",
"default": "off",
"type": "string/line"
},
"abbr": {
"label": "abbreviation",
"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",
"default": "out",
"type": "string/line"
},
"sp": {
"label": "spelling",
"description": "“us” display U.S. spelling of unit names",
"type": "string/line"
},
"adj": {
"label": "adjective",
"description": "adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end",
"type": "string/line"
},
"disp": {
"label": "conversion",
"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",
"default": "b",
"type": "string/line"
},
"order": {
"label": "ordering",
"description": "“flip” returns converted value first, input value second.",
"type": "string/line"
},
"sigfig": {
"label": "significant figures",
"description": "number that sets the number of significant figures",
"type": "number"
},
"round": {
"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",
"type": "string/line"
},
"comma": {
"label": "thousands separator",
"description": "Sets or suppresses thousand separator in the numbers. “off” = no separator; “gaps”: use space not comma; “5” and “gaps5”: only add separator when number > 5 positions (10,000 or more)",
"default": "on",
"type": "string/line"
},
"sortable": {
"label": "sort key",
"description": "“on” generates a hidden sort key",
"type": "string/line"
}
}}</templatedata>


==See also==
* {{Temp|Cvt}}
* {{Temp|SI units}}
{{Convert navs}}
<noinclude>
[[Category:Convert by module documentation| ]]
</noinclude><includeonly>
[[Category:Convert templates| ]]
[[Category:Conversion templates]]
[[Category:Numbers as words conversion templates]]
[[Category:Sorting templates]]
</includeonly>

Template:Convert/doc

2016-06-20T20:27:32Z

178.16.7.96: /* Multiple units: 1 ft 5 in */

{{documentation subpage}}
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk| {{formatnum:789000}}+ }}}}
{{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}}
'''Template {{tl|convert}}''' ''calculates'' measurements from one unit (you can enter) to another one, and then ''presents the results''. For example:
:<code><nowiki>{{convert|2|km|mi}}</nowiki></code> → {{convert|2|km|mi}}
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> → {{convert|7|mi|km}}

The available '''units''' are listed [[#Units|below]]. Units are case-sensitive always ({{xt|kW}}, ''not'' {{!xt|KW}} and ''not'' {{!xt|kw}}). Multiple '''formatting''' and calculation options are listed below.

{{hatnote|See [[Help:Convert]] for more complete information}}
{{hatnote|For currency conversion into US dollars, see [[Template:To USD]]}}

==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
By default, the first value shows unit name spelled out, the second the symbol (or abbreviation).
Use {{para|abbr|on/off}} to change this behaviour:
:<code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}
To abbreviate both:
:<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}}
* {{para|abbr|in}} toggles the default behaviour ({{para|abbr|out}}):
:<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{convert|1|lb|kg|abbr=in}}

===Convenience: {{tlf|cvt}} has {{para|abbr|on}} by default===
Template {{tl|cvt}} is similar to {{tlf|convert}}, but has pre-set {{para|abbr|on}}. In {{tlf|cvt}}, all other options are available. So:

:<code><nowiki>{{cvt|1|lb|kg}}</nowiki></code> → {{cvt|1|lb|kg}}
:is equal to:
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{cvt|1|lb|kg|abbr=on}}

==Adjective: ''a 10-mile distance''==
Use {{para|adj|on}} to produce the adjective form. The difference:
:<code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> → {{convert|10|mi|km}} to go. ''(To compare, default)''
:<code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> → A {{convert|10|mi|km|adj=on}} distance. ''(Adjective form)''
This option does not work with {{para|abbr|on}}.

==Rounding: ''100 ft'' is ''30 m'' or ''30.5 m'' or ''30.48 m''?==
By definition, 100 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===
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 figures, whichever is more precise. An exception to this is ''rounding temperatures'' (see [[#Rounding temperatures|below]]).

{| class="wikitable"
|-
! colspan="3" | Examples of rounding
|-
|'''Input'''||'''Displays as'''||'''Note'''
|-
|<code><nowiki>{{convert|123|ft|m|-1}}</nowiki></code> || {{convert|123|ft|m|-1}} ||
|-
|<code><nowiki>{{convert|123|ft|m|0}}</nowiki></code> || {{convert|123|ft|m|0}} ||
|-
|<code><nowiki>{{convert|123|ft|m|1}}</nowiki></code> || {{convert|123|ft|m|1}} ||
|-
|<code><nowiki>{{convert|550|ft|m|0}}</nowiki></code> || {{convert|550|ft|m|0}} || Approximate value is 167.64 m
|-
|<code><nowiki>{{convert|550|ft|m}}</nowiki></code> || {{convert|550|ft|m}} || Rounds to 170, when approximate value is 167.64 m
|-
|<code><nowiki>{{convert|500|ft|m|0}}</nowiki></code> || {{convert|500|ft|m|0}} || Approximate value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|m}}</nowiki></code> || {{convert|500|ft|m}} || Rounds to 150, when approximate value is 152.4 m
|}

''Convert'' supports four types of rounding:

===Round to a given precision: ''use {{para|precision|}}''===
Specify the desired precision with the fourth unnamed parameter (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest 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: ''{{para|sigfig|}}''===
To specify the output number to be with ''n'' significant figures use {{para|sigfig|<number>}}:
* To compare: <code><nowiki>{{convert|1200|ft|m}}</nowiki></code> → {{convert|1200|ft|m}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki></code> → {{convert|1200|ft|m|sigfig=4}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=3}}</nowiki></code> → {{convert|1200|ft|m|sigfig=3}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=2}}</nowiki></code> → {{convert|1200|ft|m|sigfig=2}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki></code> → {{convert|1200|ft|m|sigfig=1}}
Setting {{para|sigfig|<=0}} is meaningless
* <code><nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki></code> → {{convert|1200|ft|m|sigfig=0}}

===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
Using {{para|round|5}} rounds the outcome to a multiple of 5.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<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.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> → {{convert|10|m|ft|round=25}}
:To compare: <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}}:
:<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> → {{convert|10 x 200 x 3000|m|ft|round=each}}

===Round to a multiple of a given fraction: ''{{frac|2|3|16}} inch''===
Specify the desired ''denominator'' using {{para|frac|<some positive integer>}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|3}}).
:<code><nowiki>{{convert|5.56|cm|in|frac=16}}</nowiki></code> → {{convert|5.56|cm|in|frac=16}}
:<code><nowiki>{{convert|8|cm|in|frac=4}}</nowiki></code> → {{convert|8|cm|in|frac=4}}
The fraction is reduced when possible:
:<code><nowiki>{{convert|8|cm|in|frac=100}}</nowiki></code> → {{convert|8|cm|in|frac=100}}
:<code><nowiki>{{convert|8|cm|in}}</nowiki></code> → {{convert|8|cm|in|sigfig=4}} (To compare)

==={{anchor|Rounding temperatures}}In temperatures: rounding ''°C'', ''°F'' and ''K''===
In temperatures, the conversion will be rounded either to precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.

#{{#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|-300|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}}

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 into five significant output digits because of the two numbers 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.

==Into multiple units: ''{{convert|10|C|F K}}''==
Separate the multiple output units by a space:
:<code><nowiki>{{convert|10|C|F K}}</nowiki></code> → {{convert|10|C|F K}}
:<code><nowiki>{{convert|5|km|mi nmi}}</nowiki></code> → {{convert|5|km|mi nmi}}
If the output unit names contain spaces, use a '+' separator.
;See also
For multiple-unit options like ''1 ft 5 in'', see [[#In input]] and [[#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: 
{{Convert/doc/range separator list}}

===Multiple dimensions: ''{{convert|6|x|12|m|ft|abbr=on}}''===
; Use "by":
:<code><nowiki>{{convert|6|by|12|ft|m}}</nowiki></code> → {{convert|6|by|12|ft|m}}
;Use "×" or ""x"":
:<code><nowiki>{{convert|6|x|12|m|ft}}</nowiki></code> → {{convert|6|x|12|m|ft}}

In science, the formal way is to set <code>|x|</code> and {{para|abbr|on}} (keeping dimensions right, like in ''area = x km2''):
:<code><nowiki>{{convert|6|x|12|m|ft|abbr=on}}</nowiki></code> → {{convert|6|x|12|m|ft|abbr=on}}

===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:
* <code><nowiki>{{convert|1|ft|3|in|mm}}</nowiki></code> → {{convert|1|ft|3|in|mm}} (to compare)
* <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}}

==Words==
===Spelling of unit name: UK ''metre'' or US ''meter''?===
Default spelling of units is en-UK. 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}}

===Spell out numbers: ''ten miles''===
To write a number in words, use {{para|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}}:
:<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}}
:<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> → {{convert|10|mi|m|spell=On}}

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> → {{convert|10|mi|m|spell=on|abbr=off|sp=us}}
===Inserted before units: ''4 planted acres''===
*<code><nowiki>{{convert|4|acre||adj=pre|planted}}</nowiki></code> → {{convert|4|acre||adj=pre|planted}}
<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|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-}}

===After adjective unit: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
:<code><nowiki>{{convert|10|ft|m|adj=mid|-long}}</nowiki></code> → {{convert|10|ft|m|adj=mid|-long}}

===Plurals: ''1 inch, 2 inches''===
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}}

;Exception:
Entering the unit spelled <code>|foot|</code> forces singular output "foot", whatever the number is.
* <code><nowiki>{{convert|100|foot|abbr=off}}</nowiki></code> → {{convert|100|foot|abbr=off}}

==Numbers==

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

To illustrate, these are trivial calculations (from meter to meter), showing the multiplication factor:
* {{convert|12|Gm|m|abbr=on}}
* {{convert|12|μm|m|abbr=on}}

The prefix can be added before the SI unit (here: unit <code>m</code> for meter):
* <code><nowiki>{{convert|12|Gm|mi|abbr=on}}</nowiki></code> → {{convert|12|Gm|mi|abbr=on}}
* <code>Mm</code>: {{convert|12|Mm|mi|abbr=on}}
* <code>km</code>: {{convert|12|km|ft|abbr=on}}
* <code>mm</code>: {{convert|12|mm|in|abbr=on}}
* <code>μm</code>: {{convert|12|μm|mm|abbr=on}}
* <code>um</code>: {{convert|12|um|mm|abbr=on}} (letter "u" can be used for "μ" here)

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

As an exception, the non-SI unit "inch" can have the "μ" prefix too)
* <code><nowiki>{{convert|12|μm|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}

:{{further|Help:Convert units#SI prefixes}}

===Engineering notation: ''7 × 106 m''===

====In the unit: ''e6m''====
[[Engineering notation|Engineering number notations]] like ''7{{smallcaps|E}}6'' (for 7 × 106) can be entered as a "prefix" to the unit:
:<code><nowiki>{{convert|7|e6m}}</nowiki></code> → {{convert|7|e6m}}
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−14''===
In [[scientific notation]], a number is written like {{rnd|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}}

===Input with fractions: ''{{convert|1+1/2|in|mm|1}}''===
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}}

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 (do not require a calculation)

===Output with horizontal fraction bar in: ''{{sfrac|1|2}} inch''===

Using a double slash (<code>//</code>) returns a horizontal bar fraction:
* <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}}

===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}}
*<code><nowiki>{{convert|1 234 567|m|ft}}</nowiki></code> → {{convert|1 234 567|m|ft}} {{nay}}

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}}</nowiki></code> → {{convert|1234567|m|ft}} (To compare, default)
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps}}

Setting {{para|comma|5}} or {{para|comma|gaps5}} will only add the separator when the number of digits is 5 or more:
*<code><nowiki>{{convert|1234|m|ft}}</nowiki></code> → {{convert|1234|m|ft}} (To compare, default)
*<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}}
*<code><nowiki>{{convert|1234|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234|m|ft|comma=gaps5}}
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps5}}

==Output manipulation==
===Brackets and separators: ''10 m [33 ft]''===
Punctuation that distinguishes the two measurements is set by {{para|disp|}}. 
Options are: <code>b</code> (the default), <code>sqbr</code>, <code>comma</code>, <code>or</code>, <code>br</code>, <code>x{{!}}≈...</code>:
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}—''( ) 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=comma}}</nowiki></code> → {{convert|10|m|ft|disp=comma}}
:<code><nowiki>{{convert|10|m|ft|disp=or}}</nowiki></code> → {{convert|10|m|ft|disp=or}}

Setting {{para|disp|br}} will force a new line (<code> </code>)
:<code><nowiki>{{convert|10|m|ft|disp=br}}</nowiki></code> → {{convert|10|m|ft|disp=br}}
Also {{para|disp|br()}} will force a new line, and keep the brackets:
:<code><nowiki>{{convert|10|m|ft|disp=br()}}</nowiki></code> → {{convert|10|m|ft|disp=br()}}

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_}}—(To display spaces, use <code>&nbsp;</code>)

===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:
:<code><nowiki>{{convert|1|mi|m}}</nowiki></code> → {{convert|1|mi|m|sigfig=5|abbr=off}} (To compare, default)
:<code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> → {{convert|1|mi|m|order=flip|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}}

=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
It is possible to display only parts of the conversion result:


{| class="wikitable"
! Convert !! Output !! Description
|-
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}}
| Default, to compare
|-
| <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|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|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|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=out}}</nowiki></code> || {{convert|2|cuyd|m3|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
|}
===Display both input name and symbol: ''2 kilopascals [kPa]''===
Setting {{para|abbr|~}} returns both name and symbol of the first (input) unit:
:<code><nowiki>{{convert|2|kPa|psi|abbr=~}}</nowiki></code> → {{convert|2|kPa|psi|abbr=~}}
:<code><nowiki>A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure</nowiki></code> → {{nowrap|A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure}}

==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 showing numbers only===
Using {convert} in a table cell, with {{para|disp|table}} splits the result over two columns:
:<code><nowiki>{{convert|10|m|ft|disp=table}}</nowiki></code> → {{convert|10|m|ft|disp=table}}

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

The units are added as a column header:
:{| class=wikitable
! style="width:10em;" |  
! style="width:10em;" | m
! style="width:10em;" | ft
|-
| {{para|disp|table}}
| {{convert|10|m|ft|disp=table}}
|-
|{{para|disp|tablecen}}
| {{convert|20|m|ft|disp=tablecen}}
|-
|{{para|disp|<other>}} (default)
|{{convert|30|m|ft|disp=}}
|}

===Sorting===
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=700110000000000000010 metres (33&nbsp;ft)}}

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

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

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==
===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}}}}
<div style="height: 400px; overflow: auto; padding: 3px; border: 1px solid #aaa;">
{{Convert/list of units}}
</div>

==='per' units: ''kg/hl''===
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}}

===Units of difference===
When a number is the measurement for a ''difference'', one conversion is done. This may occur in temperatures (°C, °F, K). Compare this to a ''range'', when two conversions are done.

The only available units of difference are: {{para|C-change}}, {{para|F-change}} and {{para| K-change}}.

:{{#invoke:DemoTemplate|convert|10|C}} -- regular temperature
:{{#invoke:DemoTemplate|convert|10|C-change}} -- difference (e.g., "The temperature changed from 30 into 40 °C")
:{{#invoke:DemoTemplate|convert|10-15|C}} -- range (e.g., "The temperature is between 10 and 15 °C")

Consistently, into multiple units:
:<code><nowiki>A rise of {{convert|10|C-change|F-change K-change}}</nowiki></code> → A rise of {{convert|10|C-change|F-change K-change}}

===Multiple units: ''1 ft 5 in''===
====In input====
Base document {{slink|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 {{slink|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
* <code><nowiki>{{convert|2|m}}</nowiki></code> → {{convert|2|m}}—the default

See also:
* {{tl|hands}} a length used to measure horses
* {{tl|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:
:* <code><nowiki>{{convert|10|$/mi|$/km}}</nowiki></code> → {{convert|10|$/mi|$/km}}

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

==Parameter list==
{{convert/doc/parameter list}}

==Deprecated options==
{{Convert/doc/deprecations list}}

==TemplateData==
{{TemplateDataHeader}}

<templatedata>{
"description": "Converts measurements to other units.",
"params": {
"1": {
"label": "value",
"description": "the value to convert",
"type": "number"
},
"2": {
"label": "from unit",
"description": "",
"type": "string/line"
},
"3": {
"label": "to units",
"description": "the unit to convert into",
"type": "string/line"
},
"4": {
"label": "precision or suffix",
"description": "significant digits after decimal dot or, if negative, exponent of ten",
"type": "number"
},
"lk": {
"label": "link units",
"description": "“on” all, “in” input, “out” output or “off” no units",
"default": "off",
"type": "string/line"
},
"abbr": {
"label": "abbreviation",
"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",
"default": "out",
"type": "string/line"
},
"sp": {
"label": "spelling",
"description": "“us” display U.S. spelling of unit names",
"type": "string/line"
},
"adj": {
"label": "adjective",
"description": "adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end",
"type": "string/line"
},
"disp": {
"label": "conversion",
"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",
"default": "b",
"type": "string/line"
},
"order": {
"label": "ordering",
"description": "“flip” returns converted value first, input value second.",
"type": "string/line"
},
"sigfig": {
"label": "significant figures",
"description": "number that sets the number of significant figures",
"type": "number"
},
"round": {
"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",
"type": "string/line"
},
"comma": {
"label": "thousands separator",
"description": "Sets or suppresses thousand separator in the numbers. “off” = no separator; “gaps”: use space not comma; “5” and “gaps5”: only add separator when number > 5 positions (10,000 or more)",
"default": "on",
"type": "string/line"
},
"sortable": {
"label": "sort key",
"description": "“on” generates a hidden sort key",
"type": "string/line"
}
}}</templatedata>


==See also==
* {{Temp|Cvt}}
* {{Temp|SI units}}
{{Convert navs}}
<noinclude>
[[Category:Convert by module documentation| ]]
</noinclude><includeonly>
[[Category:Convert templates| ]]
[[Category:Conversion templates]]
[[Category:Numbers as words conversion templates]]
[[Category:Sorting templates]]
</includeonly>

Template:Convert/doc

2016-06-20T20:24:07Z

178.16.7.96: /* Extra adjective words: A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor */

{{documentation subpage}}
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk| {{formatnum:789000}}+ }}}}
{{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}}
'''Template {{tl|convert}}''' ''calculates'' measurements from one unit (you can enter) to another one, and then ''presents the results''. For example:
:<code><nowiki>{{convert|2|km|mi}}</nowiki></code> → {{convert|2|km|mi}}
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> → {{convert|7|mi|km}}

The available '''units''' are listed [[#Units|below]]. Units are case-sensitive always ({{xt|kW}}, ''not'' {{!xt|KW}} and ''not'' {{!xt|kw}}). Multiple '''formatting''' and calculation options are listed below.

{{hatnote|See [[Help:Convert]] for more complete information}}
{{hatnote|For currency conversion into US dollars, see [[Template:To USD]]}}

==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
By default, the first value shows unit name spelled out, the second the symbol (or abbreviation).
Use {{para|abbr|on/off}} to change this behaviour:
:<code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}
To abbreviate both:
:<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}}
* {{para|abbr|in}} toggles the default behaviour ({{para|abbr|out}}):
:<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{convert|1|lb|kg|abbr=in}}

===Convenience: {{tlf|cvt}} has {{para|abbr|on}} by default===
Template {{tl|cvt}} is similar to {{tlf|convert}}, but has pre-set {{para|abbr|on}}. In {{tlf|cvt}}, all other options are available. So:

:<code><nowiki>{{cvt|1|lb|kg}}</nowiki></code> → {{cvt|1|lb|kg}}
:is equal to:
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{cvt|1|lb|kg|abbr=on}}

==Adjective: ''a 10-mile distance''==
Use {{para|adj|on}} to produce the adjective form. The difference:
:<code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> → {{convert|10|mi|km}} to go. ''(To compare, default)''
:<code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> → A {{convert|10|mi|km|adj=on}} distance. ''(Adjective form)''
This option does not work with {{para|abbr|on}}.

==Rounding: ''100 ft'' is ''30 m'' or ''30.5 m'' or ''30.48 m''?==
By definition, 100 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===
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 figures, whichever is more precise. An exception to this is ''rounding temperatures'' (see [[#Rounding temperatures|below]]).

{| class="wikitable"
|-
! colspan="3" | Examples of rounding
|-
|'''Input'''||'''Displays as'''||'''Note'''
|-
|<code><nowiki>{{convert|123|ft|m|-1}}</nowiki></code> || {{convert|123|ft|m|-1}} ||
|-
|<code><nowiki>{{convert|123|ft|m|0}}</nowiki></code> || {{convert|123|ft|m|0}} ||
|-
|<code><nowiki>{{convert|123|ft|m|1}}</nowiki></code> || {{convert|123|ft|m|1}} ||
|-
|<code><nowiki>{{convert|550|ft|m|0}}</nowiki></code> || {{convert|550|ft|m|0}} || Approximate value is 167.64 m
|-
|<code><nowiki>{{convert|550|ft|m}}</nowiki></code> || {{convert|550|ft|m}} || Rounds to 170, when approximate value is 167.64 m
|-
|<code><nowiki>{{convert|500|ft|m|0}}</nowiki></code> || {{convert|500|ft|m|0}} || Approximate value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|m}}</nowiki></code> || {{convert|500|ft|m}} || Rounds to 150, when approximate value is 152.4 m
|}

''Convert'' supports four types of rounding:

===Round to a given precision: ''use {{para|precision|}}''===
Specify the desired precision with the fourth unnamed parameter (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest 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: ''{{para|sigfig|}}''===
To specify the output number to be with ''n'' significant figures use {{para|sigfig|<number>}}:
* To compare: <code><nowiki>{{convert|1200|ft|m}}</nowiki></code> → {{convert|1200|ft|m}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki></code> → {{convert|1200|ft|m|sigfig=4}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=3}}</nowiki></code> → {{convert|1200|ft|m|sigfig=3}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=2}}</nowiki></code> → {{convert|1200|ft|m|sigfig=2}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki></code> → {{convert|1200|ft|m|sigfig=1}}
Setting {{para|sigfig|<=0}} is meaningless
* <code><nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki></code> → {{convert|1200|ft|m|sigfig=0}}

===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
Using {{para|round|5}} rounds the outcome to a multiple of 5.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<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.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> → {{convert|10|m|ft|round=25}}
:To compare: <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}}:
:<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> → {{convert|10 x 200 x 3000|m|ft|round=each}}

===Round to a multiple of a given fraction: ''{{frac|2|3|16}} inch''===
Specify the desired ''denominator'' using {{para|frac|<some positive integer>}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|3}}).
:<code><nowiki>{{convert|5.56|cm|in|frac=16}}</nowiki></code> → {{convert|5.56|cm|in|frac=16}}
:<code><nowiki>{{convert|8|cm|in|frac=4}}</nowiki></code> → {{convert|8|cm|in|frac=4}}
The fraction is reduced when possible:
:<code><nowiki>{{convert|8|cm|in|frac=100}}</nowiki></code> → {{convert|8|cm|in|frac=100}}
:<code><nowiki>{{convert|8|cm|in}}</nowiki></code> → {{convert|8|cm|in|sigfig=4}} (To compare)

==={{anchor|Rounding temperatures}}In temperatures: rounding ''°C'', ''°F'' and ''K''===
In temperatures, the conversion will be rounded either to precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.

#{{#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|-300|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}}

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 into five significant output digits because of the two numbers 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.

==Into multiple units: ''{{convert|10|C|F K}}''==
Separate the multiple output units by a space:
:<code><nowiki>{{convert|10|C|F K}}</nowiki></code> → {{convert|10|C|F K}}
:<code><nowiki>{{convert|5|km|mi nmi}}</nowiki></code> → {{convert|5|km|mi nmi}}
If the output unit names contain spaces, use a '+' separator.
;See also
For multiple-unit options like ''1 ft 5 in'', see [[#In input]] and [[#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: 
{{Convert/doc/range separator list}}

===Multiple dimensions: ''{{convert|6|x|12|m|ft|abbr=on}}''===
; Use "by":
:<code><nowiki>{{convert|6|by|12|ft|m}}</nowiki></code> → {{convert|6|by|12|ft|m}}
;Use "×" or ""x"":
:<code><nowiki>{{convert|6|x|12|m|ft}}</nowiki></code> → {{convert|6|x|12|m|ft}}

In science, the formal way is to set <code>|x|</code> and {{para|abbr|on}} (keeping dimensions right, like in ''area = x km2''):
:<code><nowiki>{{convert|6|x|12|m|ft|abbr=on}}</nowiki></code> → {{convert|6|x|12|m|ft|abbr=on}}

===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:
* <code><nowiki>{{convert|1|ft|3|in|mm}}</nowiki></code> → {{convert|1|ft|3|in|mm}} (to compare)
* <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}}

==Words==
===Spelling of unit name: UK ''metre'' or US ''meter''?===
Default spelling of units is en-UK. 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}}

===Spell out numbers: ''ten miles''===
To write a number in words, use {{para|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}}:
:<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}}
:<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> → {{convert|10|mi|m|spell=On}}

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> → {{convert|10|mi|m|spell=on|abbr=off|sp=us}}
===Inserted before units: ''4 planted acres''===
*<code><nowiki>{{convert|4|acre||adj=pre|planted}}</nowiki></code> → {{convert|4|acre||adj=pre|planted}}
<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|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-}}

===After adjective unit: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
:<code><nowiki>{{convert|10|ft|m|adj=mid|-long}}</nowiki></code> → {{convert|10|ft|m|adj=mid|-long}}

===Plurals: ''1 inch, 2 inches''===
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}}

;Exception:
Entering the unit spelled <code>|foot|</code> forces singular output "foot", whatever the number is.
* <code><nowiki>{{convert|100|foot|abbr=off}}</nowiki></code> → {{convert|100|foot|abbr=off}}

==Numbers==

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

To illustrate, these are trivial calculations (from meter to meter), showing the multiplication factor:
* {{convert|12|Gm|m|abbr=on}}
* {{convert|12|μm|m|abbr=on}}

The prefix can be added before the SI unit (here: unit <code>m</code> for meter):
* <code><nowiki>{{convert|12|Gm|mi|abbr=on}}</nowiki></code> → {{convert|12|Gm|mi|abbr=on}}
* <code>Mm</code>: {{convert|12|Mm|mi|abbr=on}}
* <code>km</code>: {{convert|12|km|ft|abbr=on}}
* <code>mm</code>: {{convert|12|mm|in|abbr=on}}
* <code>μm</code>: {{convert|12|μm|mm|abbr=on}}
* <code>um</code>: {{convert|12|um|mm|abbr=on}} (letter "u" can be used for "μ" here)

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

As an exception, the non-SI unit "inch" can have the "μ" prefix too)
* <code><nowiki>{{convert|12|μm|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}

:{{further|Help:Convert units#SI prefixes}}

===Engineering notation: ''7 × 106 m''===

====In the unit: ''e6m''====
[[Engineering notation|Engineering number notations]] like ''7{{smallcaps|E}}6'' (for 7 × 106) can be entered as a "prefix" to the unit:
:<code><nowiki>{{convert|7|e6m}}</nowiki></code> → {{convert|7|e6m}}
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−14''===
In [[scientific notation]], a number is written like {{rnd|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}}

===Input with fractions: ''{{convert|1+1/2|in|mm|1}}''===
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}}

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 (do not require a calculation)

===Output with horizontal fraction bar in: ''{{sfrac|1|2}} inch''===

Using a double slash (<code>//</code>) returns a horizontal bar fraction:
* <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}}

===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}}
*<code><nowiki>{{convert|1 234 567|m|ft}}</nowiki></code> → {{convert|1 234 567|m|ft}} {{nay}}

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}}</nowiki></code> → {{convert|1234567|m|ft}} (To compare, default)
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps}}

Setting {{para|comma|5}} or {{para|comma|gaps5}} will only add the separator when the number of digits is 5 or more:
*<code><nowiki>{{convert|1234|m|ft}}</nowiki></code> → {{convert|1234|m|ft}} (To compare, default)
*<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}}
*<code><nowiki>{{convert|1234|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234|m|ft|comma=gaps5}}
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps5}}

==Output manipulation==
===Brackets and separators: ''10 m [33 ft]''===
Punctuation that distinguishes the two measurements is set by {{para|disp|}}. 
Options are: <code>b</code> (the default), <code>sqbr</code>, <code>comma</code>, <code>or</code>, <code>br</code>, <code>x{{!}}≈...</code>:
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}—''( ) 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=comma}}</nowiki></code> → {{convert|10|m|ft|disp=comma}}
:<code><nowiki>{{convert|10|m|ft|disp=or}}</nowiki></code> → {{convert|10|m|ft|disp=or}}

Setting {{para|disp|br}} will force a new line (<code> </code>)
:<code><nowiki>{{convert|10|m|ft|disp=br}}</nowiki></code> → {{convert|10|m|ft|disp=br}}
Also {{para|disp|br()}} will force a new line, and keep the brackets:
:<code><nowiki>{{convert|10|m|ft|disp=br()}}</nowiki></code> → {{convert|10|m|ft|disp=br()}}

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_}}—(To display spaces, use <code>&nbsp;</code>)

===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:
:<code><nowiki>{{convert|1|mi|m}}</nowiki></code> → {{convert|1|mi|m|sigfig=5|abbr=off}} (To compare, default)
:<code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> → {{convert|1|mi|m|order=flip|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}}

=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
It is possible to display only parts of the conversion result:


{| class="wikitable"
! Convert !! Output !! Description
|-
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}}
| Default, to compare
|-
| <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|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|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|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=out}}</nowiki></code> || {{convert|2|cuyd|m3|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
|}
===Display both input name and symbol: ''2 kilopascals [kPa]''===
Setting {{para|abbr|~}} returns both name and symbol of the first (input) unit:
:<code><nowiki>{{convert|2|kPa|psi|abbr=~}}</nowiki></code> → {{convert|2|kPa|psi|abbr=~}}
:<code><nowiki>A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure</nowiki></code> → {{nowrap|A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure}}

==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 showing numbers only===
Using {convert} in a table cell, with {{para|disp|table}} splits the result over two columns:
:<code><nowiki>{{convert|10|m|ft|disp=table}}</nowiki></code> → {{convert|10|m|ft|disp=table}}

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

The units are added as a column header:
:{| class=wikitable
! style="width:10em;" |  
! style="width:10em;" | m
! style="width:10em;" | ft
|-
| {{para|disp|table}}
| {{convert|10|m|ft|disp=table}}
|-
|{{para|disp|tablecen}}
| {{convert|20|m|ft|disp=tablecen}}
|-
|{{para|disp|<other>}} (default)
|{{convert|30|m|ft|disp=}}
|}

===Sorting===
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=700110000000000000010 metres (33&nbsp;ft)}}

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

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

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==
===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}}}}
<div style="height: 400px; overflow: auto; padding: 3px; border: 1px solid #aaa;">
{{Convert/list of units}}
</div>

==='per' units: ''kg/hl''===
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}}

===Units of difference===
When a number is the measurement for a ''difference'', one conversion is done. This may occur in temperatures (°C, °F, K). Compare this to a ''range'', when two conversions are done.

The only available units of difference are: {{para|C-change}}, {{para|F-change}} and {{para| K-change}}.

:{{#invoke:DemoTemplate|convert|10|C}} -- regular temperature
:{{#invoke:DemoTemplate|convert|10|C-change}} -- difference (e.g., "The temperature changed from 30 into 40 °C")
:{{#invoke:DemoTemplate|convert|10-15|C}} -- range (e.g., "The temperature is between 10 and 15 °C")

Consistently, into multiple units:
:<code><nowiki>A rise of {{convert|10|C-change|F-change K-change}}</nowiki></code> → A rise of {{convert|10|C-change|F-change K-change}}

===Multiple units: ''1 ft 5 in''===
====In input====
Base document {{slink|Module:Convert/documentation/conversion data/doc|Input multiples|nopage=y}} 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):
::*<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 {{slink|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
:*<code><nowiki>{{convert|2|m}}</nowiki></code> → {{convert|2|m}}—the default

;See also
* {{tl|hands}} a length used to measure horses
* {{tl|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:
:* <code><nowiki>{{convert|10|$/mi|$/km}}</nowiki></code> → {{convert|10|$/mi|$/km}}

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

==Parameter list==
{{convert/doc/parameter list}}

==Deprecated options==
{{Convert/doc/deprecations list}}

==TemplateData==
{{TemplateDataHeader}}

<templatedata>{
"description": "Converts measurements to other units.",
"params": {
"1": {
"label": "value",
"description": "the value to convert",
"type": "number"
},
"2": {
"label": "from unit",
"description": "",
"type": "string/line"
},
"3": {
"label": "to units",
"description": "the unit to convert into",
"type": "string/line"
},
"4": {
"label": "precision or suffix",
"description": "significant digits after decimal dot or, if negative, exponent of ten",
"type": "number"
},
"lk": {
"label": "link units",
"description": "“on” all, “in” input, “out” output or “off” no units",
"default": "off",
"type": "string/line"
},
"abbr": {
"label": "abbreviation",
"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",
"default": "out",
"type": "string/line"
},
"sp": {
"label": "spelling",
"description": "“us” display U.S. spelling of unit names",
"type": "string/line"
},
"adj": {
"label": "adjective",
"description": "adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end",
"type": "string/line"
},
"disp": {
"label": "conversion",
"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",
"default": "b",
"type": "string/line"
},
"order": {
"label": "ordering",
"description": "“flip” returns converted value first, input value second.",
"type": "string/line"
},
"sigfig": {
"label": "significant figures",
"description": "number that sets the number of significant figures",
"type": "number"
},
"round": {
"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",
"type": "string/line"
},
"comma": {
"label": "thousands separator",
"description": "Sets or suppresses thousand separator in the numbers. “off” = no separator; “gaps”: use space not comma; “5” and “gaps5”: only add separator when number > 5 positions (10,000 or more)",
"default": "on",
"type": "string/line"
},
"sortable": {
"label": "sort key",
"description": "“on” generates a hidden sort key",
"type": "string/line"
}
}}</templatedata>


==See also==
* {{Temp|Cvt}}
* {{Temp|SI units}}
{{Convert navs}}
<noinclude>
[[Category:Convert by module documentation| ]]
</noinclude><includeonly>
[[Category:Convert templates| ]]
[[Category:Conversion templates]]
[[Category:Numbers as words conversion templates]]
[[Category:Sorting templates]]
</includeonly>

Template:Convert/doc

2016-06-20T20:17:34Z

178.16.7.96: /* Extra words: 4 planted acres */

{{documentation subpage}}
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk| {{formatnum:789000}}+ }}}}
{{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}}
'''Template {{tl|convert}}''' ''calculates'' measurements from one unit (you can enter) to another one, and then ''presents the results''. For example:
:<code><nowiki>{{convert|2|km|mi}}</nowiki></code> → {{convert|2|km|mi}}
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> → {{convert|7|mi|km}}

The available '''units''' are listed [[#Units|below]]. Units are case-sensitive always ({{xt|kW}}, ''not'' {{!xt|KW}} and ''not'' {{!xt|kw}}). Multiple '''formatting''' and calculation options are listed below.

{{hatnote|See [[Help:Convert]] for more complete information}}
{{hatnote|For currency conversion into US dollars, see [[Template:To USD]]}}

==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
By default, the first value shows unit name spelled out, the second the symbol (or abbreviation).
Use {{para|abbr|on/off}} to change this behaviour:
:<code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}
To abbreviate both:
:<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}}
* {{para|abbr|in}} toggles the default behaviour ({{para|abbr|out}}):
:<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{convert|1|lb|kg|abbr=in}}

===Convenience: {{tlf|cvt}} has {{para|abbr|on}} by default===
Template {{tl|cvt}} is similar to {{tlf|convert}}, but has pre-set {{para|abbr|on}}. In {{tlf|cvt}}, all other options are available. So:

:<code><nowiki>{{cvt|1|lb|kg}}</nowiki></code> → {{cvt|1|lb|kg}}
:is equal to:
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{cvt|1|lb|kg|abbr=on}}

==Adjective: ''a 10-mile distance''==
Use {{para|adj|on}} to produce the adjective form. The difference:
:<code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> → {{convert|10|mi|km}} to go. ''(To compare, default)''
:<code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> → A {{convert|10|mi|km|adj=on}} distance. ''(Adjective form)''
This option does not work with {{para|abbr|on}}.

==Rounding: ''100 ft'' is ''30 m'' or ''30.5 m'' or ''30.48 m''?==
By definition, 100 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===
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 figures, whichever is more precise. An exception to this is ''rounding temperatures'' (see [[#Rounding temperatures|below]]).

{| class="wikitable"
|-
! colspan="3" | Examples of rounding
|-
|'''Input'''||'''Displays as'''||'''Note'''
|-
|<code><nowiki>{{convert|123|ft|m|-1}}</nowiki></code> || {{convert|123|ft|m|-1}} ||
|-
|<code><nowiki>{{convert|123|ft|m|0}}</nowiki></code> || {{convert|123|ft|m|0}} ||
|-
|<code><nowiki>{{convert|123|ft|m|1}}</nowiki></code> || {{convert|123|ft|m|1}} ||
|-
|<code><nowiki>{{convert|550|ft|m|0}}</nowiki></code> || {{convert|550|ft|m|0}} || Approximate value is 167.64 m
|-
|<code><nowiki>{{convert|550|ft|m}}</nowiki></code> || {{convert|550|ft|m}} || Rounds to 170, when approximate value is 167.64 m
|-
|<code><nowiki>{{convert|500|ft|m|0}}</nowiki></code> || {{convert|500|ft|m|0}} || Approximate value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|m}}</nowiki></code> || {{convert|500|ft|m}} || Rounds to 150, when approximate value is 152.4 m
|}

''Convert'' supports four types of rounding:

===Round to a given precision: ''use {{para|precision|}}''===
Specify the desired precision with the fourth unnamed parameter (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest 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: ''{{para|sigfig|}}''===
To specify the output number to be with ''n'' significant figures use {{para|sigfig|<number>}}:
* To compare: <code><nowiki>{{convert|1200|ft|m}}</nowiki></code> → {{convert|1200|ft|m}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki></code> → {{convert|1200|ft|m|sigfig=4}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=3}}</nowiki></code> → {{convert|1200|ft|m|sigfig=3}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=2}}</nowiki></code> → {{convert|1200|ft|m|sigfig=2}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki></code> → {{convert|1200|ft|m|sigfig=1}}
Setting {{para|sigfig|<=0}} is meaningless
* <code><nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki></code> → {{convert|1200|ft|m|sigfig=0}}

===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
Using {{para|round|5}} rounds the outcome to a multiple of 5.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<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.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> → {{convert|10|m|ft|round=25}}
:To compare: <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}}:
:<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> → {{convert|10 x 200 x 3000|m|ft|round=each}}

===Round to a multiple of a given fraction: ''{{frac|2|3|16}} inch''===
Specify the desired ''denominator'' using {{para|frac|<some positive integer>}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|3}}).
:<code><nowiki>{{convert|5.56|cm|in|frac=16}}</nowiki></code> → {{convert|5.56|cm|in|frac=16}}
:<code><nowiki>{{convert|8|cm|in|frac=4}}</nowiki></code> → {{convert|8|cm|in|frac=4}}
The fraction is reduced when possible:
:<code><nowiki>{{convert|8|cm|in|frac=100}}</nowiki></code> → {{convert|8|cm|in|frac=100}}
:<code><nowiki>{{convert|8|cm|in}}</nowiki></code> → {{convert|8|cm|in|sigfig=4}} (To compare)

==={{anchor|Rounding temperatures}}In temperatures: rounding ''°C'', ''°F'' and ''K''===
In temperatures, the conversion will be rounded either to precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.

#{{#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|-300|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}}

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 into five significant output digits because of the two numbers 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.

==Into multiple units: ''{{convert|10|C|F K}}''==
Separate the multiple output units by a space:
:<code><nowiki>{{convert|10|C|F K}}</nowiki></code> → {{convert|10|C|F K}}
:<code><nowiki>{{convert|5|km|mi nmi}}</nowiki></code> → {{convert|5|km|mi nmi}}
If the output unit names contain spaces, use a '+' separator.
;See also
For multiple-unit options like ''1 ft 5 in'', see [[#In input]] and [[#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: 
{{Convert/doc/range separator list}}

===Multiple dimensions: ''{{convert|6|x|12|m|ft|abbr=on}}''===
; Use "by":
:<code><nowiki>{{convert|6|by|12|ft|m}}</nowiki></code> → {{convert|6|by|12|ft|m}}
;Use "×" or ""x"":
:<code><nowiki>{{convert|6|x|12|m|ft}}</nowiki></code> → {{convert|6|x|12|m|ft}}

In science, the formal way is to set <code>|x|</code> and {{para|abbr|on}} (keeping dimensions right, like in ''area = x km2''):
:<code><nowiki>{{convert|6|x|12|m|ft|abbr=on}}</nowiki></code> → {{convert|6|x|12|m|ft|abbr=on}}

===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:
* <code><nowiki>{{convert|1|ft|3|in|mm}}</nowiki></code> → {{convert|1|ft|3|in|mm}} (to compare)
* <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}}

==Words==
===Spelling of unit name: UK ''metre'' or US ''meter''?===
Default spelling of units is en-UK. 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}}

===Spell out numbers: ''ten miles''===
To write a number in words, use {{para|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}}:
:<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}}
:<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> → {{convert|10|mi|m|spell=On}}

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> → {{convert|10|mi|m|spell=on|abbr=off|sp=us}}
===Inserted before units: ''4 planted acres''===
*<code><nowiki>{{convert|4|acre||adj=pre|planted}}</nowiki></code> → {{convert|4|acre||adj=pre|planted}}
<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|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 adjective words: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
:<code><nowiki>{{convert|10|ft|m|adj=mid|-long}}</nowiki></code> → {{convert|10|ft|m|adj=mid|-long}}

===Plurals: ''1 inch, 2 inches''===
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}}

;Exception:
Entering the unit spelled <code>|foot|</code> forces singular output "foot", whatever the number is.
* <code><nowiki>{{convert|100|foot|abbr=off}}</nowiki></code> → {{convert|100|foot|abbr=off}}

==Numbers==

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

To illustrate, these are trivial calculations (from meter to meter), showing the multiplication factor:
* {{convert|12|Gm|m|abbr=on}}
* {{convert|12|μm|m|abbr=on}}

The prefix can be added before the SI unit (here: unit <code>m</code> for meter):
* <code><nowiki>{{convert|12|Gm|mi|abbr=on}}</nowiki></code> → {{convert|12|Gm|mi|abbr=on}}
* <code>Mm</code>: {{convert|12|Mm|mi|abbr=on}}
* <code>km</code>: {{convert|12|km|ft|abbr=on}}
* <code>mm</code>: {{convert|12|mm|in|abbr=on}}
* <code>μm</code>: {{convert|12|μm|mm|abbr=on}}
* <code>um</code>: {{convert|12|um|mm|abbr=on}} (letter "u" can be used for "μ" here)

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

As an exception, the non-SI unit "inch" can have the "μ" prefix too)
* <code><nowiki>{{convert|12|μm|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}

:{{further|Help:Convert units#SI prefixes}}

===Engineering notation: ''7 × 106 m''===

====In the unit: ''e6m''====
[[Engineering notation|Engineering number notations]] like ''7{{smallcaps|E}}6'' (for 7 × 106) can be entered as a "prefix" to the unit:
:<code><nowiki>{{convert|7|e6m}}</nowiki></code> → {{convert|7|e6m}}
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−14''===
In [[scientific notation]], a number is written like {{rnd|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}}

===Input with fractions: ''{{convert|1+1/2|in|mm|1}}''===
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}}

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 (do not require a calculation)

===Output with horizontal fraction bar in: ''{{sfrac|1|2}} inch''===

Using a double slash (<code>//</code>) returns a horizontal bar fraction:
* <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}}

===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}}
*<code><nowiki>{{convert|1 234 567|m|ft}}</nowiki></code> → {{convert|1 234 567|m|ft}} {{nay}}

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}}</nowiki></code> → {{convert|1234567|m|ft}} (To compare, default)
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps}}

Setting {{para|comma|5}} or {{para|comma|gaps5}} will only add the separator when the number of digits is 5 or more:
*<code><nowiki>{{convert|1234|m|ft}}</nowiki></code> → {{convert|1234|m|ft}} (To compare, default)
*<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}}
*<code><nowiki>{{convert|1234|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234|m|ft|comma=gaps5}}
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps5}}

==Output manipulation==
===Brackets and separators: ''10 m [33 ft]''===
Punctuation that distinguishes the two measurements is set by {{para|disp|}}. 
Options are: <code>b</code> (the default), <code>sqbr</code>, <code>comma</code>, <code>or</code>, <code>br</code>, <code>x{{!}}≈...</code>:
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}—''( ) 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=comma}}</nowiki></code> → {{convert|10|m|ft|disp=comma}}
:<code><nowiki>{{convert|10|m|ft|disp=or}}</nowiki></code> → {{convert|10|m|ft|disp=or}}

Setting {{para|disp|br}} will force a new line (<code> </code>)
:<code><nowiki>{{convert|10|m|ft|disp=br}}</nowiki></code> → {{convert|10|m|ft|disp=br}}
Also {{para|disp|br()}} will force a new line, and keep the brackets:
:<code><nowiki>{{convert|10|m|ft|disp=br()}}</nowiki></code> → {{convert|10|m|ft|disp=br()}}

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_}}—(To display spaces, use <code>&nbsp;</code>)

===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:
:<code><nowiki>{{convert|1|mi|m}}</nowiki></code> → {{convert|1|mi|m|sigfig=5|abbr=off}} (To compare, default)
:<code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> → {{convert|1|mi|m|order=flip|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}}

=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
It is possible to display only parts of the conversion result:


{| class="wikitable"
! Convert !! Output !! Description
|-
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}}
| Default, to compare
|-
| <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|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|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|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=out}}</nowiki></code> || {{convert|2|cuyd|m3|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
|}
===Display both input name and symbol: ''2 kilopascals [kPa]''===
Setting {{para|abbr|~}} returns both name and symbol of the first (input) unit:
:<code><nowiki>{{convert|2|kPa|psi|abbr=~}}</nowiki></code> → {{convert|2|kPa|psi|abbr=~}}
:<code><nowiki>A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure</nowiki></code> → {{nowrap|A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure}}

==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 showing numbers only===
Using {convert} in a table cell, with {{para|disp|table}} splits the result over two columns:
:<code><nowiki>{{convert|10|m|ft|disp=table}}</nowiki></code> → {{convert|10|m|ft|disp=table}}

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

The units are added as a column header:
:{| class=wikitable
! style="width:10em;" |  
! style="width:10em;" | m
! style="width:10em;" | ft
|-
| {{para|disp|table}}
| {{convert|10|m|ft|disp=table}}
|-
|{{para|disp|tablecen}}
| {{convert|20|m|ft|disp=tablecen}}
|-
|{{para|disp|<other>}} (default)
|{{convert|30|m|ft|disp=}}
|}

===Sorting===
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=700110000000000000010 metres (33&nbsp;ft)}}

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

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

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==
===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}}}}
<div style="height: 400px; overflow: auto; padding: 3px; border: 1px solid #aaa;">
{{Convert/list of units}}
</div>

==='per' units: ''kg/hl''===
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}}

===Units of difference===
When a number is the measurement for a ''difference'', one conversion is done. This may occur in temperatures (°C, °F, K). Compare this to a ''range'', when two conversions are done.

The only available units of difference are: {{para|C-change}}, {{para|F-change}} and {{para| K-change}}.

:{{#invoke:DemoTemplate|convert|10|C}} -- regular temperature
:{{#invoke:DemoTemplate|convert|10|C-change}} -- difference (e.g., "The temperature changed from 30 into 40 °C")
:{{#invoke:DemoTemplate|convert|10-15|C}} -- range (e.g., "The temperature is between 10 and 15 °C")

Consistently, into multiple units:
:<code><nowiki>A rise of {{convert|10|C-change|F-change K-change}}</nowiki></code> → A rise of {{convert|10|C-change|F-change K-change}}

===Multiple units: ''1 ft 5 in''===
====In input====
Base document {{slink|Module:Convert/documentation/conversion data/doc|Input multiples|nopage=y}} 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):
::*<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 {{slink|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
:*<code><nowiki>{{convert|2|m}}</nowiki></code> → {{convert|2|m}}—the default

;See also
* {{tl|hands}} a length used to measure horses
* {{tl|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:
:* <code><nowiki>{{convert|10|$/mi|$/km}}</nowiki></code> → {{convert|10|$/mi|$/km}}

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

==Parameter list==
{{convert/doc/parameter list}}

==Deprecated options==
{{Convert/doc/deprecations list}}

==TemplateData==
{{TemplateDataHeader}}

<templatedata>{
"description": "Converts measurements to other units.",
"params": {
"1": {
"label": "value",
"description": "the value to convert",
"type": "number"
},
"2": {
"label": "from unit",
"description": "",
"type": "string/line"
},
"3": {
"label": "to units",
"description": "the unit to convert into",
"type": "string/line"
},
"4": {
"label": "precision or suffix",
"description": "significant digits after decimal dot or, if negative, exponent of ten",
"type": "number"
},
"lk": {
"label": "link units",
"description": "“on” all, “in” input, “out” output or “off” no units",
"default": "off",
"type": "string/line"
},
"abbr": {
"label": "abbreviation",
"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",
"default": "out",
"type": "string/line"
},
"sp": {
"label": "spelling",
"description": "“us” display U.S. spelling of unit names",
"type": "string/line"
},
"adj": {
"label": "adjective",
"description": "adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end",
"type": "string/line"
},
"disp": {
"label": "conversion",
"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",
"default": "b",
"type": "string/line"
},
"order": {
"label": "ordering",
"description": "“flip” returns converted value first, input value second.",
"type": "string/line"
},
"sigfig": {
"label": "significant figures",
"description": "number that sets the number of significant figures",
"type": "number"
},
"round": {
"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",
"type": "string/line"
},
"comma": {
"label": "thousands separator",
"description": "Sets or suppresses thousand separator in the numbers. “off” = no separator; “gaps”: use space not comma; “5” and “gaps5”: only add separator when number > 5 positions (10,000 or more)",
"default": "on",
"type": "string/line"
},
"sortable": {
"label": "sort key",
"description": "“on” generates a hidden sort key",
"type": "string/line"
}
}}</templatedata>


==See also==
* {{Temp|Cvt}}
* {{Temp|SI units}}
{{Convert navs}}
<noinclude>
[[Category:Convert by module documentation| ]]
</noinclude><includeonly>
[[Category:Convert templates| ]]
[[Category:Conversion templates]]
[[Category:Numbers as words conversion templates]]
[[Category:Sorting templates]]
</includeonly>

Template:Convert/doc

2016-06-20T19:42:21Z

178.16.7.96: /* Extra words: 4 planted acres */

{{documentation subpage}}
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk| {{formatnum:789000}}+ }}}}
{{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}}
'''Template {{tl|convert}}''' ''calculates'' measurements from one unit (you can enter) to another one, and then ''presents the results''. For example:
:<code><nowiki>{{convert|2|km|mi}}</nowiki></code> → {{convert|2|km|mi}}
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> → {{convert|7|mi|km}}

The available '''units''' are listed [[#Units|below]]. Units are case-sensitive always ({{xt|kW}}, ''not'' {{!xt|KW}} and ''not'' {{!xt|kw}}). Multiple '''formatting''' and calculation options are listed below.

{{hatnote|See [[Help:Convert]] for more complete information}}
{{hatnote|For currency conversion into US dollars, see [[Template:To USD]]}}

==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
By default, the first value shows unit name spelled out, the second the symbol (or abbreviation).
Use {{para|abbr|on/off}} to change this behaviour:
:<code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}
To abbreviate both:
:<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}}
* {{para|abbr|in}} toggles the default behaviour ({{para|abbr|out}}):
:<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{convert|1|lb|kg|abbr=in}}

===Convenience: {{tlf|cvt}} has {{para|abbr|on}} by default===
Template {{tl|cvt}} is similar to {{tlf|convert}}, but has pre-set {{para|abbr|on}}. In {{tlf|cvt}}, all other options are available. So:

:<code><nowiki>{{cvt|1|lb|kg}}</nowiki></code> → {{cvt|1|lb|kg}}
:is equal to:
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{cvt|1|lb|kg|abbr=on}}

==Adjective: ''a 10-mile distance''==
Use {{para|adj|on}} to produce the adjective form. The difference:
:<code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> → {{convert|10|mi|km}} to go. ''(To compare, default)''
:<code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> → A {{convert|10|mi|km|adj=on}} distance. ''(Adjective form)''
This option does not work with {{para|abbr|on}}.

==Rounding: ''100 ft'' is ''30 m'' or ''30.5 m'' or ''30.48 m''?==
By definition, 100 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===
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 figures, whichever is more precise. An exception to this is ''rounding temperatures'' (see [[#Rounding temperatures|below]]).

{| class="wikitable"
|-
! colspan="3" | Examples of rounding
|-
|'''Input'''||'''Displays as'''||'''Note'''
|-
|<code><nowiki>{{convert|123|ft|m|-1}}</nowiki></code> || {{convert|123|ft|m|-1}} ||
|-
|<code><nowiki>{{convert|123|ft|m|0}}</nowiki></code> || {{convert|123|ft|m|0}} ||
|-
|<code><nowiki>{{convert|123|ft|m|1}}</nowiki></code> || {{convert|123|ft|m|1}} ||
|-
|<code><nowiki>{{convert|550|ft|m|0}}</nowiki></code> || {{convert|550|ft|m|0}} || Approximate value is 167.64 m
|-
|<code><nowiki>{{convert|550|ft|m}}</nowiki></code> || {{convert|550|ft|m}} || Rounds to 170, when approximate value is 167.64 m
|-
|<code><nowiki>{{convert|500|ft|m|0}}</nowiki></code> || {{convert|500|ft|m|0}} || Approximate value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|m}}</nowiki></code> || {{convert|500|ft|m}} || Rounds to 150, when approximate value is 152.4 m
|}

''Convert'' supports four types of rounding:

===Round to a given precision: ''use {{para|precision|}}''===
Specify the desired precision with the fourth unnamed parameter (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest 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: ''{{para|sigfig|}}''===
To specify the output number to be with ''n'' significant figures use {{para|sigfig|<number>}}:
* To compare: <code><nowiki>{{convert|1200|ft|m}}</nowiki></code> → {{convert|1200|ft|m}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki></code> → {{convert|1200|ft|m|sigfig=4}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=3}}</nowiki></code> → {{convert|1200|ft|m|sigfig=3}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=2}}</nowiki></code> → {{convert|1200|ft|m|sigfig=2}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki></code> → {{convert|1200|ft|m|sigfig=1}}
Setting {{para|sigfig|<=0}} is meaningless
* <code><nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki></code> → {{convert|1200|ft|m|sigfig=0}}

===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
Using {{para|round|5}} rounds the outcome to a multiple of 5.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<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.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> → {{convert|10|m|ft|round=25}}
:To compare: <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}}:
:<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> → {{convert|10 x 200 x 3000|m|ft|round=each}}

===Round to a multiple of a given fraction: ''{{frac|2|3|16}} inch''===
Specify the desired ''denominator'' using {{para|frac|<some positive integer>}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|3}}).
:<code><nowiki>{{convert|5.56|cm|in|frac=16}}</nowiki></code> → {{convert|5.56|cm|in|frac=16}}
:<code><nowiki>{{convert|8|cm|in|frac=4}}</nowiki></code> → {{convert|8|cm|in|frac=4}}
The fraction is reduced when possible:
:<code><nowiki>{{convert|8|cm|in|frac=100}}</nowiki></code> → {{convert|8|cm|in|frac=100}}
:<code><nowiki>{{convert|8|cm|in}}</nowiki></code> → {{convert|8|cm|in|sigfig=4}} (To compare)

==={{anchor|Rounding temperatures}}In temperatures: rounding ''°C'', ''°F'' and ''K''===
In temperatures, the conversion will be rounded either to precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.

#{{#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|-300|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}}

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 into five significant output digits because of the two numbers 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.

==Into multiple units: ''{{convert|10|C|F K}}''==
Separate the multiple output units by a space:
:<code><nowiki>{{convert|10|C|F K}}</nowiki></code> → {{convert|10|C|F K}}
:<code><nowiki>{{convert|5|km|mi nmi}}</nowiki></code> → {{convert|5|km|mi nmi}}
If the output unit names contain spaces, use a '+' separator.
;See also
For multiple-unit options like ''1 ft 5 in'', see [[#In input]] and [[#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: 
{{Convert/doc/range separator list}}

===Multiple dimensions: ''{{convert|6|x|12|m|ft|abbr=on}}''===
; Use "by":
:<code><nowiki>{{convert|6|by|12|ft|m}}</nowiki></code> → {{convert|6|by|12|ft|m}}
;Use "×" or ""x"":
:<code><nowiki>{{convert|6|x|12|m|ft}}</nowiki></code> → {{convert|6|x|12|m|ft}}

In science, the formal way is to set <code>|x|</code> and {{para|abbr|on}} (keeping dimensions right, like in ''area = x km2''):
:<code><nowiki>{{convert|6|x|12|m|ft|abbr=on}}</nowiki></code> → {{convert|6|x|12|m|ft|abbr=on}}

===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:
* <code><nowiki>{{convert|1|ft|3|in|mm}}</nowiki></code> → {{convert|1|ft|3|in|mm}} (to compare)
* <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}}

==Words==
===Spelling of unit name: UK ''metre'' or US ''meter''?===
Default spelling of units is en-UK. 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}}

===Spell out numbers: ''ten miles''===
To write a number in words, use {{para|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}}:
:<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}}
:<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> → {{convert|10|mi|m|spell=On}}

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> → {{convert|10|mi|m|spell=on|abbr=off|sp=us}}
===Extra words: ''4 planted acres''===
:''Incomplete section''
*<code><nowiki>{{convert|4|acre||adj=pre|planted}}</nowiki></code> → {{convert|4|acre||adj=pre|planted}}
*<code><nowiki>{{convert|4|acre||disp=preunit|planted }}</nowiki></code> → {{convert|4|acre||disp=preunit|planted }}
*<code><nowiki>{{convert|4|acre||disp=preunit|planted }}</nowiki></code> → {{convert|4|acre||disp=preunit|planted |reforested }}

===Extra adjective words: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
:<code><nowiki>{{convert|10|ft|m|adj=mid|-long}}</nowiki></code> → {{convert|10|ft|m|adj=mid|-long}}

===Plurals: ''1 inch, 2 inches''===
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}}

;Exception:
Entering the unit spelled <code>|foot|</code> forces singular output "foot", whatever the number is.
* <code><nowiki>{{convert|100|foot|abbr=off}}</nowiki></code> → {{convert|100|foot|abbr=off}}

==Numbers==

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

To illustrate, these are trivial calculations (from meter to meter), showing the multiplication factor:
* {{convert|12|Gm|m|abbr=on}}
* {{convert|12|μm|m|abbr=on}}

The prefix can be added before the SI unit (here: unit <code>m</code> for meter):
* <code><nowiki>{{convert|12|Gm|mi|abbr=on}}</nowiki></code> → {{convert|12|Gm|mi|abbr=on}}
* <code>Mm</code>: {{convert|12|Mm|mi|abbr=on}}
* <code>km</code>: {{convert|12|km|ft|abbr=on}}
* <code>mm</code>: {{convert|12|mm|in|abbr=on}}
* <code>μm</code>: {{convert|12|μm|mm|abbr=on}}
* <code>um</code>: {{convert|12|um|mm|abbr=on}} (letter "u" can be used for "μ" here)

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

As an exception, the non-SI unit "inch" can have the "μ" prefix too)
* <code><nowiki>{{convert|12|μm|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}

:{{further|Help:Convert units#SI prefixes}}

===Engineering notation: ''7 × 106 m''===

====In the unit: ''e6m''====
[[Engineering notation|Engineering number notations]] like ''7{{smallcaps|E}}6'' (for 7 × 106) can be entered as a "prefix" to the unit:
:<code><nowiki>{{convert|7|e6m}}</nowiki></code> → {{convert|7|e6m}}
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−14''===
In [[scientific notation]], a number is written like {{rnd|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}}

===Input with fractions: ''{{convert|1+1/2|in|mm|1}}''===
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}}

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 (do not require a calculation)

===Output with horizontal fraction bar in: ''{{sfrac|1|2}} inch''===

Using a double slash (<code>//</code>) returns a horizontal bar fraction:
* <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}}

===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}}
*<code><nowiki>{{convert|1 234 567|m|ft}}</nowiki></code> → {{convert|1 234 567|m|ft}} {{nay}}

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}}</nowiki></code> → {{convert|1234567|m|ft}} (To compare, default)
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps}}

Setting {{para|comma|5}} or {{para|comma|gaps5}} will only add the separator when the number of digits is 5 or more:
*<code><nowiki>{{convert|1234|m|ft}}</nowiki></code> → {{convert|1234|m|ft}} (To compare, default)
*<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}}
*<code><nowiki>{{convert|1234|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234|m|ft|comma=gaps5}}
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps5}}

==Output manipulation==
===Brackets and separators: ''10 m [33 ft]''===
Punctuation that distinguishes the two measurements is set by {{para|disp|}}. 
Options are: <code>b</code> (the default), <code>sqbr</code>, <code>comma</code>, <code>or</code>, <code>br</code>, <code>x{{!}}≈...</code>:
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}—''( ) 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=comma}}</nowiki></code> → {{convert|10|m|ft|disp=comma}}
:<code><nowiki>{{convert|10|m|ft|disp=or}}</nowiki></code> → {{convert|10|m|ft|disp=or}}

Setting {{para|disp|br}} will force a new line (<code> </code>)
:<code><nowiki>{{convert|10|m|ft|disp=br}}</nowiki></code> → {{convert|10|m|ft|disp=br}}
Also {{para|disp|br()}} will force a new line, and keep the brackets:
:<code><nowiki>{{convert|10|m|ft|disp=br()}}</nowiki></code> → {{convert|10|m|ft|disp=br()}}

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_}}—(To display spaces, use <code>&nbsp;</code>)

===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:
:<code><nowiki>{{convert|1|mi|m}}</nowiki></code> → {{convert|1|mi|m|sigfig=5|abbr=off}} (To compare, default)
:<code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> → {{convert|1|mi|m|order=flip|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}}

=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
It is possible to display only parts of the conversion result:


{| class="wikitable"
! Convert !! Output !! Description
|-
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}}
| Default, to compare
|-
| <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|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|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|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=out}}</nowiki></code> || {{convert|2|cuyd|m3|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
|}
===Display both input name and symbol: ''2 kilopascals [kPa]''===
Setting {{para|abbr|~}} returns both name and symbol of the first (input) unit:
:<code><nowiki>{{convert|2|kPa|psi|abbr=~}}</nowiki></code> → {{convert|2|kPa|psi|abbr=~}}
:<code><nowiki>A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure</nowiki></code> → {{nowrap|A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure}}

==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 showing numbers only===
Using {convert} in a table cell, with {{para|disp|table}} splits the result over two columns:
:<code><nowiki>{{convert|10|m|ft|disp=table}}</nowiki></code> → {{convert|10|m|ft|disp=table}}

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

The units are added as a column header:
:{| class=wikitable
! style="width:10em;" |  
! style="width:10em;" | m
! style="width:10em;" | ft
|-
| {{para|disp|table}}
| {{convert|10|m|ft|disp=table}}
|-
|{{para|disp|tablecen}}
| {{convert|20|m|ft|disp=tablecen}}
|-
|{{para|disp|<other>}} (default)
|{{convert|30|m|ft|disp=}}
|}

===Sorting===
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=700110000000000000010 metres (33&nbsp;ft)}}

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

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

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==
===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}}}}
<div style="height: 400px; overflow: auto; padding: 3px; border: 1px solid #aaa;">
{{Convert/list of units}}
</div>

==='per' units: ''kg/hl''===
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}}

===Units of difference===
When a number is the measurement for a ''difference'', one conversion is done. This may occur in temperatures (°C, °F, K). Compare this to a ''range'', when two conversions are done.

The only available units of difference are: {{para|C-change}}, {{para|F-change}} and {{para| K-change}}.

:{{#invoke:DemoTemplate|convert|10|C}} -- regular temperature
:{{#invoke:DemoTemplate|convert|10|C-change}} -- difference (e.g., "The temperature changed from 30 into 40 °C")
:{{#invoke:DemoTemplate|convert|10-15|C}} -- range (e.g., "The temperature is between 10 and 15 °C")

Consistently, into multiple units:
:<code><nowiki>A rise of {{convert|10|C-change|F-change K-change}}</nowiki></code> → A rise of {{convert|10|C-change|F-change K-change}}

===Multiple units: ''1 ft 5 in''===
====In input====
Base document {{slink|Module:Convert/documentation/conversion data/doc|Input multiples|nopage=y}} 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):
::*<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 {{slink|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
:*<code><nowiki>{{convert|2|m}}</nowiki></code> → {{convert|2|m}}—the default

;See also
* {{tl|hands}} a length used to measure horses
* {{tl|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:
:* <code><nowiki>{{convert|10|$/mi|$/km}}</nowiki></code> → {{convert|10|$/mi|$/km}}

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

==Parameter list==
{{convert/doc/parameter list}}

==Deprecated options==
{{Convert/doc/deprecations list}}

==TemplateData==
{{TemplateDataHeader}}

<templatedata>{
"description": "Converts measurements to other units.",
"params": {
"1": {
"label": "value",
"description": "the value to convert",
"type": "number"
},
"2": {
"label": "from unit",
"description": "",
"type": "string/line"
},
"3": {
"label": "to units",
"description": "the unit to convert into",
"type": "string/line"
},
"4": {
"label": "precision or suffix",
"description": "significant digits after decimal dot or, if negative, exponent of ten",
"type": "number"
},
"lk": {
"label": "link units",
"description": "“on” all, “in” input, “out” output or “off” no units",
"default": "off",
"type": "string/line"
},
"abbr": {
"label": "abbreviation",
"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",
"default": "out",
"type": "string/line"
},
"sp": {
"label": "spelling",
"description": "“us” display U.S. spelling of unit names",
"type": "string/line"
},
"adj": {
"label": "adjective",
"description": "adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end",
"type": "string/line"
},
"disp": {
"label": "conversion",
"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",
"default": "b",
"type": "string/line"
},
"order": {
"label": "ordering",
"description": "“flip” returns converted value first, input value second.",
"type": "string/line"
},
"sigfig": {
"label": "significant figures",
"description": "number that sets the number of significant figures",
"type": "number"
},
"round": {
"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",
"type": "string/line"
},
"comma": {
"label": "thousands separator",
"description": "Sets or suppresses thousand separator in the numbers. “off” = no separator; “gaps”: use space not comma; “5” and “gaps5”: only add separator when number > 5 positions (10,000 or more)",
"default": "on",
"type": "string/line"
},
"sortable": {
"label": "sort key",
"description": "“on” generates a hidden sort key",
"type": "string/line"
}
}}</templatedata>


==See also==
* {{Temp|Cvt}}
* {{Temp|SI units}}
{{Convert navs}}
<noinclude>
[[Category:Convert by module documentation| ]]
</noinclude><includeonly>
[[Category:Convert templates| ]]
[[Category:Conversion templates]]
[[Category:Numbers as words conversion templates]]
[[Category:Sorting templates]]
</includeonly>

Template:Convert/doc/parameter list

2016-06-20T19:41:00Z

178.16.7.96:

{| class="wikitable sortable collapsible {{{state|uncollapsed}}}" style="width:100%;"
! colspan=4 style="background:#eee" | {{navbar-collapsible|'''Parameter options for <nowiki>{{convert}}</nowiki>'''|Convert/doc/parameter list}}
|-
! Parameter
! {{abbr|1=Value|2=Sort by value of parameter}}
! Description
! Note
|-
|<code>|abbr=in</code> || {{hidden sort key|in}}
| Use symbol for first (left-hand side) unit
| Symbol ('abbreviation')
|-
|<code>|abbr=off</code> || {{hidden sort key|off}}
| rowspan=2 | Use name for all units
| rowspan=2 | Symbol ('abbreviation')
|-
|<code>|abbr=none</code> || {{hidden sort key|none}}
|-
|<code>|abbr=on</code> || {{hidden sort key|on}}
| Use symbol for all units
| Symbol ('abbreviation')
|-
|<code>|abbr=out</code> || {{hidden sort key|out}}
| Use symbol for right-hand side unit (default)
| Symbol ('abbreviation')
|-
|<code>|abbr=values</code> || {{hidden sort key|values}}
| Show only input and output numbers, not units
| Parts only
|-
|<code>|abbr=~</code> || {{hidden sort key|~}}
| Shows both unit name and symbol
| Symbol & name
|-
|<code>|adj=j</code> || {{hidden sort key|j}}
| Join number and unit name using "&nbsp;" instead of a space
| Join values
|-
|<code>|adj=mid|…</code> || {{hidden sort key|mid}}
| User-specified text after the input unit; sets <code>adj=on</code> (adjective). Expects 1 unnamed parameter.
| Word adding, adjective
|-
|<code>|adj=on</code> || {{hidden sort key|on}}
| Unit name is adjective (singular and hyphenated)
| Grammar, adjective
|-
|<code>|adj=pre|…</code> || {{hidden sort key|pre}}
| User-specified text before input unit. Expects 1 unnamed parameter.
| Word adding
|-
|<code>|adj=ri0</code> || {{hidden sort key|ri0}}
| Round input with precision 0
| Rounding and significant figures
|-
|<code>|adj=ri1</code> || {{hidden sort key|ri1}}
| Round input with precision 1
| Rounding and significant figures
|-
|<code>|adj=ri2</code> || {{hidden sort key|ri2}}
| Round input with precision 2
| Rounding and significant figures
|-
|<code>|adj=ri3</code> || {{hidden sort key|ri3}}
| Round input with precision 3
| Rounding and significant figures
|-
|<code>|disp=b</code> || {{hidden sort key|b}}
| Join input and output using " (...)" (default)
| Join values
|-
|<code>|disp=sqbr</code> || {{hidden sort key|sqbr}}
| Join input and output using " [...]"
| Join values
|-
|<code>|disp=br</code> || {{hidden sort key|br}}
| Join input and output using " "
| Join values
|-
|<code>|disp=comma</code> || {{hidden sort key|comma}}
| Join input and output using ", "
| Join values
|-
|<code>|disp=or</code> || {{hidden sort key|or}}
| Join input and output using " or "
| Join values
|-
|<code>|disp=number</code> || {{hidden sort key|number}}
| rowspan=2 | Display output number only
| rowspan=2 | Parts only
|-
|<code>|disp=output number only</code> || {{hidden sort key|output number only}}
|-
|<code>|disp=out</code> || {{hidden sort key|out}}
| rowspan=2 | Display only output number and name/symbol
| rowspan=2 | Parts only
|-
|<code>|disp=output only</code> || {{hidden sort key|output only}}
|-
|<code>|disp=preunit|…[|…]</code> || {{hidden sort key|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
|-
|<code>|disp=table</code> || {{hidden sort key|table}}
| Output is suitable for a table cell with align="right"
| Table columns
|-
|<code>|disp=tablecen</code> || {{hidden sort key|tablecen}}
| Output is suitable for a table cell with align="center"
| Table columns
|-
|<code>|disp=unit</code> || {{hidden sort key|unit}}
| Display input name/symbol only (not input number, not output)
| Parts only
|-
|<code>|disp=unit2</code> || {{hidden sort key|unit2}}
| Display output name/symbol only (not input; not output number)
| Parts only
|-
|<code>|disp=x|...</code> || {{hidden sort key|x}}
| Join input and output using user-specified text
| Word adding
|-
|<code>|comma=5</code> || {{hidden sort key|05}}
| Only use comma for thousands separator if 5 or more digits
| Number format
|-
|<code>|comma=gaps</code> || {{hidden sort key|gaps}}
| Use gaps (space), not comma, for thousands separator
| Number format
|-
|<code>|comma=gaps5</code> || {{hidden sort key|gaps5}}
| Use gaps (space), but only if 5 or more digits
| Number format
|-
|<code>|comma=off</code> || {{hidden sort key|off}}
| No thousands separator
| Number format
|-
|<code>|frac=''N''</code> || {{hidden sort key|N}}
| Show imperial number in fractions, denominator=''N''
| Number format, fraction
|-
|<code>|lk=in</code> || {{hidden sort key|in}}
| Link left-hand side unit name or symbol
| Unit link
|-
|<code>|lk=on</code> || {{hidden sort key|on}}
| Link all unit names or symbols (but not twice for the same unit)
| Unit link
|-
|<code>|lk=out</code> || {{hidden sort key|out}}
| Link right-hand side unit name or symbol
| Unit link
|-
|<code>|order=flip</code> || {{hidden sort key|flip}}
| Inverts order of input, output measurements (conversion first)
| Order
|-
|<code>|round=5</code> || {{hidden sort key|05}}
| Rounds calculation to the nearest multiple of 5
| Rounding and significant figures
|-
|<code>|round=25</code> || {{hidden sort key|25}}
| Rounds calculation to the nearest multiple of 25
| Rounding and significant figures
|-
|<code>|round=each</code> || {{hidden sort key|each}}
| In a range, each number is rounded by the default rounding
| Rounding and significant figures
|-
|<code>|sigfig=''N''</code> || {{hidden sort key|N}}
| Round output number to ''N'' significant figures (''N'' is a positive integer)
| Rounding and significant figures
|-
|<code>|sortable=in</code> || {{hidden sort key|in}}
| rowspan=2 | Output numeric hidden sort field for use in a sortable table (based on input)
| rowspan=2 | Table sort
|-
|<code>|sortable=on</code> || {{hidden sort key|on}}
|-
|<code>|sortable=out</code> || {{hidden sort key|out}}
| Output numeric hidden sort field for use in a sortable table (based on output)
| Table sort
|-
|<code>|sp=us</code> || {{hidden sort key|us}}
| Use U.S. spelling (like "meter" instead of default "metre")
| Spelling U.S. names
|-
|<code>|spell=in</code> || {{hidden sort key|in}}
| Spell input number in words
| Spelling numbers
|-
|<code>|spell=In</code> || {{hidden sort key|In}}
| Spell input number in words with first letter uppercase
| Spelling numbers
|-
|<code>|spell=on</code> || {{hidden sort key|on}}
| Spell input and output numbers in words
| Spelling numbers
|-
|<code>|spell=On</code> || {{hidden sort key|On}}
| Spell input and output numbers in words with first letter uppercase
| Spelling numbers
|-
|<code>|$=''€''</code> || {{hidden sort key|$}}
| Replace $-sign with a currency sign, for example in <code>$/acre</code> {{nowrap|(no currency conversion happens)}}
| Cost per unit
|-
|<code>|debug=yes</code> || {{hidden sort key|yes}}
| '''Debugging only'''. In a sortable table: show the normally hidden sort key
| Table sort
|- 
|<code>{{!xt|1=|abbr=comma}}</code> || {{hidden sort key|comma}}
| '''Deprecated'''. Use {{xt|1=|comma=off}}
| Number format
|-
|<code>{{!xt|1=|abbr=mos}}</code> || {{hidden sort key|mos}}
| '''Deprecated'''. Use {{xt|1=|x|}} ''or'' {{xt|1=|by|}}
| Range format
|-
|<code>{{!xt|1=|adj=1}}</code> || {{hidden sort key|01}}
| '''Deprecated'''. Do not use. No need to deviate from [[MOS:FRACTION|MOS]] regarding plurals
| Plural or singular
|-
|<code>{{!xt|1=|adj=flip}}</code> || {{hidden sort key|flip}}
| '''Deprecated'''. Use {{xt|1=|order=flip}}
| Order
|-
| <code>{{!xt|1=|adj=nocomma}}</code> || {{hidden sort key|nocomma}}
| '''Deprecated'''. Use {{xt|1=|comma=off}}
| Number format
|-
|<code>{{!xt|1=|disp=2}}</code> || {{hidden sort key|02}}
| '''Deprecated'''. Use {{xt|1=|disp=output only}}
| Parts only
|-
|<code>{{!xt|1=|disp=5}}</code> || {{hidden sort key|05}}
| '''Deprecated'''. Use {{xt|1=|round=5}}
| Rounding and significant figures
|-
|<code>{{!xt|1=|disp=flip}}</code> || {{hidden sort key|flip}}
| '''Deprecated'''. Use {{xt|1=|order=flip}}
| Order
|-
|<code>{{!xt|1=|disp=flip5}}</code> || {{hidden sort key|flip5}}
| '''Deprecated'''. Use {{xt|1=|order=flip |round=5}}
| Order, rounding
|-
| <code>{{!xt|1=|disp=nocomma}}</code> || {{hidden sort key|nocomma}}
| '''Deprecated'''. Use {{xt|1=|comma=off}}
| Number format
|-
|<code>{{!xt|1=|disp=u2}}</code> || {{hidden sort key|u2}}
| '''Deprecated'''. Use {{xt|1=|disp=unit2}}
| Parts only
|-
|<code>{{!xt|1=|near=5}}</code> || {{hidden sort key|05}}
| '''Deprecated'''. Use {{xt|1=|round=5}}
| Rounding and significant figures
|}<noinclude>
{{documentation}}
</noinclude>

Template:Convert/doc/parameter list

2016-06-20T19:39:34Z

178.16.7.96:

{| class="wikitable sortable collapsible {{{state|uncollapsed}}}" style="width:100%;"
! colspan=4 style="background:#eee" | {{navbar-collapsible|'''Parameter options for <nowiki>{{convert}}</nowiki>'''|Convert/doc/parameter list}}
|-
! Parameter
! {{abbr|1=Value|2=Sort by value of parameter}}
! Description
! Note
|-
|<code>|abbr=in</code> || {{hidden sort key|in}}
| Use symbol for first (left-hand side) unit
| Symbol ('abbreviation')
|-
|<code>|abbr=off</code> || {{hidden sort key|off}}
| rowspan=2 | Use name for all units
| rowspan=2 | Symbol ('abbreviation')
|-
|<code>|abbr=none</code> || {{hidden sort key|none}}
|-
|<code>|abbr=on</code> || {{hidden sort key|on}}
| Use symbol for all units
| Symbol ('abbreviation')
|-
|<code>|abbr=out</code> || {{hidden sort key|out}}
| Use symbol for right-hand side unit (default)
| Symbol ('abbreviation')
|-
|<code>|abbr=values</code> || {{hidden sort key|values}}
| Show only input and output numbers, not units
| Parts only
|-
|<code>|abbr=~</code> || {{hidden sort key|~}}
| Shows both unit name and symbol
| Symbol & name
|-
|<code>|adj=j</code> || {{hidden sort key|j}}
| Join number and unit name using "&nbsp;" instead of a space
| Join values
|-
|<code>|adj=mid|…</code> || {{hidden sort key|mid}}
| User-specified text after the input unit; sets <code>adj=on</code> (adjective)
| Word adding, adjective
|-
|<code>|adj=on</code> || {{hidden sort key|on}}
| Unit name is adjective (singular and hyphenated)
| Grammar, adjective
|-
|<code>|adj=pre|…</code> || {{hidden sort key|pre}}
| User-specified text before input unit
| Word adding
|-
|<code>|adj=ri0</code> || {{hidden sort key|ri0}}
| Round input with precision 0
| Rounding and significant figures
|-
|<code>|adj=ri1</code> || {{hidden sort key|ri1}}
| Round input with precision 1
| Rounding and significant figures
|-
|<code>|adj=ri2</code> || {{hidden sort key|ri2}}
| Round input with precision 2
| Rounding and significant figures
|-
|<code>|adj=ri3</code> || {{hidden sort key|ri3}}
| Round input with precision 3
| Rounding and significant figures
|-
|<code>|disp=b</code> || {{hidden sort key|b}}
| Join input and output using " (...)" (default)
| Join values
|-
|<code>|disp=sqbr</code> || {{hidden sort key|sqbr}}
| Join input and output using " [...]"
| Join values
|-
|<code>|disp=br</code> || {{hidden sort key|br}}
| Join input and output using " "
| Join values
|-
|<code>|disp=comma</code> || {{hidden sort key|comma}}
| Join input and output using ", "
| Join values
|-
|<code>|disp=or</code> || {{hidden sort key|or}}
| Join input and output using " or "
| Join values
|-
|<code>|disp=number</code> || {{hidden sort key|number}}
| rowspan=2 | Display output number only
| rowspan=2 | Parts only
|-
|<code>|disp=output number only</code> || {{hidden sort key|output number only}}
|-
|<code>|disp=out</code> || {{hidden sort key|out}}
| rowspan=2 | Display only output number and name/symbol
| rowspan=2 | Parts only
|-
|<code>|disp=output only</code> || {{hidden sort key|output only}}
|-
|<code>|disp=preunit|…[|…]</code> || {{hidden sort key|preunit}}
| Text to be inserted after value and before units, for both input and output, with optionally different text for output.
| Word adding
|-
|<code>|disp=table</code> || {{hidden sort key|table}}
| Output is suitable for a table cell with align="right"
| Table columns
|-
|<code>|disp=tablecen</code> || {{hidden sort key|tablecen}}
| Output is suitable for a table cell with align="center"
| Table columns
|-
|<code>|disp=unit</code> || {{hidden sort key|unit}}
| Display input name/symbol only (not input number, not output)
| Parts only
|-
|<code>|disp=unit2</code> || {{hidden sort key|unit2}}
| Display output name/symbol only (not input; not output number)
| Parts only
|-
|<code>|disp=x|...</code> || {{hidden sort key|x}}
| Join input and output using user-specified text
| Word adding
|-
|<code>|comma=5</code> || {{hidden sort key|05}}
| Only use comma for thousands separator if 5 or more digits
| Number format
|-
|<code>|comma=gaps</code> || {{hidden sort key|gaps}}
| Use gaps (space), not comma, for thousands separator
| Number format
|-
|<code>|comma=gaps5</code> || {{hidden sort key|gaps5}}
| Use gaps (space), but only if 5 or more digits
| Number format
|-
|<code>|comma=off</code> || {{hidden sort key|off}}
| No thousands separator
| Number format
|-
|<code>|frac=''N''</code> || {{hidden sort key|N}}
| Show imperial number in fractions, denominator=''N''
| Number format, fraction
|-
|<code>|lk=in</code> || {{hidden sort key|in}}
| Link left-hand side unit name or symbol
| Unit link
|-
|<code>|lk=on</code> || {{hidden sort key|on}}
| Link all unit names or symbols (but not twice for the same unit)
| Unit link
|-
|<code>|lk=out</code> || {{hidden sort key|out}}
| Link right-hand side unit name or symbol
| Unit link
|-
|<code>|order=flip</code> || {{hidden sort key|flip}}
| Inverts order of input, output measurements (conversion first)
| Order
|-
|<code>|round=5</code> || {{hidden sort key|05}}
| Rounds calculation to the nearest multiple of 5
| Rounding and significant figures
|-
|<code>|round=25</code> || {{hidden sort key|25}}
| Rounds calculation to the nearest multiple of 25
| Rounding and significant figures
|-
|<code>|round=each</code> || {{hidden sort key|each}}
| In a range, each number is rounded by the default rounding
| Rounding and significant figures
|-
|<code>|sigfig=''N''</code> || {{hidden sort key|N}}
| Round output number to ''N'' significant figures (''N'' is a positive integer)
| Rounding and significant figures
|-
|<code>|sortable=in</code> || {{hidden sort key|in}}
| rowspan=2 | Output numeric hidden sort field for use in a sortable table (based on input)
| rowspan=2 | Table sort
|-
|<code>|sortable=on</code> || {{hidden sort key|on}}
|-
|<code>|sortable=out</code> || {{hidden sort key|out}}
| Output numeric hidden sort field for use in a sortable table (based on output)
| Table sort
|-
|<code>|sp=us</code> || {{hidden sort key|us}}
| Use U.S. spelling (like "meter" instead of default "metre")
| Spelling U.S. names
|-
|<code>|spell=in</code> || {{hidden sort key|in}}
| Spell input number in words
| Spelling numbers
|-
|<code>|spell=In</code> || {{hidden sort key|In}}
| Spell input number in words with first letter uppercase
| Spelling numbers
|-
|<code>|spell=on</code> || {{hidden sort key|on}}
| Spell input and output numbers in words
| Spelling numbers
|-
|<code>|spell=On</code> || {{hidden sort key|On}}
| Spell input and output numbers in words with first letter uppercase
| Spelling numbers
|-
|<code>|$=''€''</code> || {{hidden sort key|$}}
| Replace $-sign with a currency sign, for example in <code>$/acre</code> {{nowrap|(no currency conversion happens)}}
| Cost per unit
|-
|<code>|debug=yes</code> || {{hidden sort key|yes}}
| '''Debugging only'''. In a sortable table: show the normally hidden sort key
| Table sort
|- 
|<code>{{!xt|1=|abbr=comma}}</code> || {{hidden sort key|comma}}
| '''Deprecated'''. Use {{xt|1=|comma=off}}
| Number format
|-
|<code>{{!xt|1=|abbr=mos}}</code> || {{hidden sort key|mos}}
| '''Deprecated'''. Use {{xt|1=|x|}} ''or'' {{xt|1=|by|}}
| Range format
|-
|<code>{{!xt|1=|adj=1}}</code> || {{hidden sort key|01}}
| '''Deprecated'''. Do not use. No need to deviate from [[MOS:FRACTION|MOS]] regarding plurals
| Plural or singular
|-
|<code>{{!xt|1=|adj=flip}}</code> || {{hidden sort key|flip}}
| '''Deprecated'''. Use {{xt|1=|order=flip}}
| Order
|-
| <code>{{!xt|1=|adj=nocomma}}</code> || {{hidden sort key|nocomma}}
| '''Deprecated'''. Use {{xt|1=|comma=off}}
| Number format
|-
|<code>{{!xt|1=|disp=2}}</code> || {{hidden sort key|02}}
| '''Deprecated'''. Use {{xt|1=|disp=output only}}
| Parts only
|-
|<code>{{!xt|1=|disp=5}}</code> || {{hidden sort key|05}}
| '''Deprecated'''. Use {{xt|1=|round=5}}
| Rounding and significant figures
|-
|<code>{{!xt|1=|disp=flip}}</code> || {{hidden sort key|flip}}
| '''Deprecated'''. Use {{xt|1=|order=flip}}
| Order
|-
|<code>{{!xt|1=|disp=flip5}}</code> || {{hidden sort key|flip5}}
| '''Deprecated'''. Use {{xt|1=|order=flip |round=5}}
| Order, rounding
|-
| <code>{{!xt|1=|disp=nocomma}}</code> || {{hidden sort key|nocomma}}
| '''Deprecated'''. Use {{xt|1=|comma=off}}
| Number format
|-
|<code>{{!xt|1=|disp=u2}}</code> || {{hidden sort key|u2}}
| '''Deprecated'''. Use {{xt|1=|disp=unit2}}
| Parts only
|-
|<code>{{!xt|1=|near=5}}</code> || {{hidden sort key|05}}
| '''Deprecated'''. Use {{xt|1=|round=5}}
| Rounding and significant figures
|}<noinclude>
{{documentation}}
</noinclude>

Template:Convert/doc

2016-06-20T19:38:00Z

178.16.7.96: /* Extra words: 4 planted acres */

{{documentation subpage}}
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk| {{formatnum:789000}}+ }}}}
{{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}}
'''Template {{tl|convert}}''' ''calculates'' measurements from one unit (you can enter) to another one, and then ''presents the results''. For example:
:<code><nowiki>{{convert|2|km|mi}}</nowiki></code> → {{convert|2|km|mi}}
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> → {{convert|7|mi|km}}

The available '''units''' are listed [[#Units|below]]. Units are case-sensitive always ({{xt|kW}}, ''not'' {{!xt|KW}} and ''not'' {{!xt|kw}}). Multiple '''formatting''' and calculation options are listed below.

{{hatnote|See [[Help:Convert]] for more complete information}}
{{hatnote|For currency conversion into US dollars, see [[Template:To USD]]}}

==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
By default, the first value shows unit name spelled out, the second the symbol (or abbreviation).
Use {{para|abbr|on/off}} to change this behaviour:
:<code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}
To abbreviate both:
:<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}}
* {{para|abbr|in}} toggles the default behaviour ({{para|abbr|out}}):
:<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{convert|1|lb|kg|abbr=in}}

===Convenience: {{tlf|cvt}} has {{para|abbr|on}} by default===
Template {{tl|cvt}} is similar to {{tlf|convert}}, but has pre-set {{para|abbr|on}}. In {{tlf|cvt}}, all other options are available. So:

:<code><nowiki>{{cvt|1|lb|kg}}</nowiki></code> → {{cvt|1|lb|kg}}
:is equal to:
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{cvt|1|lb|kg|abbr=on}}

==Adjective: ''a 10-mile distance''==
Use {{para|adj|on}} to produce the adjective form. The difference:
:<code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> → {{convert|10|mi|km}} to go. ''(To compare, default)''
:<code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> → A {{convert|10|mi|km|adj=on}} distance. ''(Adjective form)''
This option does not work with {{para|abbr|on}}.

==Rounding: ''100 ft'' is ''30 m'' or ''30.5 m'' or ''30.48 m''?==
By definition, 100 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===
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 figures, whichever is more precise. An exception to this is ''rounding temperatures'' (see [[#Rounding temperatures|below]]).

{| class="wikitable"
|-
! colspan="3" | Examples of rounding
|-
|'''Input'''||'''Displays as'''||'''Note'''
|-
|<code><nowiki>{{convert|123|ft|m|-1}}</nowiki></code> || {{convert|123|ft|m|-1}} ||
|-
|<code><nowiki>{{convert|123|ft|m|0}}</nowiki></code> || {{convert|123|ft|m|0}} ||
|-
|<code><nowiki>{{convert|123|ft|m|1}}</nowiki></code> || {{convert|123|ft|m|1}} ||
|-
|<code><nowiki>{{convert|550|ft|m|0}}</nowiki></code> || {{convert|550|ft|m|0}} || Approximate value is 167.64 m
|-
|<code><nowiki>{{convert|550|ft|m}}</nowiki></code> || {{convert|550|ft|m}} || Rounds to 170, when approximate value is 167.64 m
|-
|<code><nowiki>{{convert|500|ft|m|0}}</nowiki></code> || {{convert|500|ft|m|0}} || Approximate value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|m}}</nowiki></code> || {{convert|500|ft|m}} || Rounds to 150, when approximate value is 152.4 m
|}

''Convert'' supports four types of rounding:

===Round to a given precision: ''use {{para|precision|}}''===
Specify the desired precision with the fourth unnamed parameter (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest 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: ''{{para|sigfig|}}''===
To specify the output number to be with ''n'' significant figures use {{para|sigfig|<number>}}:
* To compare: <code><nowiki>{{convert|1200|ft|m}}</nowiki></code> → {{convert|1200|ft|m}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki></code> → {{convert|1200|ft|m|sigfig=4}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=3}}</nowiki></code> → {{convert|1200|ft|m|sigfig=3}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=2}}</nowiki></code> → {{convert|1200|ft|m|sigfig=2}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki></code> → {{convert|1200|ft|m|sigfig=1}}
Setting {{para|sigfig|<=0}} is meaningless
* <code><nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki></code> → {{convert|1200|ft|m|sigfig=0}}

===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
Using {{para|round|5}} rounds the outcome to a multiple of 5.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<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.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> → {{convert|10|m|ft|round=25}}
:To compare: <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}}:
:<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> → {{convert|10 x 200 x 3000|m|ft|round=each}}

===Round to a multiple of a given fraction: ''{{frac|2|3|16}} inch''===
Specify the desired ''denominator'' using {{para|frac|<some positive integer>}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|3}}).
:<code><nowiki>{{convert|5.56|cm|in|frac=16}}</nowiki></code> → {{convert|5.56|cm|in|frac=16}}
:<code><nowiki>{{convert|8|cm|in|frac=4}}</nowiki></code> → {{convert|8|cm|in|frac=4}}
The fraction is reduced when possible:
:<code><nowiki>{{convert|8|cm|in|frac=100}}</nowiki></code> → {{convert|8|cm|in|frac=100}}
:<code><nowiki>{{convert|8|cm|in}}</nowiki></code> → {{convert|8|cm|in|sigfig=4}} (To compare)

==={{anchor|Rounding temperatures}}In temperatures: rounding ''°C'', ''°F'' and ''K''===
In temperatures, the conversion will be rounded either to precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.

#{{#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|-300|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}}

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 into five significant output digits because of the two numbers 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.

==Into multiple units: ''{{convert|10|C|F K}}''==
Separate the multiple output units by a space:
:<code><nowiki>{{convert|10|C|F K}}</nowiki></code> → {{convert|10|C|F K}}
:<code><nowiki>{{convert|5|km|mi nmi}}</nowiki></code> → {{convert|5|km|mi nmi}}
If the output unit names contain spaces, use a '+' separator.
;See also
For multiple-unit options like ''1 ft 5 in'', see [[#In input]] and [[#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: 
{{Convert/doc/range separator list}}

===Multiple dimensions: ''{{convert|6|x|12|m|ft|abbr=on}}''===
; Use "by":
:<code><nowiki>{{convert|6|by|12|ft|m}}</nowiki></code> → {{convert|6|by|12|ft|m}}
;Use "×" or ""x"":
:<code><nowiki>{{convert|6|x|12|m|ft}}</nowiki></code> → {{convert|6|x|12|m|ft}}

In science, the formal way is to set <code>|x|</code> and {{para|abbr|on}} (keeping dimensions right, like in ''area = x km2''):
:<code><nowiki>{{convert|6|x|12|m|ft|abbr=on}}</nowiki></code> → {{convert|6|x|12|m|ft|abbr=on}}

===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:
* <code><nowiki>{{convert|1|ft|3|in|mm}}</nowiki></code> → {{convert|1|ft|3|in|mm}} (to compare)
* <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}}

==Words==
===Spelling of unit name: UK ''metre'' or US ''meter''?===
Default spelling of units is en-UK. 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}}

===Spell out numbers: ''ten miles''===
To write a number in words, use {{para|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}}:
:<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}}
:<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> → {{convert|10|mi|m|spell=On}}

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> → {{convert|10|mi|m|spell=on|abbr=off|sp=us}}
===Extra words: ''4 planted acres''===
:''Incomplete section''
*<code><nowiki>{{convert|4|acre||adj=pre|x=planted}}</nowiki></code> → {{convert|4|acre||adj=pre|planted}}
*<code><nowiki>{{convert|4|acre||disp=preunit|planted }}</nowiki></code> → {{convert|4|acre||disp=preunit|planted }}
*<code><nowiki>{{convert|4|acre||disp=preunit|planted }}</nowiki></code> → {{convert|4|acre||disp=preunit|planted |reforested }}

===Extra adjective words: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
:<code><nowiki>{{convert|10|ft|m|adj=mid|-long}}</nowiki></code> → {{convert|10|ft|m|adj=mid|-long}}

===Plurals: ''1 inch, 2 inches''===
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}}

;Exception:
Entering the unit spelled <code>|foot|</code> forces singular output "foot", whatever the number is.
* <code><nowiki>{{convert|100|foot|abbr=off}}</nowiki></code> → {{convert|100|foot|abbr=off}}

==Numbers==

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

To illustrate, these are trivial calculations (from meter to meter), showing the multiplication factor:
* {{convert|12|Gm|m|abbr=on}}
* {{convert|12|μm|m|abbr=on}}

The prefix can be added before the SI unit (here: unit <code>m</code> for meter):
* <code><nowiki>{{convert|12|Gm|mi|abbr=on}}</nowiki></code> → {{convert|12|Gm|mi|abbr=on}}
* <code>Mm</code>: {{convert|12|Mm|mi|abbr=on}}
* <code>km</code>: {{convert|12|km|ft|abbr=on}}
* <code>mm</code>: {{convert|12|mm|in|abbr=on}}
* <code>μm</code>: {{convert|12|μm|mm|abbr=on}}
* <code>um</code>: {{convert|12|um|mm|abbr=on}} (letter "u" can be used for "μ" here)

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

As an exception, the non-SI unit "inch" can have the "μ" prefix too)
* <code><nowiki>{{convert|12|μm|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}

:{{further|Help:Convert units#SI prefixes}}

===Engineering notation: ''7 × 106 m''===

====In the unit: ''e6m''====
[[Engineering notation|Engineering number notations]] like ''7{{smallcaps|E}}6'' (for 7 × 106) can be entered as a "prefix" to the unit:
:<code><nowiki>{{convert|7|e6m}}</nowiki></code> → {{convert|7|e6m}}
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−14''===
In [[scientific notation]], a number is written like {{rnd|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}}

===Input with fractions: ''{{convert|1+1/2|in|mm|1}}''===
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}}

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 (do not require a calculation)

===Output with horizontal fraction bar in: ''{{sfrac|1|2}} inch''===

Using a double slash (<code>//</code>) returns a horizontal bar fraction:
* <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}}

===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}}
*<code><nowiki>{{convert|1 234 567|m|ft}}</nowiki></code> → {{convert|1 234 567|m|ft}} {{nay}}

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}}</nowiki></code> → {{convert|1234567|m|ft}} (To compare, default)
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps}}

Setting {{para|comma|5}} or {{para|comma|gaps5}} will only add the separator when the number of digits is 5 or more:
*<code><nowiki>{{convert|1234|m|ft}}</nowiki></code> → {{convert|1234|m|ft}} (To compare, default)
*<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}}
*<code><nowiki>{{convert|1234|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234|m|ft|comma=gaps5}}
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps5}}

==Output manipulation==
===Brackets and separators: ''10 m [33 ft]''===
Punctuation that distinguishes the two measurements is set by {{para|disp|}}. 
Options are: <code>b</code> (the default), <code>sqbr</code>, <code>comma</code>, <code>or</code>, <code>br</code>, <code>x{{!}}≈...</code>:
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}—''( ) 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=comma}}</nowiki></code> → {{convert|10|m|ft|disp=comma}}
:<code><nowiki>{{convert|10|m|ft|disp=or}}</nowiki></code> → {{convert|10|m|ft|disp=or}}

Setting {{para|disp|br}} will force a new line (<code> </code>)
:<code><nowiki>{{convert|10|m|ft|disp=br}}</nowiki></code> → {{convert|10|m|ft|disp=br}}
Also {{para|disp|br()}} will force a new line, and keep the brackets:
:<code><nowiki>{{convert|10|m|ft|disp=br()}}</nowiki></code> → {{convert|10|m|ft|disp=br()}}

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_}}—(To display spaces, use <code>&nbsp;</code>)

===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:
:<code><nowiki>{{convert|1|mi|m}}</nowiki></code> → {{convert|1|mi|m|sigfig=5|abbr=off}} (To compare, default)
:<code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> → {{convert|1|mi|m|order=flip|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}}

=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
It is possible to display only parts of the conversion result:


{| class="wikitable"
! Convert !! Output !! Description
|-
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}}
| Default, to compare
|-
| <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|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|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|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=out}}</nowiki></code> || {{convert|2|cuyd|m3|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
|}
===Display both input name and symbol: ''2 kilopascals [kPa]''===
Setting {{para|abbr|~}} returns both name and symbol of the first (input) unit:
:<code><nowiki>{{convert|2|kPa|psi|abbr=~}}</nowiki></code> → {{convert|2|kPa|psi|abbr=~}}
:<code><nowiki>A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure</nowiki></code> → {{nowrap|A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure}}

==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 showing numbers only===
Using {convert} in a table cell, with {{para|disp|table}} splits the result over two columns:
:<code><nowiki>{{convert|10|m|ft|disp=table}}</nowiki></code> → {{convert|10|m|ft|disp=table}}

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

The units are added as a column header:
:{| class=wikitable
! style="width:10em;" |  
! style="width:10em;" | m
! style="width:10em;" | ft
|-
| {{para|disp|table}}
| {{convert|10|m|ft|disp=table}}
|-
|{{para|disp|tablecen}}
| {{convert|20|m|ft|disp=tablecen}}
|-
|{{para|disp|<other>}} (default)
|{{convert|30|m|ft|disp=}}
|}

===Sorting===
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=700110000000000000010 metres (33&nbsp;ft)}}

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

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

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==
===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}}}}
<div style="height: 400px; overflow: auto; padding: 3px; border: 1px solid #aaa;">
{{Convert/list of units}}
</div>

==='per' units: ''kg/hl''===
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}}

===Units of difference===
When a number is the measurement for a ''difference'', one conversion is done. This may occur in temperatures (°C, °F, K). Compare this to a ''range'', when two conversions are done.

The only available units of difference are: {{para|C-change}}, {{para|F-change}} and {{para| K-change}}.

:{{#invoke:DemoTemplate|convert|10|C}} -- regular temperature
:{{#invoke:DemoTemplate|convert|10|C-change}} -- difference (e.g., "The temperature changed from 30 into 40 °C")
:{{#invoke:DemoTemplate|convert|10-15|C}} -- range (e.g., "The temperature is between 10 and 15 °C")

Consistently, into multiple units:
:<code><nowiki>A rise of {{convert|10|C-change|F-change K-change}}</nowiki></code> → A rise of {{convert|10|C-change|F-change K-change}}

===Multiple units: ''1 ft 5 in''===
====In input====
Base document {{slink|Module:Convert/documentation/conversion data/doc|Input multiples|nopage=y}} 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):
::*<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 {{slink|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
:*<code><nowiki>{{convert|2|m}}</nowiki></code> → {{convert|2|m}}—the default

;See also
* {{tl|hands}} a length used to measure horses
* {{tl|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:
:* <code><nowiki>{{convert|10|$/mi|$/km}}</nowiki></code> → {{convert|10|$/mi|$/km}}

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

==Parameter list==
{{convert/doc/parameter list}}

==Deprecated options==
{{Convert/doc/deprecations list}}

==TemplateData==
{{TemplateDataHeader}}

<templatedata>{
"description": "Converts measurements to other units.",
"params": {
"1": {
"label": "value",
"description": "the value to convert",
"type": "number"
},
"2": {
"label": "from unit",
"description": "",
"type": "string/line"
},
"3": {
"label": "to units",
"description": "the unit to convert into",
"type": "string/line"
},
"4": {
"label": "precision or suffix",
"description": "significant digits after decimal dot or, if negative, exponent of ten",
"type": "number"
},
"lk": {
"label": "link units",
"description": "“on” all, “in” input, “out” output or “off” no units",
"default": "off",
"type": "string/line"
},
"abbr": {
"label": "abbreviation",
"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",
"default": "out",
"type": "string/line"
},
"sp": {
"label": "spelling",
"description": "“us” display U.S. spelling of unit names",
"type": "string/line"
},
"adj": {
"label": "adjective",
"description": "adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end",
"type": "string/line"
},
"disp": {
"label": "conversion",
"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",
"default": "b",
"type": "string/line"
},
"order": {
"label": "ordering",
"description": "“flip” returns converted value first, input value second.",
"type": "string/line"
},
"sigfig": {
"label": "significant figures",
"description": "number that sets the number of significant figures",
"type": "number"
},
"round": {
"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",
"type": "string/line"
},
"comma": {
"label": "thousands separator",
"description": "Sets or suppresses thousand separator in the numbers. “off” = no separator; “gaps”: use space not comma; “5” and “gaps5”: only add separator when number > 5 positions (10,000 or more)",
"default": "on",
"type": "string/line"
},
"sortable": {
"label": "sort key",
"description": "“on” generates a hidden sort key",
"type": "string/line"
}
}}</templatedata>


==See also==
* {{Temp|Cvt}}
* {{Temp|SI units}}
{{Convert navs}}
<noinclude>
[[Category:Convert by module documentation| ]]
</noinclude><includeonly>
[[Category:Convert templates| ]]
[[Category:Conversion templates]]
[[Category:Numbers as words conversion templates]]
[[Category:Sorting templates]]
</includeonly>

Template:Convert/doc

2016-06-20T19:34:29Z

178.16.7.96: /* Extra words: 4 planted acres */

{{documentation subpage}}
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk| {{formatnum:789000}}+ }}}}
{{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}}
'''Template {{tl|convert}}''' ''calculates'' measurements from one unit (you can enter) to another one, and then ''presents the results''. For example:
:<code><nowiki>{{convert|2|km|mi}}</nowiki></code> → {{convert|2|km|mi}}
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> → {{convert|7|mi|km}}

The available '''units''' are listed [[#Units|below]]. Units are case-sensitive always ({{xt|kW}}, ''not'' {{!xt|KW}} and ''not'' {{!xt|kw}}). Multiple '''formatting''' and calculation options are listed below.

{{hatnote|See [[Help:Convert]] for more complete information}}
{{hatnote|For currency conversion into US dollars, see [[Template:To USD]]}}

==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
By default, the first value shows unit name spelled out, the second the symbol (or abbreviation).
Use {{para|abbr|on/off}} to change this behaviour:
:<code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}
To abbreviate both:
:<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}}
* {{para|abbr|in}} toggles the default behaviour ({{para|abbr|out}}):
:<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{convert|1|lb|kg|abbr=in}}

===Convenience: {{tlf|cvt}} has {{para|abbr|on}} by default===
Template {{tl|cvt}} is similar to {{tlf|convert}}, but has pre-set {{para|abbr|on}}. In {{tlf|cvt}}, all other options are available. So:

:<code><nowiki>{{cvt|1|lb|kg}}</nowiki></code> → {{cvt|1|lb|kg}}
:is equal to:
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{cvt|1|lb|kg|abbr=on}}

==Adjective: ''a 10-mile distance''==
Use {{para|adj|on}} to produce the adjective form. The difference:
:<code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> → {{convert|10|mi|km}} to go. ''(To compare, default)''
:<code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> → A {{convert|10|mi|km|adj=on}} distance. ''(Adjective form)''
This option does not work with {{para|abbr|on}}.

==Rounding: ''100 ft'' is ''30 m'' or ''30.5 m'' or ''30.48 m''?==
By definition, 100 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===
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 figures, whichever is more precise. An exception to this is ''rounding temperatures'' (see [[#Rounding temperatures|below]]).

{| class="wikitable"
|-
! colspan="3" | Examples of rounding
|-
|'''Input'''||'''Displays as'''||'''Note'''
|-
|<code><nowiki>{{convert|123|ft|m|-1}}</nowiki></code> || {{convert|123|ft|m|-1}} ||
|-
|<code><nowiki>{{convert|123|ft|m|0}}</nowiki></code> || {{convert|123|ft|m|0}} ||
|-
|<code><nowiki>{{convert|123|ft|m|1}}</nowiki></code> || {{convert|123|ft|m|1}} ||
|-
|<code><nowiki>{{convert|550|ft|m|0}}</nowiki></code> || {{convert|550|ft|m|0}} || Approximate value is 167.64 m
|-
|<code><nowiki>{{convert|550|ft|m}}</nowiki></code> || {{convert|550|ft|m}} || Rounds to 170, when approximate value is 167.64 m
|-
|<code><nowiki>{{convert|500|ft|m|0}}</nowiki></code> || {{convert|500|ft|m|0}} || Approximate value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|m}}</nowiki></code> || {{convert|500|ft|m}} || Rounds to 150, when approximate value is 152.4 m
|}

''Convert'' supports four types of rounding:

===Round to a given precision: ''use {{para|precision|}}''===
Specify the desired precision with the fourth unnamed parameter (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest 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: ''{{para|sigfig|}}''===
To specify the output number to be with ''n'' significant figures use {{para|sigfig|<number>}}:
* To compare: <code><nowiki>{{convert|1200|ft|m}}</nowiki></code> → {{convert|1200|ft|m}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki></code> → {{convert|1200|ft|m|sigfig=4}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=3}}</nowiki></code> → {{convert|1200|ft|m|sigfig=3}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=2}}</nowiki></code> → {{convert|1200|ft|m|sigfig=2}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki></code> → {{convert|1200|ft|m|sigfig=1}}
Setting {{para|sigfig|<=0}} is meaningless
* <code><nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki></code> → {{convert|1200|ft|m|sigfig=0}}

===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
Using {{para|round|5}} rounds the outcome to a multiple of 5.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<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.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> → {{convert|10|m|ft|round=25}}
:To compare: <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}}:
:<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> → {{convert|10 x 200 x 3000|m|ft|round=each}}

===Round to a multiple of a given fraction: ''{{frac|2|3|16}} inch''===
Specify the desired ''denominator'' using {{para|frac|<some positive integer>}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|3}}).
:<code><nowiki>{{convert|5.56|cm|in|frac=16}}</nowiki></code> → {{convert|5.56|cm|in|frac=16}}
:<code><nowiki>{{convert|8|cm|in|frac=4}}</nowiki></code> → {{convert|8|cm|in|frac=4}}
The fraction is reduced when possible:
:<code><nowiki>{{convert|8|cm|in|frac=100}}</nowiki></code> → {{convert|8|cm|in|frac=100}}
:<code><nowiki>{{convert|8|cm|in}}</nowiki></code> → {{convert|8|cm|in|sigfig=4}} (To compare)

==={{anchor|Rounding temperatures}}In temperatures: rounding ''°C'', ''°F'' and ''K''===
In temperatures, the conversion will be rounded either to precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.

#{{#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|-300|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}}

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 into five significant output digits because of the two numbers 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.

==Into multiple units: ''{{convert|10|C|F K}}''==
Separate the multiple output units by a space:
:<code><nowiki>{{convert|10|C|F K}}</nowiki></code> → {{convert|10|C|F K}}
:<code><nowiki>{{convert|5|km|mi nmi}}</nowiki></code> → {{convert|5|km|mi nmi}}
If the output unit names contain spaces, use a '+' separator.
;See also
For multiple-unit options like ''1 ft 5 in'', see [[#In input]] and [[#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: 
{{Convert/doc/range separator list}}

===Multiple dimensions: ''{{convert|6|x|12|m|ft|abbr=on}}''===
; Use "by":
:<code><nowiki>{{convert|6|by|12|ft|m}}</nowiki></code> → {{convert|6|by|12|ft|m}}
;Use "×" or ""x"":
:<code><nowiki>{{convert|6|x|12|m|ft}}</nowiki></code> → {{convert|6|x|12|m|ft}}

In science, the formal way is to set <code>|x|</code> and {{para|abbr|on}} (keeping dimensions right, like in ''area = x km2''):
:<code><nowiki>{{convert|6|x|12|m|ft|abbr=on}}</nowiki></code> → {{convert|6|x|12|m|ft|abbr=on}}

===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:
* <code><nowiki>{{convert|1|ft|3|in|mm}}</nowiki></code> → {{convert|1|ft|3|in|mm}} (to compare)
* <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}}

==Words==
===Spelling of unit name: UK ''metre'' or US ''meter''?===
Default spelling of units is en-UK. 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}}

===Spell out numbers: ''ten miles''===
To write a number in words, use {{para|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}}:
:<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}}
:<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> → {{convert|10|mi|m|spell=On}}

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> → {{convert|10|mi|m|spell=on|abbr=off|sp=us}}
===Extra words: ''4 planted acres''===
:''Incomplete section''
*<code><nowiki>{{convert|4|acre||adj=pre|planted}}</nowiki></code> → {{convert|4|acre||adj=pre|planted}}
*<code><nowiki>{{convert|4|acre||disp=preunit|planted }}</nowiki></code> → {{convert|4|acre||disp=preunit|planted }}

===Extra adjective words: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
:<code><nowiki>{{convert|10|ft|m|adj=mid|-long}}</nowiki></code> → {{convert|10|ft|m|adj=mid|-long}}

===Plurals: ''1 inch, 2 inches''===
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}}

;Exception:
Entering the unit spelled <code>|foot|</code> forces singular output "foot", whatever the number is.
* <code><nowiki>{{convert|100|foot|abbr=off}}</nowiki></code> → {{convert|100|foot|abbr=off}}

==Numbers==

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

To illustrate, these are trivial calculations (from meter to meter), showing the multiplication factor:
* {{convert|12|Gm|m|abbr=on}}
* {{convert|12|μm|m|abbr=on}}

The prefix can be added before the SI unit (here: unit <code>m</code> for meter):
* <code><nowiki>{{convert|12|Gm|mi|abbr=on}}</nowiki></code> → {{convert|12|Gm|mi|abbr=on}}
* <code>Mm</code>: {{convert|12|Mm|mi|abbr=on}}
* <code>km</code>: {{convert|12|km|ft|abbr=on}}
* <code>mm</code>: {{convert|12|mm|in|abbr=on}}
* <code>μm</code>: {{convert|12|μm|mm|abbr=on}}
* <code>um</code>: {{convert|12|um|mm|abbr=on}} (letter "u" can be used for "μ" here)

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

As an exception, the non-SI unit "inch" can have the "μ" prefix too)
* <code><nowiki>{{convert|12|μm|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}

:{{further|Help:Convert units#SI prefixes}}

===Engineering notation: ''7 × 106 m''===

====In the unit: ''e6m''====
[[Engineering notation|Engineering number notations]] like ''7{{smallcaps|E}}6'' (for 7 × 106) can be entered as a "prefix" to the unit:
:<code><nowiki>{{convert|7|e6m}}</nowiki></code> → {{convert|7|e6m}}
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−14''===
In [[scientific notation]], a number is written like {{rnd|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}}

===Input with fractions: ''{{convert|1+1/2|in|mm|1}}''===
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}}

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 (do not require a calculation)

===Output with horizontal fraction bar in: ''{{sfrac|1|2}} inch''===

Using a double slash (<code>//</code>) returns a horizontal bar fraction:
* <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}}

===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}}
*<code><nowiki>{{convert|1 234 567|m|ft}}</nowiki></code> → {{convert|1 234 567|m|ft}} {{nay}}

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}}</nowiki></code> → {{convert|1234567|m|ft}} (To compare, default)
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps}}

Setting {{para|comma|5}} or {{para|comma|gaps5}} will only add the separator when the number of digits is 5 or more:
*<code><nowiki>{{convert|1234|m|ft}}</nowiki></code> → {{convert|1234|m|ft}} (To compare, default)
*<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}}
*<code><nowiki>{{convert|1234|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234|m|ft|comma=gaps5}}
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps5}}

==Output manipulation==
===Brackets and separators: ''10 m [33 ft]''===
Punctuation that distinguishes the two measurements is set by {{para|disp|}}. 
Options are: <code>b</code> (the default), <code>sqbr</code>, <code>comma</code>, <code>or</code>, <code>br</code>, <code>x{{!}}≈...</code>:
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}—''( ) 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=comma}}</nowiki></code> → {{convert|10|m|ft|disp=comma}}
:<code><nowiki>{{convert|10|m|ft|disp=or}}</nowiki></code> → {{convert|10|m|ft|disp=or}}

Setting {{para|disp|br}} will force a new line (<code> </code>)
:<code><nowiki>{{convert|10|m|ft|disp=br}}</nowiki></code> → {{convert|10|m|ft|disp=br}}
Also {{para|disp|br()}} will force a new line, and keep the brackets:
:<code><nowiki>{{convert|10|m|ft|disp=br()}}</nowiki></code> → {{convert|10|m|ft|disp=br()}}

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_}}—(To display spaces, use <code>&nbsp;</code>)

===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:
:<code><nowiki>{{convert|1|mi|m}}</nowiki></code> → {{convert|1|mi|m|sigfig=5|abbr=off}} (To compare, default)
:<code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> → {{convert|1|mi|m|order=flip|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}}

=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
It is possible to display only parts of the conversion result:


{| class="wikitable"
! Convert !! Output !! Description
|-
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}}
| Default, to compare
|-
| <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|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|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|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=out}}</nowiki></code> || {{convert|2|cuyd|m3|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
|}
===Display both input name and symbol: ''2 kilopascals [kPa]''===
Setting {{para|abbr|~}} returns both name and symbol of the first (input) unit:
:<code><nowiki>{{convert|2|kPa|psi|abbr=~}}</nowiki></code> → {{convert|2|kPa|psi|abbr=~}}
:<code><nowiki>A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure</nowiki></code> → {{nowrap|A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure}}

==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 showing numbers only===
Using {convert} in a table cell, with {{para|disp|table}} splits the result over two columns:
:<code><nowiki>{{convert|10|m|ft|disp=table}}</nowiki></code> → {{convert|10|m|ft|disp=table}}

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

The units are added as a column header:
:{| class=wikitable
! style="width:10em;" |  
! style="width:10em;" | m
! style="width:10em;" | ft
|-
| {{para|disp|table}}
| {{convert|10|m|ft|disp=table}}
|-
|{{para|disp|tablecen}}
| {{convert|20|m|ft|disp=tablecen}}
|-
|{{para|disp|<other>}} (default)
|{{convert|30|m|ft|disp=}}
|}

===Sorting===
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=700110000000000000010 metres (33&nbsp;ft)}}

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

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

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==
===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}}}}
<div style="height: 400px; overflow: auto; padding: 3px; border: 1px solid #aaa;">
{{Convert/list of units}}
</div>

==='per' units: ''kg/hl''===
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}}

===Units of difference===
When a number is the measurement for a ''difference'', one conversion is done. This may occur in temperatures (°C, °F, K). Compare this to a ''range'', when two conversions are done.

The only available units of difference are: {{para|C-change}}, {{para|F-change}} and {{para| K-change}}.

:{{#invoke:DemoTemplate|convert|10|C}} -- regular temperature
:{{#invoke:DemoTemplate|convert|10|C-change}} -- difference (e.g., "The temperature changed from 30 into 40 °C")
:{{#invoke:DemoTemplate|convert|10-15|C}} -- range (e.g., "The temperature is between 10 and 15 °C")

Consistently, into multiple units:
:<code><nowiki>A rise of {{convert|10|C-change|F-change K-change}}</nowiki></code> → A rise of {{convert|10|C-change|F-change K-change}}

===Multiple units: ''1 ft 5 in''===
====In input====
Base document {{slink|Module:Convert/documentation/conversion data/doc|Input multiples|nopage=y}} 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):
::*<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 {{slink|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
:*<code><nowiki>{{convert|2|m}}</nowiki></code> → {{convert|2|m}}—the default

;See also
* {{tl|hands}} a length used to measure horses
* {{tl|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:
:* <code><nowiki>{{convert|10|$/mi|$/km}}</nowiki></code> → {{convert|10|$/mi|$/km}}

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

==Parameter list==
{{convert/doc/parameter list}}

==Deprecated options==
{{Convert/doc/deprecations list}}

==TemplateData==
{{TemplateDataHeader}}

<templatedata>{
"description": "Converts measurements to other units.",
"params": {
"1": {
"label": "value",
"description": "the value to convert",
"type": "number"
},
"2": {
"label": "from unit",
"description": "",
"type": "string/line"
},
"3": {
"label": "to units",
"description": "the unit to convert into",
"type": "string/line"
},
"4": {
"label": "precision or suffix",
"description": "significant digits after decimal dot or, if negative, exponent of ten",
"type": "number"
},
"lk": {
"label": "link units",
"description": "“on” all, “in” input, “out” output or “off” no units",
"default": "off",
"type": "string/line"
},
"abbr": {
"label": "abbreviation",
"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",
"default": "out",
"type": "string/line"
},
"sp": {
"label": "spelling",
"description": "“us” display U.S. spelling of unit names",
"type": "string/line"
},
"adj": {
"label": "adjective",
"description": "adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end",
"type": "string/line"
},
"disp": {
"label": "conversion",
"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",
"default": "b",
"type": "string/line"
},
"order": {
"label": "ordering",
"description": "“flip” returns converted value first, input value second.",
"type": "string/line"
},
"sigfig": {
"label": "significant figures",
"description": "number that sets the number of significant figures",
"type": "number"
},
"round": {
"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",
"type": "string/line"
},
"comma": {
"label": "thousands separator",
"description": "Sets or suppresses thousand separator in the numbers. “off” = no separator; “gaps”: use space not comma; “5” and “gaps5”: only add separator when number > 5 positions (10,000 or more)",
"default": "on",
"type": "string/line"
},
"sortable": {
"label": "sort key",
"description": "“on” generates a hidden sort key",
"type": "string/line"
}
}}</templatedata>


==See also==
* {{Temp|Cvt}}
* {{Temp|SI units}}
{{Convert navs}}
<noinclude>
[[Category:Convert by module documentation| ]]
</noinclude><includeonly>
[[Category:Convert templates| ]]
[[Category:Conversion templates]]
[[Category:Numbers as words conversion templates]]
[[Category:Sorting templates]]
</includeonly>

Template:Convert/doc/parameter list

2016-06-20T19:29:41Z

178.16.7.96:

{| class="wikitable sortable collapsible {{{state|uncollapsed}}}" style="width:100%;"
! colspan=4 style="background:#eee" | {{navbar-collapsible|'''Parameter options for <nowiki>{{convert}}</nowiki>'''|Convert/doc/parameter list}}
|-
! Parameter
! {{abbr|1=Value|2=Sort by value of parameter}}
! Description
! Note
|-
|<code>|abbr=in</code> || {{hidden sort key|in}}
| Use symbol for first (left-hand side) unit
| Symbol ('abbreviation')
|-
|<code>|abbr=off</code> || {{hidden sort key|off}}
| rowspan=2 | Use name for all units
| rowspan=2 | Symbol ('abbreviation')
|-
|<code>|abbr=none</code> || {{hidden sort key|none}}
|-
|<code>|abbr=on</code> || {{hidden sort key|on}}
| Use symbol for all units
| Symbol ('abbreviation')
|-
|<code>|abbr=out</code> || {{hidden sort key|out}}
| Use symbol for right-hand side unit (default)
| Symbol ('abbreviation')
|-
|<code>|abbr=values</code> || {{hidden sort key|values}}
| Show only input and output numbers, not units
| Parts only
|-
|<code>|abbr=~</code> || {{hidden sort key|~}}
| Shows both unit name and symbol
| Symbol & name
|-
|<code>|adj=j</code> || {{hidden sort key|j}}
| Join number and unit name using "&nbsp;" instead of a space
| Join values
|-
|<code>|adj=mid|x=...</code> || {{hidden sort key|mid}}
| User-specified text after the input unit; sets <code>adj=on</code> (adjective)
| Word adding, adjective
|-
|<code>|adj=on</code> || {{hidden sort key|on}}
| Unit name is adjective (singular and hyphenated)
| Grammar, adjective
|-
|<code>|adj=pre|x=...</code> || {{hidden sort key|pre}}
| User-specified text before input unit
| Word adding
|-
|<code>|adj=ri0</code> || {{hidden sort key|ri0}}
| Round input with precision 0
| Rounding and significant figures
|-
|<code>|adj=ri1</code> || {{hidden sort key|ri1}}
| Round input with precision 1
| Rounding and significant figures
|-
|<code>|adj=ri2</code> || {{hidden sort key|ri2}}
| Round input with precision 2
| Rounding and significant figures
|-
|<code>|adj=ri3</code> || {{hidden sort key|ri3}}
| Round input with precision 3
| Rounding and significant figures
|-
|<code>|disp=b</code> || {{hidden sort key|b}}
| Join input and output using " (...)" (default)
| Join values
|-
|<code>|disp=sqbr</code> || {{hidden sort key|sqbr}}
| Join input and output using " [...]"
| Join values
|-
|<code>|disp=br</code> || {{hidden sort key|br}}
| Join input and output using " "
| Join values
|-
|<code>|disp=comma</code> || {{hidden sort key|comma}}
| Join input and output using ", "
| Join values
|-
|<code>|disp=or</code> || {{hidden sort key|or}}
| Join input and output using " or "
| Join values
|-
|<code>|disp=number</code> || {{hidden sort key|number}}
| rowspan=2 | Display output number only
| rowspan=2 | Parts only
|-
|<code>|disp=output number only</code> || {{hidden sort key|output number only}}
|-
|<code>|disp=out</code> || {{hidden sort key|out}}
| rowspan=2 | Display only output number and name/symbol
| rowspan=2 | Parts only
|-
|<code>|disp=output only</code> || {{hidden sort key|output only}}
|-
|<code>|disp=preunit|…[|…]</code> || {{hidden sort key|preunit}}
| Text to be inserted after value and before units, for both input and output, with optionally different text for output.
| Word adding
|-
|<code>|disp=table</code> || {{hidden sort key|table}}
| Output is suitable for a table cell with align="right"
| Table columns
|-
|<code>|disp=tablecen</code> || {{hidden sort key|tablecen}}
| Output is suitable for a table cell with align="center"
| Table columns
|-
|<code>|disp=unit</code> || {{hidden sort key|unit}}
| Display input name/symbol only (not input number, not output)
| Parts only
|-
|<code>|disp=unit2</code> || {{hidden sort key|unit2}}
| Display output name/symbol only (not input; not output number)
| Parts only
|-
|<code>|disp=x|...</code> || {{hidden sort key|x}}
| Join input and output using user-specified text
| Word adding
|-
|<code>|comma=5</code> || {{hidden sort key|05}}
| Only use comma for thousands separator if 5 or more digits
| Number format
|-
|<code>|comma=gaps</code> || {{hidden sort key|gaps}}
| Use gaps (space), not comma, for thousands separator
| Number format
|-
|<code>|comma=gaps5</code> || {{hidden sort key|gaps5}}
| Use gaps (space), but only if 5 or more digits
| Number format
|-
|<code>|comma=off</code> || {{hidden sort key|off}}
| No thousands separator
| Number format
|-
|<code>|frac=''N''</code> || {{hidden sort key|N}}
| Show imperial number in fractions, denominator=''N''
| Number format, fraction
|-
|<code>|lk=in</code> || {{hidden sort key|in}}
| Link left-hand side unit name or symbol
| Unit link
|-
|<code>|lk=on</code> || {{hidden sort key|on}}
| Link all unit names or symbols (but not twice for the same unit)
| Unit link
|-
|<code>|lk=out</code> || {{hidden sort key|out}}
| Link right-hand side unit name or symbol
| Unit link
|-
|<code>|order=flip</code> || {{hidden sort key|flip}}
| Inverts order of input, output measurements (conversion first)
| Order
|-
|<code>|round=5</code> || {{hidden sort key|05}}
| Rounds calculation to the nearest multiple of 5
| Rounding and significant figures
|-
|<code>|round=25</code> || {{hidden sort key|25}}
| Rounds calculation to the nearest multiple of 25
| Rounding and significant figures
|-
|<code>|round=each</code> || {{hidden sort key|each}}
| In a range, each number is rounded by the default rounding
| Rounding and significant figures
|-
|<code>|sigfig=''N''</code> || {{hidden sort key|N}}
| Round output number to ''N'' significant figures (''N'' is a positive integer)
| Rounding and significant figures
|-
|<code>|sortable=in</code> || {{hidden sort key|in}}
| rowspan=2 | Output numeric hidden sort field for use in a sortable table (based on input)
| rowspan=2 | Table sort
|-
|<code>|sortable=on</code> || {{hidden sort key|on}}
|-
|<code>|sortable=out</code> || {{hidden sort key|out}}
| Output numeric hidden sort field for use in a sortable table (based on output)
| Table sort
|-
|<code>|sp=us</code> || {{hidden sort key|us}}
| Use U.S. spelling (like "meter" instead of default "metre")
| Spelling U.S. names
|-
|<code>|spell=in</code> || {{hidden sort key|in}}
| Spell input number in words
| Spelling numbers
|-
|<code>|spell=In</code> || {{hidden sort key|In}}
| Spell input number in words with first letter uppercase
| Spelling numbers
|-
|<code>|spell=on</code> || {{hidden sort key|on}}
| Spell input and output numbers in words
| Spelling numbers
|-
|<code>|spell=On</code> || {{hidden sort key|On}}
| Spell input and output numbers in words with first letter uppercase
| Spelling numbers
|-
|<code>|$=''€''</code> || {{hidden sort key|$}}
| Replace $-sign with a currency sign, for example in <code>$/acre</code> {{nowrap|(no currency conversion happens)}}
| Cost per unit
|-
|<code>|debug=yes</code> || {{hidden sort key|yes}}
| '''Debugging only'''. In a sortable table: show the normally hidden sort key
| Table sort
|- 
|<code>{{!xt|1=|abbr=comma}}</code> || {{hidden sort key|comma}}
| '''Deprecated'''. Use {{xt|1=|comma=off}}
| Number format
|-
|<code>{{!xt|1=|abbr=mos}}</code> || {{hidden sort key|mos}}
| '''Deprecated'''. Use {{xt|1=|x|}} ''or'' {{xt|1=|by|}}
| Range format
|-
|<code>{{!xt|1=|adj=1}}</code> || {{hidden sort key|01}}
| '''Deprecated'''. Do not use. No need to deviate from [[MOS:FRACTION|MOS]] regarding plurals
| Plural or singular
|-
|<code>{{!xt|1=|adj=flip}}</code> || {{hidden sort key|flip}}
| '''Deprecated'''. Use {{xt|1=|order=flip}}
| Order
|-
| <code>{{!xt|1=|adj=nocomma}}</code> || {{hidden sort key|nocomma}}
| '''Deprecated'''. Use {{xt|1=|comma=off}}
| Number format
|-
|<code>{{!xt|1=|disp=2}}</code> || {{hidden sort key|02}}
| '''Deprecated'''. Use {{xt|1=|disp=output only}}
| Parts only
|-
|<code>{{!xt|1=|disp=5}}</code> || {{hidden sort key|05}}
| '''Deprecated'''. Use {{xt|1=|round=5}}
| Rounding and significant figures
|-
|<code>{{!xt|1=|disp=flip}}</code> || {{hidden sort key|flip}}
| '''Deprecated'''. Use {{xt|1=|order=flip}}
| Order
|-
|<code>{{!xt|1=|disp=flip5}}</code> || {{hidden sort key|flip5}}
| '''Deprecated'''. Use {{xt|1=|order=flip |round=5}}
| Order, rounding
|-
| <code>{{!xt|1=|disp=nocomma}}</code> || {{hidden sort key|nocomma}}
| '''Deprecated'''. Use {{xt|1=|comma=off}}
| Number format
|-
|<code>{{!xt|1=|disp=u2}}</code> || {{hidden sort key|u2}}
| '''Deprecated'''. Use {{xt|1=|disp=unit2}}
| Parts only
|-
|<code>{{!xt|1=|near=5}}</code> || {{hidden sort key|05}}
| '''Deprecated'''. Use {{xt|1=|round=5}}
| Rounding and significant figures
|}<noinclude>
{{documentation}}
</noinclude>

Template:Convert/doc/parameter list

2016-06-20T19:26:17Z

178.16.7.96:

{| class="wikitable sortable collapsible {{{state|uncollapsed}}}" style="width:100%;"
! colspan=4 style="background:#eee" | {{navbar-collapsible|'''Parameter options for <nowiki>{{convert}}</nowiki>'''|Convert/doc/parameter list}}
|-
! Option
! {{abbr|1==..|2=Sort by value of the option}}
! Description
! Note
|-
|<code>|abbr=in</code> || {{hidden sort key|in}}
| Use symbol for first (left-hand side) unit
| Symbol ('abbreviation')
|-
|<code>|abbr=off</code> || {{hidden sort key|off}}
| rowspan=2 | Use name for all units
| rowspan=2 | Symbol ('abbreviation')
|-
|<code>|abbr=none</code> || {{hidden sort key|none}}
|-
|<code>|abbr=on</code> || {{hidden sort key|on}}
| Use symbol for all units
| Symbol ('abbreviation')
|-
|<code>|abbr=out</code> || {{hidden sort key|out}}
| Use symbol for right-hand side unit (default)
| Symbol ('abbreviation')
|-
|<code>|abbr=values</code> || {{hidden sort key|values}}
| Show only input and output numbers, not units
| Parts only
|-
|<code>|abbr=~</code> || {{hidden sort key|~}}
| Shows both unit name and symbol
| Symbol & name
|-
|<code>|adj=j</code> || {{hidden sort key|j}}
| Join number and unit name using "&nbsp;" instead of a space
| Join values
|-
|<code>|adj=mid|x=...</code> || {{hidden sort key|mid}}
| User-specified text after the input unit; sets <code>adj=on</code> (adjective)
| Word adding, adjective
|-
|<code>|adj=on</code> || {{hidden sort key|on}}
| Unit name is adjective (singular and hyphenated)
| Grammar, adjective
|-
|<code>|adj=pre|x=...</code> || {{hidden sort key|pre}}
| User-specified text before input unit
| Word adding
|-
|<code>|adj=ri0</code> || {{hidden sort key|ri0}}
| Round input with precision 0
| Rounding and significant figures
|-
|<code>|adj=ri1</code> || {{hidden sort key|ri1}}
| Round input with precision 1
| Rounding and significant figures
|-
|<code>|adj=ri2</code> || {{hidden sort key|ri2}}
| Round input with precision 2
| Rounding and significant figures
|-
|<code>|adj=ri3</code> || {{hidden sort key|ri3}}
| Round input with precision 3
| Rounding and significant figures
|-
|<code>|disp=b</code> || {{hidden sort key|b}}
| Join input and output using " (...)" (default)
| Join values
|-
|<code>|disp=sqbr</code> || {{hidden sort key|sqbr}}
| Join input and output using " [...]"
| Join values
|-
|<code>|disp=br</code> || {{hidden sort key|br}}
| Join input and output using " "
| Join values
|-
|<code>|disp=comma</code> || {{hidden sort key|comma}}
| Join input and output using ", "
| Join values
|-
|<code>|disp=or</code> || {{hidden sort key|or}}
| Join input and output using " or "
| Join values
|-
|<code>|disp=number</code> || {{hidden sort key|number}}
| rowspan=2 | Display output number only
| rowspan=2 | Parts only
|-
|<code>|disp=output number only</code> || {{hidden sort key|output number only}}
|-
|<code>|disp=out</code> || {{hidden sort key|out}}
| rowspan=2 | Display only output number and name/symbol
| rowspan=2 | Parts only
|-
|<code>|disp=output only</code> || {{hidden sort key|output only}}
|-
|<code>|disp=preunit|…[|…]</code> || {{hidden sort key|preunit}}
| Text to be inserted after value and before units, for both input and output, with optionally different text for output.
| Word adding
|-
|<code>|disp=table</code> || {{hidden sort key|table}}
| Output is suitable for a table cell with align="right"
| Table columns
|-
|<code>|disp=tablecen</code> || {{hidden sort key|tablecen}}
| Output is suitable for a table cell with align="center"
| Table columns
|-
|<code>|disp=unit</code> || {{hidden sort key|unit}}
| Display input name/symbol only (not input number, not output)
| Parts only
|-
|<code>|disp=unit2</code> || {{hidden sort key|unit2}}
| Display output name/symbol only (not input; not output number)
| Parts only
|-
|<code>|disp=x|...</code> || {{hidden sort key|x}}
| Join input and output using user-specified text
| Word adding
|-
|<code>|comma=5</code> || {{hidden sort key|05}}
| Only use comma for thousands separator if 5 or more digits
| Number format
|-
|<code>|comma=gaps</code> || {{hidden sort key|gaps}}
| Use gaps (space), not comma, for thousands separator
| Number format
|-
|<code>|comma=gaps5</code> || {{hidden sort key|gaps5}}
| Use gaps (space), but only if 5 or more digits
| Number format
|-
|<code>|comma=off</code> || {{hidden sort key|off}}
| No thousands separator
| Number format
|-
|<code>|frac=''N''</code> || {{hidden sort key|N}}
| Show imperial number in fractions, denominator=''N''
| Number format, fraction
|-
|<code>|lk=in</code> || {{hidden sort key|in}}
| Link left-hand side unit name or symbol
| Unit link
|-
|<code>|lk=on</code> || {{hidden sort key|on}}
| Link all unit names or symbols (but not twice for the same unit)
| Unit link
|-
|<code>|lk=out</code> || {{hidden sort key|out}}
| Link right-hand side unit name or symbol
| Unit link
|-
|<code>|order=flip</code> || {{hidden sort key|flip}}
| Inverts order of input, output measurements (conversion first)
| Order
|-
|<code>|round=5</code> || {{hidden sort key|05}}
| Rounds calculation to the nearest multiple of 5
| Rounding and significant figures
|-
|<code>|round=25</code> || {{hidden sort key|25}}
| Rounds calculation to the nearest multiple of 25
| Rounding and significant figures
|-
|<code>|round=each</code> || {{hidden sort key|each}}
| In a range, each number is rounded by the default rounding
| Rounding and significant figures
|-
|<code>|sigfig=''N''</code> || {{hidden sort key|N}}
| Round output number to ''N'' significant figures (''N'' is a positive integer)
| Rounding and significant figures
|-
|<code>|sortable=in</code> || {{hidden sort key|in}}
| rowspan=2 | Output numeric hidden sort field for use in a sortable table (based on input)
| rowspan=2 | Table sort
|-
|<code>|sortable=on</code> || {{hidden sort key|on}}
|-
|<code>|sortable=out</code> || {{hidden sort key|out}}
| Output numeric hidden sort field for use in a sortable table (based on output)
| Table sort
|-
|<code>|sp=us</code> || {{hidden sort key|us}}
| Use U.S. spelling (like "meter" instead of default "metre")
| Spelling U.S. names
|-
|<code>|spell=in</code> || {{hidden sort key|in}}
| Spell input number in words
| Spelling numbers
|-
|<code>|spell=In</code> || {{hidden sort key|In}}
| Spell input number in words with first letter uppercase
| Spelling numbers
|-
|<code>|spell=on</code> || {{hidden sort key|on}}
| Spell input and output numbers in words
| Spelling numbers
|-
|<code>|spell=On</code> || {{hidden sort key|On}}
| Spell input and output numbers in words with first letter uppercase
| Spelling numbers
|-
|<code>|$=''€''</code> || {{hidden sort key|$}}
| Replace $-sign with a currency sign, for example in <code>$/acre</code> {{nowrap|(no currency conversion happens)}}
| Cost per unit
|-
|<code>|debug=yes</code> || {{hidden sort key|yes}}
| '''Debugging only'''. In a sortable table: show the normally hidden sort key
| Table sort
|- 
|<code>{{!xt|1=|abbr=comma}}</code> || {{hidden sort key|comma}}
| '''Deprecated'''. Use {{xt|1=|comma=off}}
| Number format
|-
|<code>{{!xt|1=|abbr=mos}}</code> || {{hidden sort key|mos}}
| '''Deprecated'''. Use {{xt|1=|x|}} ''or'' {{xt|1=|by|}}
| Range format
|-
|<code>{{!xt|1=|adj=1}}</code> || {{hidden sort key|01}}
| '''Deprecated'''. Do not use. No need to deviate from [[MOS:FRACTION|MOS]] regarding plurals
| Plural or singular
|-
|<code>{{!xt|1=|adj=flip}}</code> || {{hidden sort key|flip}}
| '''Deprecated'''. Use {{xt|1=|order=flip}}
| Order
|-
| <code>{{!xt|1=|adj=nocomma}}</code> || {{hidden sort key|nocomma}}
| '''Deprecated'''. Use {{xt|1=|comma=off}}
| Number format
|-
|<code>{{!xt|1=|disp=2}}</code> || {{hidden sort key|02}}
| '''Deprecated'''. Use {{xt|1=|disp=output only}}
| Parts only
|-
|<code>{{!xt|1=|disp=5}}</code> || {{hidden sort key|05}}
| '''Deprecated'''. Use {{xt|1=|round=5}}
| Rounding and significant figures
|-
|<code>{{!xt|1=|disp=flip}}</code> || {{hidden sort key|flip}}
| '''Deprecated'''. Use {{xt|1=|order=flip}}
| Order
|-
|<code>{{!xt|1=|disp=flip5}}</code> || {{hidden sort key|flip5}}
| '''Deprecated'''. Use {{xt|1=|order=flip |round=5}}
| Order, rounding
|-
| <code>{{!xt|1=|disp=nocomma}}</code> || {{hidden sort key|nocomma}}
| '''Deprecated'''. Use {{xt|1=|comma=off}}
| Number format
|-
|<code>{{!xt|1=|disp=u2}}</code> || {{hidden sort key|u2}}
| '''Deprecated'''. Use {{xt|1=|disp=unit2}}
| Parts only
|-
|<code>{{!xt|1=|near=5}}</code> || {{hidden sort key|05}}
| '''Deprecated'''. Use {{xt|1=|round=5}}
| Rounding and significant figures
|}<noinclude>
{{documentation}}
</noinclude>

Template:Convert/doc/parameter list

2016-06-20T19:25:44Z

178.16.7.96:

{| class="wikitable sortable collapsible {{{state|uncollapsed}}}" style="width:100%;"
! colspan=4 style="background:#eee" | {{navbar-collapsible|'''Parameter options for <nowiki>{{convert}}</nowiki>'''|Convert/doc/parameter list}}
|-
! Option
! {{abbr|1==..|2=Sort by value of the option}}
! Description
! Note
|-
|<code>|abbr=in</code> || {{hidden sort key|in}}
| Use symbol for first (left-hand side) unit
| Symbol ('abbreviation')
|-
|<code>|abbr=off</code> || {{hidden sort key|off}}
| rowspan=2 | Use name for all units
| rowspan=2 | Symbol ('abbreviation')
|-
|<code>|abbr=none</code> || {{hidden sort key|none}}
|-
|<code>|abbr=on</code> || {{hidden sort key|on}}
| Use symbol for all units
| Symbol ('abbreviation')
|-
|<code>|abbr=out</code> || {{hidden sort key|out}}
| Use symbol for right-hand side unit (default)
| Symbol ('abbreviation')
|-
|<code>|abbr=values</code> || {{hidden sort key|values}}
| Show only input and output numbers, not units
| Parts only
|-
|<code>|abbr=~</code> || {{hidden sort key|~}}
| Shows both unit name and symbol
| Symbol & name
|-
|<code>|adj=j</code> || {{hidden sort key|j}}
| Join number and unit name using "&nbsp;" instead of a space
| Join values
|-
|<code>|adj=mid|x=...</code> || {{hidden sort key|mid}}
| User-specified text after the input unit; sets <code>adj=on</code> (adjective)
| Word adding, adjective
|-
|<code>|adj=on</code> || {{hidden sort key|on}}
| Unit name is adjective (singular and hyphenated)
| Grammar, adjective
|-
|<code>|adj=pre|x=...</code> || {{hidden sort key|pre}}
| User-specified text before input unit
| Word adding
|-
|<code>|adj=ri0</code> || {{hidden sort key|ri0}}
| Round input with precision 0
| Rounding and sigfig
|-
|<code>|adj=ri1</code> || {{hidden sort key|ri1}}
| Round input with precision 1
| Rounding and sigfig
|-
|<code>|adj=ri2</code> || {{hidden sort key|ri2}}
| Round input with precision 2
| Rounding and sigfig
|-
|<code>|adj=ri3</code> || {{hidden sort key|ri3}}
| Round input with precision 3
| Rounding and sigfig
|-
|<code>|disp=b</code> || {{hidden sort key|b}}
| Join input and output using " (...)" (default)
| Join values
|-
|<code>|disp=sqbr</code> || {{hidden sort key|sqbr}}
| Join input and output using " [...]"
| Join values
|-
|<code>|disp=br</code> || {{hidden sort key|br}}
| Join input and output using " "
| Join values
|-
|<code>|disp=comma</code> || {{hidden sort key|comma}}
| Join input and output using ", "
| Join values
|-
|<code>|disp=or</code> || {{hidden sort key|or}}
| Join input and output using " or "
| Join values
|-
|<code>|disp=number</code> || {{hidden sort key|number}}
| rowspan=2 | Display output number only
| rowspan=2 | Parts only
|-
|<code>|disp=output number only</code> || {{hidden sort key|output number only}}
|-
|<code>|disp=out</code> || {{hidden sort key|out}}
| rowspan=2 | Display only output number and name/symbol
| rowspan=2 | Parts only
|-
|<code>|disp=output only</code> || {{hidden sort key|output only}}
|-
|<code>|disp=preunit|…[|…]</code> || {{hidden sort key|preunit}}
| Text to be inserted after value and before units, for both input and output, with optionally different text for output.
| Word adding
|-
|<code>|disp=table</code> || {{hidden sort key|table}}
| Output is suitable for a table cell with align="right"
| Table columns
|-
|<code>|disp=tablecen</code> || {{hidden sort key|tablecen}}
| Output is suitable for a table cell with align="center"
| Table columns
|-
|<code>|disp=unit</code> || {{hidden sort key|unit}}
| Display input name/symbol only (not input number, not output)
| Parts only
|-
|<code>|disp=unit2</code> || {{hidden sort key|unit2}}
| Display output name/symbol only (not input; not output number)
| Parts only
|-
|<code>|disp=x|...</code> || {{hidden sort key|x}}
| Join input and output using user-specified text
| Word adding
|-
|<code>|comma=5</code> || {{hidden sort key|05}}
| Only use comma for thousands separator if 5 or more digits
| Number format
|-
|<code>|comma=gaps</code> || {{hidden sort key|gaps}}
| Use gaps (space), not comma, for thousands separator
| Number format
|-
|<code>|comma=gaps5</code> || {{hidden sort key|gaps5}}
| Use gaps (space), but only if 5 or more digits
| Number format
|-
|<code>|comma=off</code> || {{hidden sort key|off}}
| No thousands separator
| Number format
|-
|<code>|frac=''N''</code> || {{hidden sort key|N}}
| Show imperial number in fractions, denominator=''N''
| Number format, fraction
|-
|<code>|lk=in</code> || {{hidden sort key|in}}
| Link left-hand side unit name or symbol
| Unit link
|-
|<code>|lk=on</code> || {{hidden sort key|on}}
| Link all unit names or symbols (but not twice for the same unit)
| Unit link
|-
|<code>|lk=out</code> || {{hidden sort key|out}}
| Link right-hand side unit name or symbol
| Unit link
|-
|<code>|order=flip</code> || {{hidden sort key|flip}}
| Inverts order of input, output measurements (conversion first)
| Order
|-
|<code>|round=5</code> || {{hidden sort key|05}}
| Rounds calculation to the nearest multiple of 5
| Rounding and sigfig
|-
|<code>|round=25</code> || {{hidden sort key|25}}
| Rounds calculation to the nearest multiple of 25
| Rounding and sigfig
|-
|<code>|round=each</code> || {{hidden sort key|each}}
| In a range, each number is rounded by the default rounding
| Rounding and sigfig
|-
|<code>|sigfig=''N''</code> || {{hidden sort key|N}}
| Round output number to ''N'' significant figures (''N'' is a positive integer)
| Rounding and sigfig
|-
|<code>|sortable=in</code> || {{hidden sort key|in}}
| rowspan=2 | Output numeric hidden sort field for use in a sortable table (based on input)
| rowspan=2 | Table sort
|-
|<code>|sortable=on</code> || {{hidden sort key|on}}
|-
|<code>|sortable=out</code> || {{hidden sort key|out}}
| Output numeric hidden sort field for use in a sortable table (based on output)
| Table sort
|-
|<code>|sp=us</code> || {{hidden sort key|us}}
| Use U.S. spelling (like "meter" instead of default "metre")
| Spelling U.S. names
|-
|<code>|spell=in</code> || {{hidden sort key|in}}
| Spell input number in words
| Spelling numbers
|-
|<code>|spell=In</code> || {{hidden sort key|In}}
| Spell input number in words with first letter uppercase
| Spelling numbers
|-
|<code>|spell=on</code> || {{hidden sort key|on}}
| Spell input and output numbers in words
| Spelling numbers
|-
|<code>|spell=On</code> || {{hidden sort key|On}}
| Spell input and output numbers in words with first letter uppercase
| Spelling numbers
|-
|<code>|$=''€''</code> || {{hidden sort key|$}}
| Replace $-sign with a currency sign, for example in <code>$/acre</code> {{nowrap|(no currency conversion happens)}}
| Cost per unit
|-
|<code>|debug=yes</code> || {{hidden sort key|yes}}
| '''Debugging only'''. In a sortable table: show the normally hidden sort key
| Table sort
|- 
|<code>{{!xt|1=|abbr=comma}}</code> || {{hidden sort key|comma}}
| '''Deprecated'''. Use {{xt|1=|comma=off}}
| Number format
|-
|<code>{{!xt|1=|abbr=mos}}</code> || {{hidden sort key|mos}}
| '''Deprecated'''. Use {{xt|1=|x|}} ''or'' {{xt|1=|by|}}
| Range format
|-
|<code>{{!xt|1=|adj=1}}</code> || {{hidden sort key|01}}
| '''Deprecated'''. Do not use. No need to deviate from [[MOS:FRACTION|MOS]] regarding plurals
| Plural or singular
|-
|<code>{{!xt|1=|adj=flip}}</code> || {{hidden sort key|flip}}
| '''Deprecated'''. Use {{xt|1=|order=flip}}
| Order
|-
| <code>{{!xt|1=|adj=nocomma}}</code> || {{hidden sort key|nocomma}}
| '''Deprecated'''. Use {{xt|1=|comma=off}}
| Number format
|-
|<code>{{!xt|1=|disp=2}}</code> || {{hidden sort key|02}}
| '''Deprecated'''. Use {{xt|1=|disp=output only}}
| Parts only
|-
|<code>{{!xt|1=|disp=5}}</code> || {{hidden sort key|05}}
| '''Deprecated'''. Use {{xt|1=|round=5}}
| Rounding and sigfig
|-
|<code>{{!xt|1=|disp=flip}}</code> || {{hidden sort key|flip}}
| '''Deprecated'''. Use {{xt|1=|order=flip}}
| Order
|-
|<code>{{!xt|1=|disp=flip5}}</code> || {{hidden sort key|flip5}}
| '''Deprecated'''. Use {{xt|1=|order=flip |round=5}}
| Order, rounding
|-
| <code>{{!xt|1=|disp=nocomma}}</code> || {{hidden sort key|nocomma}}
| '''Deprecated'''. Use {{xt|1=|comma=off}}
| Number format
|-
|<code>{{!xt|1=|disp=u2}}</code> || {{hidden sort key|u2}}
| '''Deprecated'''. Use {{xt|1=|disp=unit2}}
| Parts only
|-
|<code>{{!xt|1=|near=5}}</code> || {{hidden sort key|05}}
| '''Deprecated'''. Use {{xt|1=|round=5}}
| Rounding and sigfig
|}<noinclude>
{{documentation}}
</noinclude>

Template:Convert/doc

2016-06-20T04:24:35Z

178.16.7.96: /* Input with fractions: {{convert|1+1/2|in|mm|1}} */

{{documentation subpage}}
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk| {{formatnum:789000}}+ }}}}
{{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}}
'''Template {{tl|convert}}''' ''calculates'' measurements from one unit (you can enter) to another one, and then ''presents the results''. For example:
:<code><nowiki>{{convert|2|km|mi}}</nowiki></code> → {{convert|2|km|mi}}
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> → {{convert|7|mi|km}}

The available '''units''' are listed [[#Units|below]]. Units are case-sensitive always ({{xt|kW}}, ''not'' {{!xt|KW}} and ''not'' {{!xt|kw}}). Multiple '''formatting''' and calculation options are listed below.

{{hatnote|See [[Help:Convert]] for more complete information}}
{{hatnote|For currency conversion into US dollars, see [[Template:To USD]]}}

==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
By default, the first value shows unit name spelled out, the second the symbol (or abbreviation).
Use {{para|abbr|on/off}} to change this behaviour:
:<code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}
To abbreviate both:
:<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}}
* {{para|abbr|in}} toggles the default behaviour ({{para|abbr|out}}):
:<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{convert|1|lb|kg|abbr=in}}

===Convenience: {{tlf|cvt}} has {{para|abbr|on}} by default===
Template {{tl|cvt}} is similar to {{tlf|convert}}, but has pre-set {{para|abbr|on}}. In {{tlf|cvt}}, all other options are available. So:

:<code><nowiki>{{cvt|1|lb|kg}}</nowiki></code> → {{cvt|1|lb|kg}}
:is equal to:
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{cvt|1|lb|kg|abbr=on}}

==Adjective: ''a 10-mile distance''==
Use {{para|adj|on}} to produce the adjective form. The difference:
:<code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> → {{convert|10|mi|km}} to go. ''(To compare, default)''
:<code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> → A {{convert|10|mi|km|adj=on}} distance. ''(Adjective form)''
This option does not work with {{para|abbr|on}}.

==Rounding: ''100 ft'' is ''30 m'' or ''30.5 m'' or ''30.48 m''?==
By definition, 100 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===
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 figures, whichever is more precise. An exception to this is ''rounding temperatures'' (see [[#Rounding temperatures|below]]).

{| class="wikitable"
|-
! colspan="3" | Examples of rounding
|-
|'''Input'''||'''Displays as'''||'''Note'''
|-
|<code><nowiki>{{convert|123|ft|m|-1}}</nowiki></code> || {{convert|123|ft|m|-1}} ||
|-
|<code><nowiki>{{convert|123|ft|m|0}}</nowiki></code> || {{convert|123|ft|m|0}} ||
|-
|<code><nowiki>{{convert|123|ft|m|1}}</nowiki></code> || {{convert|123|ft|m|1}} ||
|-
|<code><nowiki>{{convert|550|ft|m|0}}</nowiki></code> || {{convert|550|ft|m|0}} || Approximate value is 167.64 m
|-
|<code><nowiki>{{convert|550|ft|m}}</nowiki></code> || {{convert|550|ft|m}} || Rounds to 170, when approximate value is 167.64 m
|-
|<code><nowiki>{{convert|500|ft|m|0}}</nowiki></code> || {{convert|500|ft|m|0}} || Approximate value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|m}}</nowiki></code> || {{convert|500|ft|m}} || Rounds to 150, when approximate value is 152.4 m
|}

''Convert'' supports four types of rounding:

===Round to a given precision: ''use {{para|precision|}}''===
Specify the desired precision with the fourth unnamed parameter (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest 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: ''{{para|sigfig|}}''===
To specify the output number to be with ''n'' significant figures use {{para|sigfig|<number>}}:
* To compare: <code><nowiki>{{convert|1200|ft|m}}</nowiki></code> → {{convert|1200|ft|m}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki></code> → {{convert|1200|ft|m|sigfig=4}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=3}}</nowiki></code> → {{convert|1200|ft|m|sigfig=3}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=2}}</nowiki></code> → {{convert|1200|ft|m|sigfig=2}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki></code> → {{convert|1200|ft|m|sigfig=1}}
Setting {{para|sigfig|<=0}} is meaningless
* <code><nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki></code> → {{convert|1200|ft|m|sigfig=0}}

===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
Using {{para|round|5}} rounds the outcome to a multiple of 5.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<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.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> → {{convert|10|m|ft|round=25}}
:To compare: <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}}:
:<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> → {{convert|10 x 200 x 3000|m|ft|round=each}}

===Round to a multiple of a given fraction: ''{{frac|2|3|16}} inch''===
Specify the desired ''denominator'' using {{para|frac|<some positive integer>}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|3}}).
:<code><nowiki>{{convert|5.56|cm|in|frac=16}}</nowiki></code> → {{convert|5.56|cm|in|frac=16}}
:<code><nowiki>{{convert|8|cm|in|frac=4}}</nowiki></code> → {{convert|8|cm|in|frac=4}}
The fraction is reduced when possible:
:<code><nowiki>{{convert|8|cm|in|frac=100}}</nowiki></code> → {{convert|8|cm|in|frac=100}}
:<code><nowiki>{{convert|8|cm|in}}</nowiki></code> → {{convert|8|cm|in|sigfig=4}} (To compare)

==={{anchor|Rounding temperatures}}In temperatures: rounding ''°C'', ''°F'' and ''K''===
In temperatures, the conversion will be rounded either to precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.

#{{#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|-300|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}}

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 into five significant output digits because of the two numbers 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.

==Into multiple units: ''{{convert|10|C|F K}}''==
Separate the multiple output units by a space:
:<code><nowiki>{{convert|10|C|F K}}</nowiki></code> → {{convert|10|C|F K}}
:<code><nowiki>{{convert|5|km|mi nmi}}</nowiki></code> → {{convert|5|km|mi nmi}}
If the output unit names contain spaces, use a '+' separator.
;See also
For multiple-unit options like ''1 ft 5 in'', see [[#In input]] and [[#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: 
{{Convert/doc/range separator list}}

===Multiple dimensions: ''{{convert|6|x|12|m|ft|abbr=on}}''===
; Use "by":
:<code><nowiki>{{convert|6|by|12|ft|m}}</nowiki></code> → {{convert|6|by|12|ft|m}}
;Use "×" or ""x"":
:<code><nowiki>{{convert|6|x|12|m|ft}}</nowiki></code> → {{convert|6|x|12|m|ft}}

In science, the formal way is to set <code>|x|</code> and {{para|abbr|on}} (keeping dimensions right, like in ''area = x km2''):
:<code><nowiki>{{convert|6|x|12|m|ft|abbr=on}}</nowiki></code> → {{convert|6|x|12|m|ft|abbr=on}}

===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:
* <code><nowiki>{{convert|1|ft|3|in|mm}}</nowiki></code> → {{convert|1|ft|3|in|mm}} (to compare)
* <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}}

==Words==
===Spelling of unit name: UK ''metre'' or US ''meter''?===
Default spelling of units is en-UK. 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}}

===Spell out numbers: ''ten miles''===
To write a number in words, use {{para|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}}:
:<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}}
:<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> → {{convert|10|mi|m|spell=On}}

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> → {{convert|10|mi|m|spell=on|abbr=off|sp=us}}
===Extra words: ''4 planted acres''===
:''Incomplete section''
:<code><nowiki>{{convert|4|acre||adj=pre|planted}}</nowiki></code> → {{convert|4|acre||adj=pre|planted}}

===Extra adjective words: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
:<code><nowiki>{{convert|10|ft|m|adj=mid|-long}}</nowiki></code> → {{convert|10|ft|m|adj=mid|-long}}

===Plurals: ''1 inch, 2 inches''===
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}}

;Exception:
Entering the unit spelled <code>|foot|</code> forces singular output "foot", whatever the number is.
* <code><nowiki>{{convert|100|foot|abbr=off}}</nowiki></code> → {{convert|100|foot|abbr=off}}

==Numbers==

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

To illustrate, these are trivial calculations (from meter to meter), showing the multiplication factor:
* {{convert|12|Gm|m|abbr=on}}
* {{convert|12|μm|m|abbr=on}}

The prefix can be added before the SI unit (here: unit <code>m</code> for meter):
* <code><nowiki>{{convert|12|Gm|mi|abbr=on}}</nowiki></code> → {{convert|12|Gm|mi|abbr=on}}
* <code>Mm</code>: {{convert|12|Mm|mi|abbr=on}}
* <code>km</code>: {{convert|12|km|ft|abbr=on}}
* <code>mm</code>: {{convert|12|mm|in|abbr=on}}
* <code>μm</code>: {{convert|12|μm|mm|abbr=on}}
* <code>um</code>: {{convert|12|um|mm|abbr=on}} (letter "u" can be used for "μ" here)

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

As an exception, the non-SI unit "inch" can have the "μ" prefix too)
* <code><nowiki>{{convert|12|μm|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}

:{{further|Help:Convert units#SI prefixes}}

===Engineering notation: ''7 × 106 m''===

====In the unit: ''e6m''====
[[Engineering notation|Engineering number notations]] like ''7{{smallcaps|E}}6'' (for 7 × 106) can be entered as a "prefix" to the unit:
:<code><nowiki>{{convert|7|e6m}}</nowiki></code> → {{convert|7|e6m}}
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−14''===
In [[scientific notation]], a number is written like {{rnd|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}}

===Input with fractions: ''{{convert|1+1/2|in|mm|1}}''===
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}}

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 (do not require a calculation)

===Output with horizontal fraction bar in: ''{{sfrac|1|2}} inch''===

Using a double slash (<code>//</code>) returns a horizontal bar fraction:
* <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}}

===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}}
*<code><nowiki>{{convert|1 234 567|m|ft}}</nowiki></code> → {{convert|1 234 567|m|ft}} {{nay}}

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}}</nowiki></code> → {{convert|1234567|m|ft}} (To compare, default)
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps}}

Setting {{para|comma|5}} or {{para|comma|gaps5}} will only add the separator when the number of digits is 5 or more:
*<code><nowiki>{{convert|1234|m|ft}}</nowiki></code> → {{convert|1234|m|ft}} (To compare, default)
*<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}}
*<code><nowiki>{{convert|1234|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234|m|ft|comma=gaps5}}
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps5}}

==Output manipulation==
===Brackets and separators: ''10 m [33 ft]''===
Punctuation that distinguishes the two measurements is set by {{para|disp|}}. 
Options are: <code>b</code> (the default), <code>sqbr</code>, <code>comma</code>, <code>or</code>, <code>br</code>, <code>x{{!}}≈...</code>:
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}—''( ) 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=comma}}</nowiki></code> → {{convert|10|m|ft|disp=comma}}
:<code><nowiki>{{convert|10|m|ft|disp=or}}</nowiki></code> → {{convert|10|m|ft|disp=or}}

Setting {{para|disp|br}} will force a new line (<code> </code>)
:<code><nowiki>{{convert|10|m|ft|disp=br}}</nowiki></code> → {{convert|10|m|ft|disp=br}}
Also {{para|disp|br()}} will force a new line, and keep the brackets:
:<code><nowiki>{{convert|10|m|ft|disp=br()}}</nowiki></code> → {{convert|10|m|ft|disp=br()}}

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_}}—(To display spaces, use <code>&nbsp;</code>)

===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:
:<code><nowiki>{{convert|1|mi|m}}</nowiki></code> → {{convert|1|mi|m|sigfig=5|abbr=off}} (To compare, default)
:<code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> → {{convert|1|mi|m|order=flip|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}}

=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
It is possible to display only parts of the conversion result:


{| class="wikitable"
! Convert !! Output !! Description
|-
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}}
| Default, to compare
|-
| <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|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|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|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=out}}</nowiki></code> || {{convert|2|cuyd|m3|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
|}
===Display both input name and symbol: ''2 kilopascals [kPa]''===
Setting {{para|abbr|~}} returns both name and symbol of the first (input) unit:
:<code><nowiki>{{convert|2|kPa|psi|abbr=~}}</nowiki></code> → {{convert|2|kPa|psi|abbr=~}}
:<code><nowiki>A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure</nowiki></code> → {{nowrap|A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure}}

==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 showing numbers only===
Using {convert} in a table cell, with {{para|disp|table}} splits the result over two columns:
:<code><nowiki>{{convert|10|m|ft|disp=table}}</nowiki></code> → {{convert|10|m|ft|disp=table}}

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

The units are added as a column header:
:{| class=wikitable
! style="width:10em;" |  
! style="width:10em;" | m
! style="width:10em;" | ft
|-
| {{para|disp|table}}
| {{convert|10|m|ft|disp=table}}
|-
|{{para|disp|tablecen}}
| {{convert|20|m|ft|disp=tablecen}}
|-
|{{para|disp|<other>}} (default)
|{{convert|30|m|ft|disp=}}
|}

===Sorting===
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=700110000000000000010 metres (33&nbsp;ft)}}

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

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

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==
===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}}}}
<div style="height: 400px; overflow: auto; padding: 3px; border: 1px solid #aaa;">
{{Convert/list of units}}
</div>

==='per' units: ''kg/hl''===
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}}

===Units of difference===
When a number is the measurement for a ''difference'', one conversion is done. This may occur in temperatures (°C, °F, K). Compare this to a ''range'', when two conversions are done.

The only available units of difference are: {{para|C-change}}, {{para|F-change}} and {{para| K-change}}.

:{{#invoke:DemoTemplate|convert|10|C}} -- regular temperature
:{{#invoke:DemoTemplate|convert|10|C-change}} -- difference (e.g., "The temperature changed from 30 into 40 °C")
:{{#invoke:DemoTemplate|convert|10-15|C}} -- range (e.g., "The temperature is between 10 and 15 °C")

Consistently, into multiple units:
:<code><nowiki>A rise of {{convert|10|C-change|F-change K-change}}</nowiki></code> → A rise of {{convert|10|C-change|F-change K-change}}

===Multiple units: ''1 ft 5 in''===
====In input====
Base document {{slink|Module:Convert/documentation/conversion data/doc|Input multiples|nopage=y}} 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):
::*<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 {{slink|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
:*<code><nowiki>{{convert|2|m}}</nowiki></code> → {{convert|2|m}}—the default

;See also
* {{tl|hands}} a length used to measure horses
* {{tl|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:
:* <code><nowiki>{{convert|10|$/mi|$/km}}</nowiki></code> → {{convert|10|$/mi|$/km}}

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

==Parameter list==
{{convert/doc/parameter list}}

==Deprecated options==
{{Convert/doc/deprecations list}}

==TemplateData==
{{TemplateDataHeader}}

<templatedata>{
"description": "Converts measurements to other units.",
"params": {
"1": {
"label": "value",
"description": "the value to convert",
"type": "number"
},
"2": {
"label": "from unit",
"description": "",
"type": "string/line"
},
"3": {
"label": "to units",
"description": "the unit to convert into",
"type": "string/line"
},
"4": {
"label": "precision or suffix",
"description": "significant digits after decimal dot or, if negative, exponent of ten",
"type": "number"
},
"lk": {
"label": "link units",
"description": "“on” all, “in” input, “out” output or “off” no units",
"default": "off",
"type": "string/line"
},
"abbr": {
"label": "abbreviation",
"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",
"default": "out",
"type": "string/line"
},
"sp": {
"label": "spelling",
"description": "“us” display U.S. spelling of unit names",
"type": "string/line"
},
"adj": {
"label": "adjective",
"description": "adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end",
"type": "string/line"
},
"disp": {
"label": "conversion",
"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",
"default": "b",
"type": "string/line"
},
"order": {
"label": "ordering",
"description": "“flip” returns converted value first, input value second.",
"type": "string/line"
},
"sigfig": {
"label": "significant figures",
"description": "number that sets the number of significant figures",
"type": "number"
},
"round": {
"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",
"type": "string/line"
},
"comma": {
"label": "thousands separator",
"description": "Sets or suppresses thousand separator in the numbers. “off” = no separator; “gaps”: use space not comma; “5” and “gaps5”: only add separator when number > 5 positions (10,000 or more)",
"default": "on",
"type": "string/line"
},
"sortable": {
"label": "sort key",
"description": "“on” generates a hidden sort key",
"type": "string/line"
}
}}</templatedata>


==See also==
* {{Temp|Cvt}}
* {{Temp|SI units}}
{{Convert navs}}
<noinclude>
[[Category:Convert by module documentation| ]]
</noinclude><includeonly>
[[Category:Convert templates| ]]
[[Category:Conversion templates]]
[[Category:Numbers as words conversion templates]]
[[Category:Sorting templates]]
</includeonly>

Template:Convert/doc

2016-06-20T04:23:33Z

178.16.7.96: /* Scientific notation: 1.23×10−14 */

{{documentation subpage}}
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk| {{formatnum:789000}}+ }}}}
{{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}}
'''Template {{tl|convert}}''' ''calculates'' measurements from one unit (you can enter) to another one, and then ''presents the results''. For example:
:<code><nowiki>{{convert|2|km|mi}}</nowiki></code> → {{convert|2|km|mi}}
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> → {{convert|7|mi|km}}

The available '''units''' are listed [[#Units|below]]. Units are case-sensitive always ({{xt|kW}}, ''not'' {{!xt|KW}} and ''not'' {{!xt|kw}}). Multiple '''formatting''' and calculation options are listed below.

{{hatnote|See [[Help:Convert]] for more complete information}}
{{hatnote|For currency conversion into US dollars, see [[Template:To USD]]}}

==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
By default, the first value shows unit name spelled out, the second the symbol (or abbreviation).
Use {{para|abbr|on/off}} to change this behaviour:
:<code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}
To abbreviate both:
:<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}}
* {{para|abbr|in}} toggles the default behaviour ({{para|abbr|out}}):
:<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{convert|1|lb|kg|abbr=in}}

===Convenience: {{tlf|cvt}} has {{para|abbr|on}} by default===
Template {{tl|cvt}} is similar to {{tlf|convert}}, but has pre-set {{para|abbr|on}}. In {{tlf|cvt}}, all other options are available. So:

:<code><nowiki>{{cvt|1|lb|kg}}</nowiki></code> → {{cvt|1|lb|kg}}
:is equal to:
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{cvt|1|lb|kg|abbr=on}}

==Adjective: ''a 10-mile distance''==
Use {{para|adj|on}} to produce the adjective form. The difference:
:<code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> → {{convert|10|mi|km}} to go. ''(To compare, default)''
:<code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> → A {{convert|10|mi|km|adj=on}} distance. ''(Adjective form)''
This option does not work with {{para|abbr|on}}.

==Rounding: ''100 ft'' is ''30 m'' or ''30.5 m'' or ''30.48 m''?==
By definition, 100 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===
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 figures, whichever is more precise. An exception to this is ''rounding temperatures'' (see [[#Rounding temperatures|below]]).

{| class="wikitable"
|-
! colspan="3" | Examples of rounding
|-
|'''Input'''||'''Displays as'''||'''Note'''
|-
|<code><nowiki>{{convert|123|ft|m|-1}}</nowiki></code> || {{convert|123|ft|m|-1}} ||
|-
|<code><nowiki>{{convert|123|ft|m|0}}</nowiki></code> || {{convert|123|ft|m|0}} ||
|-
|<code><nowiki>{{convert|123|ft|m|1}}</nowiki></code> || {{convert|123|ft|m|1}} ||
|-
|<code><nowiki>{{convert|550|ft|m|0}}</nowiki></code> || {{convert|550|ft|m|0}} || Approximate value is 167.64 m
|-
|<code><nowiki>{{convert|550|ft|m}}</nowiki></code> || {{convert|550|ft|m}} || Rounds to 170, when approximate value is 167.64 m
|-
|<code><nowiki>{{convert|500|ft|m|0}}</nowiki></code> || {{convert|500|ft|m|0}} || Approximate value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|m}}</nowiki></code> || {{convert|500|ft|m}} || Rounds to 150, when approximate value is 152.4 m
|}

''Convert'' supports four types of rounding:

===Round to a given precision: ''use {{para|precision|}}''===
Specify the desired precision with the fourth unnamed parameter (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest 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: ''{{para|sigfig|}}''===
To specify the output number to be with ''n'' significant figures use {{para|sigfig|<number>}}:
* To compare: <code><nowiki>{{convert|1200|ft|m}}</nowiki></code> → {{convert|1200|ft|m}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki></code> → {{convert|1200|ft|m|sigfig=4}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=3}}</nowiki></code> → {{convert|1200|ft|m|sigfig=3}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=2}}</nowiki></code> → {{convert|1200|ft|m|sigfig=2}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki></code> → {{convert|1200|ft|m|sigfig=1}}
Setting {{para|sigfig|<=0}} is meaningless
* <code><nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki></code> → {{convert|1200|ft|m|sigfig=0}}

===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
Using {{para|round|5}} rounds the outcome to a multiple of 5.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<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.
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
:<code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> → {{convert|10|m|ft|round=25}}
:To compare: <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}}:
:<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> → {{convert|10 x 200 x 3000|m|ft|round=each}}

===Round to a multiple of a given fraction: ''{{frac|2|3|16}} inch''===
Specify the desired ''denominator'' using {{para|frac|<some positive integer>}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|3}}).
:<code><nowiki>{{convert|5.56|cm|in|frac=16}}</nowiki></code> → {{convert|5.56|cm|in|frac=16}}
:<code><nowiki>{{convert|8|cm|in|frac=4}}</nowiki></code> → {{convert|8|cm|in|frac=4}}
The fraction is reduced when possible:
:<code><nowiki>{{convert|8|cm|in|frac=100}}</nowiki></code> → {{convert|8|cm|in|frac=100}}
:<code><nowiki>{{convert|8|cm|in}}</nowiki></code> → {{convert|8|cm|in|sigfig=4}} (To compare)

==={{anchor|Rounding temperatures}}In temperatures: rounding ''°C'', ''°F'' and ''K''===
In temperatures, the conversion will be rounded either to precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.

#{{#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|-300|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}}

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 into five significant output digits because of the two numbers 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.

==Into multiple units: ''{{convert|10|C|F K}}''==
Separate the multiple output units by a space:
:<code><nowiki>{{convert|10|C|F K}}</nowiki></code> → {{convert|10|C|F K}}
:<code><nowiki>{{convert|5|km|mi nmi}}</nowiki></code> → {{convert|5|km|mi nmi}}
If the output unit names contain spaces, use a '+' separator.
;See also
For multiple-unit options like ''1 ft 5 in'', see [[#In input]] and [[#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: 
{{Convert/doc/range separator list}}

===Multiple dimensions: ''{{convert|6|x|12|m|ft|abbr=on}}''===
; Use "by":
:<code><nowiki>{{convert|6|by|12|ft|m}}</nowiki></code> → {{convert|6|by|12|ft|m}}
;Use "×" or ""x"":
:<code><nowiki>{{convert|6|x|12|m|ft}}</nowiki></code> → {{convert|6|x|12|m|ft}}

In science, the formal way is to set <code>|x|</code> and {{para|abbr|on}} (keeping dimensions right, like in ''area = x km2''):
:<code><nowiki>{{convert|6|x|12|m|ft|abbr=on}}</nowiki></code> → {{convert|6|x|12|m|ft|abbr=on}}

===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:
* <code><nowiki>{{convert|1|ft|3|in|mm}}</nowiki></code> → {{convert|1|ft|3|in|mm}} (to compare)
* <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}}

==Words==
===Spelling of unit name: UK ''metre'' or US ''meter''?===
Default spelling of units is en-UK. 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}}

===Spell out numbers: ''ten miles''===
To write a number in words, use {{para|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}}:
:<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}}
:<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> → {{convert|10|mi|m|spell=On}}

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> → {{convert|10|mi|m|spell=on|abbr=off|sp=us}}
===Extra words: ''4 planted acres''===
:''Incomplete section''
:<code><nowiki>{{convert|4|acre||adj=pre|planted}}</nowiki></code> → {{convert|4|acre||adj=pre|planted}}

===Extra adjective words: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
:<code><nowiki>{{convert|10|ft|m|adj=mid|-long}}</nowiki></code> → {{convert|10|ft|m|adj=mid|-long}}

===Plurals: ''1 inch, 2 inches''===
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}}

;Exception:
Entering the unit spelled <code>|foot|</code> forces singular output "foot", whatever the number is.
* <code><nowiki>{{convert|100|foot|abbr=off}}</nowiki></code> → {{convert|100|foot|abbr=off}}

==Numbers==

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

To illustrate, these are trivial calculations (from meter to meter), showing the multiplication factor:
* {{convert|12|Gm|m|abbr=on}}
* {{convert|12|μm|m|abbr=on}}

The prefix can be added before the SI unit (here: unit <code>m</code> for meter):
* <code><nowiki>{{convert|12|Gm|mi|abbr=on}}</nowiki></code> → {{convert|12|Gm|mi|abbr=on}}
* <code>Mm</code>: {{convert|12|Mm|mi|abbr=on}}
* <code>km</code>: {{convert|12|km|ft|abbr=on}}
* <code>mm</code>: {{convert|12|mm|in|abbr=on}}
* <code>μm</code>: {{convert|12|μm|mm|abbr=on}}
* <code>um</code>: {{convert|12|um|mm|abbr=on}} (letter "u" can be used for "μ" here)

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

As an exception, the non-SI unit "inch" can have the "μ" prefix too)
* <code><nowiki>{{convert|12|μm|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}

:{{further|Help:Convert units#SI prefixes}}

===Engineering notation: ''7 × 106 m''===

====In the unit: ''e6m''====
[[Engineering notation|Engineering number notations]] like ''7{{smallcaps|E}}6'' (for 7 × 106) can be entered as a "prefix" to the unit:
:<code><nowiki>{{convert|7|e6m}}</nowiki></code> → {{convert|7|e6m}}
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−14''===
In [[scientific notation]], a number is written like {{rnd|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}}

===Input with fractions: ''{{convert|1+1/2|in|mm|1}}''===
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}}
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 (do not require a calculation)

===Output with horizontal fraction bar in: ''{{sfrac|1|2}} inch''===

Using a double slash (<code>//</code>) returns a horizontal bar fraction:
* <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}}

===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}}
*<code><nowiki>{{convert|1 234 567|m|ft}}</nowiki></code> → {{convert|1 234 567|m|ft}} {{nay}}

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}}</nowiki></code> → {{convert|1234567|m|ft}} (To compare, default)
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps}}

Setting {{para|comma|5}} or {{para|comma|gaps5}} will only add the separator when the number of digits is 5 or more:
*<code><nowiki>{{convert|1234|m|ft}}</nowiki></code> → {{convert|1234|m|ft}} (To compare, default)
*<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}}
*<code><nowiki>{{convert|1234|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234|m|ft|comma=gaps5}}
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps5}}

==Output manipulation==
===Brackets and separators: ''10 m [33 ft]''===
Punctuation that distinguishes the two measurements is set by {{para|disp|}}. 
Options are: <code>b</code> (the default), <code>sqbr</code>, <code>comma</code>, <code>or</code>, <code>br</code>, <code>x{{!}}≈...</code>:
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}—''( ) 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=comma}}</nowiki></code> → {{convert|10|m|ft|disp=comma}}
:<code><nowiki>{{convert|10|m|ft|disp=or}}</nowiki></code> → {{convert|10|m|ft|disp=or}}

Setting {{para|disp|br}} will force a new line (<code> </code>)
:<code><nowiki>{{convert|10|m|ft|disp=br}}</nowiki></code> → {{convert|10|m|ft|disp=br}}
Also {{para|disp|br()}} will force a new line, and keep the brackets:
:<code><nowiki>{{convert|10|m|ft|disp=br()}}</nowiki></code> → {{convert|10|m|ft|disp=br()}}

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_}}—(To display spaces, use <code>&nbsp;</code>)

===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:
:<code><nowiki>{{convert|1|mi|m}}</nowiki></code> → {{convert|1|mi|m|sigfig=5|abbr=off}} (To compare, default)
:<code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> → {{convert|1|mi|m|order=flip|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}}

=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
It is possible to display only parts of the conversion result:


{| class="wikitable"
! Convert !! Output !! Description
|-
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}}
| Default, to compare
|-
| <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|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|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|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=out}}</nowiki></code> || {{convert|2|cuyd|m3|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
|}
===Display both input name and symbol: ''2 kilopascals [kPa]''===
Setting {{para|abbr|~}} returns both name and symbol of the first (input) unit:
:<code><nowiki>{{convert|2|kPa|psi|abbr=~}}</nowiki></code> → {{convert|2|kPa|psi|abbr=~}}
:<code><nowiki>A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure</nowiki></code> → {{nowrap|A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure}}

==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 showing numbers only===
Using {convert} in a table cell, with {{para|disp|table}} splits the result over two columns:
:<code><nowiki>{{convert|10|m|ft|disp=table}}</nowiki></code> → {{convert|10|m|ft|disp=table}}

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

The units are added as a column header:
:{| class=wikitable
! style="width:10em;" |  
! style="width:10em;" | m
! style="width:10em;" | ft
|-
| {{para|disp|table}}
| {{convert|10|m|ft|disp=table}}
|-
|{{para|disp|tablecen}}
| {{convert|20|m|ft|disp=tablecen}}
|-
|{{para|disp|<other>}} (default)
|{{convert|30|m|ft|disp=}}
|}

===Sorting===
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=700110000000000000010 metres (33&nbsp;ft)}}

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

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

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==
===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}}}}
<div style="height: 400px; overflow: auto; padding: 3px; border: 1px solid #aaa;">
{{Convert/list of units}}
</div>

==='per' units: ''kg/hl''===
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}}

===Units of difference===
When a number is the measurement for a ''difference'', one conversion is done. This may occur in temperatures (°C, °F, K). Compare this to a ''range'', when two conversions are done.

The only available units of difference are: {{para|C-change}}, {{para|F-change}} and {{para| K-change}}.

:{{#invoke:DemoTemplate|convert|10|C}} -- regular temperature
:{{#invoke:DemoTemplate|convert|10|C-change}} -- difference (e.g., "The temperature changed from 30 into 40 °C")
:{{#invoke:DemoTemplate|convert|10-15|C}} -- range (e.g., "The temperature is between 10 and 15 °C")

Consistently, into multiple units:
:<code><nowiki>A rise of {{convert|10|C-change|F-change K-change}}</nowiki></code> → A rise of {{convert|10|C-change|F-change K-change}}

===Multiple units: ''1 ft 5 in''===
====In input====
Base document {{slink|Module:Convert/documentation/conversion data/doc|Input multiples|nopage=y}} 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):
::*<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 {{slink|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
:*<code><nowiki>{{convert|2|m}}</nowiki></code> → {{convert|2|m}}—the default

;See also
* {{tl|hands}} a length used to measure horses
* {{tl|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:
:* <code><nowiki>{{convert|10|$/mi|$/km}}</nowiki></code> → {{convert|10|$/mi|$/km}}

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

==Parameter list==
{{convert/doc/parameter list}}

==Deprecated options==
{{Convert/doc/deprecations list}}

==TemplateData==
{{TemplateDataHeader}}

<templatedata>{
"description": "Converts measurements to other units.",
"params": {
"1": {
"label": "value",
"description": "the value to convert",
"type": "number"
},
"2": {
"label": "from unit",
"description": "",
"type": "string/line"
},
"3": {
"label": "to units",
"description": "the unit to convert into",
"type": "string/line"
},
"4": {
"label": "precision or suffix",
"description": "significant digits after decimal dot or, if negative, exponent of ten",
"type": "number"
},
"lk": {
"label": "link units",
"description": "“on” all, “in” input, “out” output or “off” no units",
"default": "off",
"type": "string/line"
},
"abbr": {
"label": "abbreviation",
"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",
"default": "out",
"type": "string/line"
},
"sp": {
"label": "spelling",
"description": "“us” display U.S. spelling of unit names",
"type": "string/line"
},
"adj": {
"label": "adjective",
"description": "adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end",
"type": "string/line"
},
"disp": {
"label": "conversion",
"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",
"default": "b",
"type": "string/line"
},
"order": {
"label": "ordering",
"description": "“flip” returns converted value first, input value second.",
"type": "string/line"
},
"sigfig": {
"label": "significant figures",
"description": "number that sets the number of significant figures",
"type": "number"
},
"round": {
"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",
"type": "string/line"
},
"comma": {
"label": "thousands separator",
"description": "Sets or suppresses thousand separator in the numbers. “off” = no separator; “gaps”: use space not comma; “5” and “gaps5”: only add separator when number > 5 positions (10,000 or more)",
"default": "on",
"type": "string/line"
},
"sortable": {
"label": "sort key",
"description": "“on” generates a hidden sort key",
"type": "string/line"
}
}}</templatedata>


==See also==
* {{Temp|Cvt}}
* {{Temp|SI units}}
{{Convert navs}}
<noinclude>
[[Category:Convert by module documentation| ]]
</noinclude><includeonly>
[[Category:Convert templates| ]]
[[Category:Conversion templates]]
[[Category:Numbers as words conversion templates]]
[[Category:Sorting templates]]
</includeonly>

Template:Convert/doc/parameter list

2016-06-18T08:16:08Z

178.16.7.96:

{| class="wikitable sortable collapsible {{{state|uncollapsed}}}" style="width:100%;"
! colspan=4 style="background:#eee" | {{navbar-collapsible|'''Parameter options for <nowiki>{{convert}}</nowiki>'''|Convert/doc/parameter list}}
|-
! Option
! {{abbr|1==..|2=Sort by value of the option}}
! Description
! Note
|-
|<code>|abbr=in</code> || {{hidden sort key|in}}
| Use symbol for first (left-hand side) unit
| Symbol ('abbreviation')
|-
|<code>|abbr=off</code> || {{hidden sort key|off}}
| rowspan=2 | Use name for all units
| rowspan=2 | Symbol ('abbreviation')
|-
|<code>|abbr=none</code> || {{hidden sort key|none}}
|-
|<code>|abbr=on</code> || {{hidden sort key|on}}
| Use symbol for all units
| Symbol ('abbreviation')
|-
|<code>|abbr=out</code> || {{hidden sort key|out}}
| Use symbol for right-hand side unit (default)
| Symbol ('abbreviation')
|-
|<code>|abbr=values</code> || {{hidden sort key|values}}
| Show only input and output numbers, not units
| Parts only
|-
|<code>|abbr=~</code> || {{hidden sort key|~}}
| Shows both unit name and symbol
| Symbol & name
|-
|<code>|adj=j</code> || {{hidden sort key|j}}
| Join number and unit name using "&nbsp;" instead of a space
| Join values
|-
|<code>|adj=mid|x=...</code> || {{hidden sort key|mid}}
| User-specified text after the input unit; sets <code>adj=on</code> (adjective)
| Word adding, adjective
|-
|<code>|adj=on</code> || {{hidden sort key|on}}
| Unit name is adjective (singular and hyphenated)
| Grammar, adjective
|-
|<code>|adj=pre|x=...</code> || {{hidden sort key|pre}}
| User-specified text before input unit
| Word adding
|-
|<code>|adj=ri0</code> || {{hidden sort key|ri0}}
| Round input with precision 0
| Rounding and sigfig
|-
|<code>|adj=ri1</code> || {{hidden sort key|ri1}}
| Round input with precision 1
| Rounding and sigfig
|-
|<code>|adj=ri2</code> || {{hidden sort key|ri2}}
| Round input with precision 2
| Rounding and sigfig
|-
|<code>|adj=ri3</code> || {{hidden sort key|ri3}}
| Round input with precision 3
| Rounding and sigfig
|-
|<code>|disp=b</code> || {{hidden sort key|b}}
| Join input and output using " (...)" (default)
| Join values
|-
|<code>|disp=sqbr</code> || {{hidden sort key|sqbr}}
| Join input and output using " [...]"
| Join values
|-
|<code>|disp=br</code> || {{hidden sort key|br}}
| Join input and output using " "
| Join values
|-
|<code>|disp=comma</code> || {{hidden sort key|comma}}
| Join input and output using ", "
| Join values
|-
|<code>|disp=or</code> || {{hidden sort key|or}}
| Join input and output using " or "
| Join values
|-
|<code>|disp=number</code> || {{hidden sort key|number}}
| rowspan=2 | Display output number only
| rowspan=2 | Parts only
|-
|<code>|disp=output number only</code> || {{hidden sort key|output number only}}
|-
|<code>|disp=out</code> || {{hidden sort key|out}}
| rowspan=2 | Display only output number and name/symbol
| rowspan=2 | Parts only
|-
|<code>|disp=output only</code> || {{hidden sort key|output only}}
|-
|<code>|disp=preunit|x=...</code> || {{hidden sort key|preunit}}
| User-specified text before input and output units
| Word adding
|-
|<code>|disp=table</code> || {{hidden sort key|table}}
| Output is suitable for a table cell with align="right"
| Table columns
|-
|<code>|disp=tablecen</code> || {{hidden sort key|tablecen}}
| Output is suitable for a table cell with align="center"
| Table columns
|-
|<code>|disp=unit</code> || {{hidden sort key|unit}}
| Display input name/symbol only (not input number, not output)
| Parts only
|-
|<code>|disp=unit2</code> || {{hidden sort key|unit2}}
| Display output name/symbol only (not input; not output number)
| Parts only
|-
|<code>|disp=x|...</code> || {{hidden sort key|x}}
| Join input and output using user-specified text
| Word adding
|-
|<code>|comma=5</code> || {{hidden sort key|05}}
| Only use comma for thousands separator if 5 or more digits
| Number format
|-
|<code>|comma=gaps</code> || {{hidden sort key|gaps}}
| Use gaps (space), not comma, for thousands separator
| Number format
|-
|<code>|comma=gaps5</code> || {{hidden sort key|gaps5}}
| Use gaps (space), but only if 5 or more digits
| Number format
|-
|<code>|comma=off</code> || {{hidden sort key|off}}
| No thousands separator
| Number format
|-
|<code>|frac=''N''</code> || {{hidden sort key|N}}
| Show imperial number in fractions, denominator=''N''
| Number format, fraction
|-
|<code>|lk=in</code> || {{hidden sort key|in}}
| Link left-hand side unit name or symbol
| Unit link
|-
|<code>|lk=on</code> || {{hidden sort key|on}}
| Link all unit names or symbols (but not twice for the same unit)
| Unit link
|-
|<code>|lk=out</code> || {{hidden sort key|out}}
| Link right-hand side unit name or symbol
| Unit link
|-
|<code>|order=flip</code> || {{hidden sort key|flip}}
| Inverts order of input, output measurements (conversion first)
| Order
|-
|<code>|round=5</code> || {{hidden sort key|05}}
| Rounds calculation to the nearest multiple of 5
| Rounding and sigfig
|-
|<code>|round=25</code> || {{hidden sort key|25}}
| Rounds calculation to the nearest multiple of 25
| Rounding and sigfig
|-
|<code>|round=each</code> || {{hidden sort key|each}}
| In a range, each number is rounded by the default rounding
| Rounding and sigfig
|-
|<code>|sigfig=''N''</code> || {{hidden sort key|N}}
| Round output number to ''N'' significant figures (''N'' is a positive integer)
| Rounding and sigfig
|-
|<code>|sortable=in</code> || {{hidden sort key|in}}
| rowspan=2 | Output numeric hidden sort field for use in a sortable table (based on input)
| rowspan=2 | Table sort
|-
|<code>|sortable=on</code> || {{hidden sort key|on}}
|-
|<code>|sortable=out</code> || {{hidden sort key|out}}
| Output numeric hidden sort field for use in a sortable table (based on output)
| Table sort
|-
|<code>|sp=us</code> || {{hidden sort key|us}}
| Use U.S. spelling (like "meter" instead of default "metre")
| Spelling U.S. names
|-
|<code>|spell=in</code> || {{hidden sort key|in}}
| Spell input number in words
| Spelling numbers
|-
|<code>|spell=In</code> || {{hidden sort key|In}}
| Spell input number in words with first letter uppercase
| Spelling numbers
|-
|<code>|spell=on</code> || {{hidden sort key|on}}
| Spell input and output numbers in words
| Spelling numbers
|-
|<code>|spell=On</code> || {{hidden sort key|On}}
| Spell input and output numbers in words with first letter uppercase
| Spelling numbers
|-
|<code>|$=''€''</code> || {{hidden sort key|$}}
| Replace $-sign with a currency sign, for example in <code>$/acre</code> {{nowrap|(no currency conversion happens)}}
| Cost per unit
|-
|<code>|debug=yes</code> || {{hidden sort key|yes}}
| '''Debugging only'''. In a sortable table: show the normally hidden sort key
| Table sort
|- 
|<code>{{!xt|1=|abbr=comma}}</code> || {{hidden sort key|comma}}
| '''Deprecated'''. Use {{xt|1=|comma=off}}
| Number format
|-
|<code>{{!xt|1=|abbr=mos}}</code> || {{hidden sort key|mos}}
| '''Deprecated'''. Use {{xt|1=|x|}} ''or'' {{xt|1=|by|}}
| Range format
|-
|<code>{{!xt|1=|adj=1}}</code> || {{hidden sort key|01}}
| '''Deprecated'''. Do not use. No need to deviate from [[MOS:FRACTION|MOS]] regarding plurals
| Plural or singular
|-
|<code>{{!xt|1=|adj=flip}}</code> || {{hidden sort key|flip}}
| '''Deprecated'''. Use {{xt|1=|order=flip}}
| Order
|-
| <code>{{!xt|1=|adj=nocomma}}</code> || {{hidden sort key|nocomma}}
| '''Deprecated'''. Use {{xt|1=|comma=off}}
| Number format
|-
|<code>{{!xt|1=|disp=2}}</code> || {{hidden sort key|02}}
| '''Deprecated'''. Use {{xt|1=|disp=output only}}
| Parts only
|-
|<code>{{!xt|1=|disp=5}}</code> || {{hidden sort key|05}}
| '''Deprecated'''. Use {{xt|1=|round=5}}
| Rounding and sigfig
|-
|<code>{{!xt|1=|disp=flip}}</code> || {{hidden sort key|flip}}
| '''Deprecated'''. Use {{xt|1=|order=flip}}
| Order
|-
|<code>{{!xt|1=|disp=flip5}}</code> || {{hidden sort key|flip5}}
| '''Deprecated'''. Use {{xt|1=|order=flip |round=5}}
| Order, rounding
|-
| <code>{{!xt|1=|disp=nocomma}}</code> || {{hidden sort key|nocomma}}
| '''Deprecated'''. Use {{xt|1=|comma=off}}
| Number format
|-
|<code>{{!xt|1=|disp=u2}}</code> || {{hidden sort key|u2}}
| '''Deprecated'''. Use {{xt|1=|disp=unit2}}
| Parts only
|-
|<code>{{!xt|1=|near=5}}</code> || {{hidden sort key|05}}
| '''Deprecated'''. Use {{xt|1=|round=5}}
| Rounding and sigfig
|}<noinclude>
{{documentation}}
</noinclude>