మూస:Convert/doc: కూర్పుల మధ్య తేడాలు

చి cleanup
code
పంక్తి 1:
{{documentation subpage}}<!-- for stats: 673940 tc's on 2014-09-05 -->
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk|680.000}}}}
Template convert transclusions
{{Transwiki guide|text=See [[Template:Convert/Transwiki guide|'''how to copy this template''']] for information on copying this template and modifying it for use on another wiki.}}
Statistics on total tc's:
2014-09-05 673940
2014-12-16 693141
2015-01-28 700000
2015-08-31 736989
2016-05-25 789091
2016-11-17 832994
2017-07-29 872000
2017-12-15 902231
-->
{{hatnote|For currency conversion into US dollars, see [[Template:To USD]]}}
{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk| {{formatnum:900000}}+ }}}}
{{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 measurement unit (you can enter) to another one, and then ''presents'' the results formatted''. For example:
:<code><nowiki>{{convert|2|km|mi}}</nowiki></code> &rarr; {{convert|2|km|mi}} <small>(km entered, so converted into mile)</small>
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> &rarr; {{convert|7|mi|km}} <small>(mibr entered, so converted into km)</small>
 
The available '''units''' are listed [[#Units|below]].
''Numbers'' can be rounded, ''units'' can be abbreviated into symbols:
Multiple '''formatting''' and calculation options are listed below.
:<code><nowiki>{{convert|2|km|mi|2|abbr=on}}</nowiki></code> → {{convert|2|km|mi|2|abbr=on}}
:<code><nowiki>{{convert|7|mi|km|2|abbr=on}}</nowiki></code> → {{convert|7|mi|km|2|abbr=on}}
Value ''ranges'' can be entered using <code>|to|...</code> or <code>|-|...</code>:
:<code><nowiki>{{convert|2|to|5|km|mi}}</nowiki></code> → {{convert|2|to|5|km|mi}}
:<code><nowiki>{{convert|2|-|5|km|mi}}</nowiki></code> → {{convert|2|-|5|km|mi}}
 
{{hatnote|See also [[Help:Convert]] for more complete information}}
Combined effect example:
:<code><nowiki>{{convert|2|-|5|km|mi|2|abbr=on}}</nowiki></code> → {{convert|2|-|5|km|mi|2|abbr=on}}
:<code><nowiki>{{convert|2|and|5|km|mi|sigfig=3|abbr=off}}</nowiki></code> → {{convert|2|and|5|km|mi|sigfig=3|abbr=off}}
 
{{hatnote|See [[Help:Convert]] for more detailed, technical information}}
 
==Units to convert==
Enter units to convert:
* <code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}
:SI units generally accept prefixes, like "m" for micro (10<sup>&minus;3</sup>), and "M" for mega (10<sup>6</sup>)
:For "per" units, use "/" (slash): kg/ha
:For three-unit units etc.: see {{cl|Convert-like templates}}
 
==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
The "abbreviation" is actually the "symbol".
By default, the first quantity shows unit name, the second shows the symbol (or abbreviation):
{{para|abbr|on}} will produce the symbol of the unit, instead of its name:
* <code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}}
:<code><nowiki>{{convert|1|lb|kg}}</nowiki></code> &rarr; {{convert|1|lb|kg}} <small>(To compare, default)</small>
 
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> &rarr; {{convert|1|lb|kg|abbr=on}}
Using {{para|abbr|in}} is the ''reverse behaviour'' to the default:
*<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{convert|1|lb|kg|abbr=in}}
 
To abbreviate both or neither:
* <code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{convert|1|lb|kg|abbr=on}}
* <code><nowiki>{{convert|1|lb|kg|abbr=off}}</nowiki></code> → {{convert|1|lb|kg|abbr=off}}
 
When using scientific notation, the default is for the second (converted) quantity to be displayed using scientific notation:
* <code><nowiki>{{convert|100|e6mi|e6km}}</nowiki></code> → {{convert|100|e6mi|e6km}}
 
To display thousands, millions, etc., while abbreviating both input and output units use {{para|abbr|unit}}:
* <code><nowiki>{{convert|100|e6mi|e6km|abbr=unit}}</nowiki></code> → {{convert|100|e6mi|e6km|abbr=unit}}
 
===Convenience: {{tlf|cvt}} has {{para|abbr|on}} by default===
Template {{tl|cvt}} is the same as {{tlf|convert}}, except that it has {{para|abbr|on}} as the default behaviour. In {{tlf|cvt}}, all other options are available. So:
:<code><nowiki>{{cvt|1|lb|kg}}</nowiki></code> → {{cvt|1|lb|kg}}
is equivalent to:
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{cvt|1|lb|kg|abbr=on}}
 
==Adjective: ''a 10-mile distance''==
Use {{para|adj|on}} to produce the adjectival (hyphenated)adjective form. The difference:
* :<code><nowiki>A {{convert|10|mi|km|adj=on}} distanceto go</nowiki></code> → A&rarr; {{convert|10|mi|km|adj=on}} distanceto go. <small>(To compare, default)</small>
:<code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> &rarr; A {{convert|10|mi|km|adj=on}} distance. - Adjective
Default behaviour, for comparison:
* <code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> → {{convert|10|mi|km}} to go.
 
Even with {{para|abbr|on}}, as per [[MOS:UNITSYMBOLS|MoS]] no hyphen is produced with unit symbols.
 
=={{anchor|Rounding}}Rounding: ''100 ft'' is ''30&nbsp;m'' or ''30.5&nbsp;m'' or ''30.48&nbsp;m''?==
ByIn definitiondetail, 100&nbsp;ftit equalsis {{convert|100|ft|mmm|sigfig=45|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"
Line 82 ⟶ 35:
|'''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}} || same output as with 0 (below)
|-
|<code><nowiki>{{convert|123|ft|m|01}}</nowiki></code> || {{convert|123|ft|m|01}} ||
|-
|<code><nowiki>{{convert|123550|ft|m|10}}</nowiki></code> || {{convert|123550|ft|m|10}} || Approximate value is 167.64 m
|-
|<code><nowiki>{{convert|123550|ft|m|2}}</nowiki></code> || {{convert|123550|ft|m|2}} || exactRounds to 170, when approximate value is 37167.490464 m
|-
|<code><nowiki>{{convert|500|ft|m|-10}}</nowiki></code> || {{convert|500|ft|m|-10}} || Approximate value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|m}}</nowiki></code> || {{convert|500|ft|m}} || sameRounds outputto as150, withwhen -1approximate (above)value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|m|0}}</nowiki></code> || {{convert|500|ft|m|0}} ||
|-
|<code><nowiki>{{convert|500|ft|m|1}}</nowiki></code> || {{convert|500|ft|m|1}} ||
|-
|<code><nowiki>{{convert|500|ft|m|2}}</nowiki></code> || {{convert|500|ft|m|2}} || exact value is 152.4 m
|-
|<code><nowiki>{{convert|500|ft|cm}}</nowiki></code> || {{convert|500|ft|cm}} || different output as with 0 (below)
|-
|<code><nowiki>{{convert|500|ft|cm|0}}</nowiki></code> || {{convert|500|ft|cm|0}} ||
|}<!--NOTE: rows require "nowiki", using &#123;{ disappears. -->
 
''Convert'' supports four types of rounding:
 
===Round to a given precision: ''use a {{para|precision number|}}''===
Specify the desired precision with the ''fourth unnamed parameter'' (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest multiplepower of {{frac|10}} to the power of this number. For instance, if the result is 8621 and the round number is "-2", the result will be 8600. If the result is "234.0283043" and the round number is "0", the result will be 234.
 
===Round to a given number of significant figures: ''use {{para|sigfig|}}''===
To specify the output number to be with ''n'' significant figures use {{para|sigfig|&lt;number>}}:
* <codesmall>To compare:</small> <nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki></code> &rarr; {{convert|1200|ft|m|sigfig=4}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=34}}</nowiki></code> &rarr; {{convert|1200|ft|m|sigfig=34}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=23}}</nowiki></code> &rarr; {{convert|1200|ft|m|sigfig=23}}
* <code><nowiki>{{convert|1200|ft|m|sigfig=12}}</nowiki></code> &rarr; {{convert|1200|ft|m|sigfig=12}}
* <nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki> &rarr; {{convert|1200|ft|m|sigfig=1}}
Default behaviour, for comparison:
Setting {{para|sigfig|&lt;=0}} is meaningless
* <code><nowiki>{{convert|1200|ft|m}}</nowiki></code> → {{convert|1200|ft|m}}
* <nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki> &rarr; {{convert|1200|ft|m|sigfig=0}}
Setting {{para|sigfig}} to a value less than 1 is meaningless:
* <code><nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki></code> → {{convert|1200|ft|m|sigfig=0}} {{nay}}
 
===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
Using {{para|round|5}} rounds the outcome to a multiple of 5.
* :<code><nowiki>{{convert|10|m|ft}}</nowiki></code> &rarr; {{convert|10|m|ft}}
* :<code><nowiki>{{convert|10|m|ft|round=5}}</nowiki></code> &rarr; {{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> &rarr; {{convert|10|m|ft}}
* :<code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> &rarr; {{convert|10|m|ft|round=25}}
:<small>To compare:</small> <code><nowiki>{{convert|10|m|ft|sigfig=4}}</nowiki></code> &rarr; {{convert|10|m|ft|sigfig=4}}
Default behaviour, for comparison:
* <code><nowiki>{{convert|10|m|ft|sigfig=4}}</nowiki></code> → {{convert|10|m|ft|sigfig=4}}
 
In a range, one can round ''each value'' individually to the default. Use {{para|round|each}}:
* :<code><nowiki>{{convert|10 x 200 x 3000|m|ft}}</nowiki></code> &rarr; {{convert|10 x 200 x 3000|m|ft}}
* :<code><nowiki>{{convert|10 x 200 x 3000|m|ft|round=each}}</nowiki></code> &rarr; {{convert|10 x 200 x 3000|m|ft|round=each}}
 
===<span id="Round to a multiple of a given fraction"></span>Round to a multiple of a given fraction: ''{{frac|2|31|164}} inch''===
Specify the desired ''denominator'' using {{para|frac|&lt;some positive integer&gt;}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|3}}).
* :<code><nowiki>{{convert|5.566|cm|in|frac=162}}</nowiki></code> &rarr; {{convert|5.566|cm|in|frac=162}}
* :<code><nowiki>{{convert|86|cm|in|frac=4}}</nowiki></code> &rarr; {{convert|86|cm|in|frac=4}}
:<code><nowiki>{{convert|6|cm|in|frac=100}}</nowiki></code> &rarr; {{convert|6|cm|in|frac=100}}
The fraction is reduced when possible:
*:<small>To compare:</small> <code><nowiki>{{convert|86|cm|in|frac=100}}</nowiki></code> &rarr; {{convert|86|cm|in|fracsigfig=1004}}
Default behaviour uses decimal notation:
* <code><nowiki>{{convert|5.56|cm|in}}</nowiki></code> → {{convert|5.56|cm|in}}
 
==={{anchor|Rounding temperatures}}Rounding temperatures: ''°&deg;C'', ''°&deg;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.
:<code><nowiki>{{convert|10|C|F K}}</nowiki></code> &rarr; {{convert|10|C|F K}}
''Note''
:For a temperature ''difference'', like to convert "A rise of 20 &deg;C", use {{para|C-change|20}} &tc.
:<code><nowiki>{{convert|20|C-change|F-change K-change}}</nowiki></code> &rarr; A rise of {{convert|20|C-change|F-change K-change}}
 
:<small>To compare: "A temperature of 20 &deg;C" would yield: A temperature of {{convert|20|C|F K}}</small>
#{{#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 five significant output digits because of the two digits after the decimal point, generated by the Kelvins conversion. This happened again in (5), but in (6) decimal fractions were neither given as input nor induced by the Kelvins conversion.
 
===Rounding input===
There is limited support for rounding the displayed ''input'' number. The rounding tales place ''after'' conversion, so the output is based on the full-precision input. This is useful when the input is produced by {{tlc|&#35;expr:}} or otherwise available to a higher precision than is usefully displayed, and it's desirable to avoid double-rounding.
 
To round the input to a specified number of digits after the decimal point, use one of the parameters:
* {{para|adj|ri0}}
* {{para|adj|ri1}}
* {{para|adj|ri2}}
* {{para|adj|ri3}}
Note that there is no {{para|adj|ri-1}}{{nay}} or similar for rounding above the decimal place. Neither is there support for significant figures, multiples of 5, or any other output-rounding feature.
 
The default precision is computed based on the input, so an explicit output precision must usually be supplied:
* {{tlc|convert|4.14159|mi|km|adj{{=}}ri0}} → {{convert|4.14159|mi|km|adj=ri0}} {{nay}} (precisions are mismatched)
* {{tlc|convert|4.14159|mi|km|0|adj{{=}}ri0}} → {{convert|4.14159|mi|km|0|adj=ri0}} {{aye}}
 
In this case, if the input were rounded before conversion, a different result would be obtained:
* {{tlc|convert|<nowiki>{{#expr:4.14159 round 0}}</nowiki>|mi|km|0}} → {{convert|{{#expr:4.14159 round 0}}|mi|km|0}} {{nay}} (double rounding)
 
==Into multiple units: ''{{convert|10|C|F K}}''==
Separate the multiple output units by a space:
* :<code><nowiki>{{convert|10|C|F K}}</nowiki></code> &rarr; {{convert|10|C|F K}}
* :<code><nowiki>{{convert|5|km|mi nmi}}</nowiki></code> &rarr; {{convert|5|km|mi nmi}}
If the output unit names contain spaces, use <code>+</code> as the separator.
 
See also:
* For multiple-unit options like ''1 ft 5 in'', see {{section link||In input}} and {{section link||In output}}.
 
==Ranges of values==
{{For|a conversion of a difference|#Units of difference}}
A ''range'' converts ''two'' values and separates them by your choice of words and punctuation.
 
===A range: ''6 to 17 kg (13 to 37 lb)''===
Range indicators are entered as the second parameter (between the values). Range separators can be:<br />
{{Convert/doc/range separator list}}
 
===Multiple dimensions: ''{{convert|6|x| by 12| feet (1.8 by 3.7 m|ft|abbr=on}})''===
:<code><nowiki>{{convert|6|by|12|ft|m}}</nowiki></code> &rarr; {{convert|6|by|12|ft|m}}
Use <code>by</code>:
* :<code><nowiki>{{convert|6|byx|12|m|ft|m}}</nowiki></code> &rarr; {{convert|6|byx|12|ft|m|ft}}
This is the correct way in science, using <code>&#x7c;x&#x7c;</code> and {{para|abbr|on}}
 
:<code><nowiki>{{convert|6|x|12|m|ft|abbr=on}}</nowiki></code> &rarr; {{convert|6|x|12|m|ft|abbr=on}}
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>&#x7c;x&#x7c;</code> and {{para|abbr|on}} (keeping dimensions right, like in ''area = x km<sup>2</sup>''):
* <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> &rarr; {{convert|1|ft|3|in|x|3|ft|5|in|mm}} {{nay}}<small>(to compare)</small>
* <code><nowiki>{{convert|1|ft|3|in|x|3|ft|5|in|mm}}</nowiki></code> &rarr; {{convert|1|ft|3|in|x|3|ft|5|in|mm}}
Default behaviour, for comparison:
* <code><nowiki>{{convert|1|ft|3|in|mm}}</nowiki></code> → {{convert|1|ft|3|in|mm}}
 
==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> &rarr; {{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> &rarr; {{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> &rarr; {{convert|10|mi|m|spell=In}}
* :<code><nowiki>{{convert|10|mi|m|spell=On}}</nowiki></code> &rarr; {{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> &rarr; {{convert|10|mi|m|spell=on|abbr=off|sp=us}}
 
===InsertedSpelling beforeof units: UK ''4metre'' plantedor acresUS ''meter''?===
Default spelling of units is en-UK. To show en-US spelling, use {{para|sp|us}}:
*<code><nowiki>{{convert|4|acre||adj=pre|planted}}</nowiki></code> → {{convert|4|acre||adj=pre|planted}}
:<code><nowiki>{{convert|1|m|ft}}</nowiki></code> &rarr; {{convert|1|m|ft}} -- ''default''
<code>disp=preunit</code> is similar, but has no separator after the specified text, and can have different text for the output value:
*:<code><nowiki>{{convert|41|acrem|ft|dispsp=preunit|planted us}}</nowiki></code> &rarr; {{convert|41|acrem|ft|dispsp=preunit|planted us}}
*<code><nowiki>{{convert|4|acre||disp=preunit|planted |reforested-}}</nowiki></code> → {{convert|4|acre||disp=preunit|planted |reforested-}}
 
===Extra words: ''4 planted acres'' ===
===After adjective unit: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
:''Incomplete section''
:<code><nowiki>{{convert|10|ft|m|adj=mid|-long}}</nowiki></code> → {{convert|10|ft|m|adj=mid|-long}}
:<code><nowiki>{{convert|4|acre||adj=pre|planted}}</nowiki></code> &rarr; {{convert|4|acre||adj=pre|planted}}
 
===Extra adjective words: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
===Plurals: ''1&nbsp;inch, 2&nbsp;inches''===
:<code><nowiki>{{convert|4|ft|m|adj=mid|-long}}</nowiki></code> &rarr; {{convert|10|ft|m|adj=mid|-long}}
The unit symbol is singular always. Depending on the preceding number only, a unit name can be shown plural.
* <code><nowiki>{{convert|1|metre}}</nowiki></code> → {{convert|1|metre}}
* <code><nowiki>{{convert|2|metre}}</nowiki></code> → {{convert|2|metre}}
* <code><nowiki>{{convert|2|metre|abbr=on}}</nowiki></code> → {{convert|2|metre|abbr=on}}
 
===Grammatical construction: ''The 18-, 24- and 32-pounder (8, 11 and 15 kg) cannons'' ===
;Exception:
This example is from article [[Fort McHenry#19th_Century|Fort McHenry]]:
Entering the unit spelled <code>|foot|</code> forces singular output "foot", whatever the number is.
{{quotation|The American defenders had 18-, 24- and 32-pounder (8,&nbsp;11&nbsp;and 15&nbsp;kg) cannons.}}
* <code><nowiki>{{convert|100|foot|abbr=off}}</nowiki></code> → {{convert|100|foot|abbr=off}}
This formatted result is not possible straightforward by using {{tlf|convert}}. However, it can be made in three steps.
:'''Step 1:''' Enter the input numbers and units in {{tlf|convert}} just to get the calculated output:
:*<code><nowiki>had {{convert|18 |, |24 |, |32 |lb |kg |0 }} cannons</nowiki></code>
::&rarr; had {{convert|18 |, |24 |, |32 |lb |kg |0 }} cannons
:The core conversion should look good now. You can save this (or preview).
:'''Step 2:''' We need the resulting text in plain code in the page, not as a {{tlf|convert|...}} template.
:For this, '''add&nbsp;<code>subst:</code> to the template name''' (for 'substitute') :
:*<code><nowiki>had {{</nowiki>{{purple|'''subst:'''}}<nowiki>convert|18 |, |24 |, |32 |lb |kg |0 }} cannons</nowiki></code>
:As a check: the preview result should show the conversion correct, with the numbers still right.
:'''Now save this'''.
::&rarr; had 18,&nbsp;24,&nbsp;32 pounds (8,&nbsp;11,&nbsp;15&nbsp;kg) cannons
:'''Step 3:''' When opening the edit screen again, you'll see that the text is there in code. The template {{tlf|convert|...}} itself has disappeared. You can change the text as needed. The edit screen text is:
::<code><nowiki>had 18,&amp;nbsp;24,&amp;nbsp;32 pounds (8,&amp;nbsp;11,&amp;nbsp;15&amp;nbsp;kg) cannons</nowiki></code>
:You can edit this text to add the grammar:
:*<code>had 18{{red|-}},{{red|_}}24{{red|-_and_}}32{{red|-}}pound{{red|er}} (8,&amp;nbsp;11{{red|_and_}}15&amp;nbsp;kg) cannons </code>
:After saving your edit, it shows:
::&rarr; "had 18-, 24- and 32-pounder (8,&nbsp;11&nbsp;and 15&nbsp;kg) cannons".
 
== Numbers ==
===Fractions: ''one-eighth of an imperial pint''===
=== Using SI prefixes: ''gigameter (Gm), micrometer (μm)'' ===
The convert template also supports spelling out fractions.
* <code><nowiki>{{convert|3+1/2|oz|g|spell=in}}</nowiki></code> → {{convert|3+1/2|oz|g|spell=in}}
Any additional words needed for the fraction can also be added at the end of the template.
* <code><nowiki>{{convert|1/8|imppt|ml|spell=in|adj=pre|of an}}</nowiki></code> → {{convert|1/8|imppt|ml|spell=in|adj=pre|of an}}
<!-- todo: decimals & negative examples -->
 
===Wrapping and line breaking===
:See {{section link|Help:Convert|Wrapping and line breaking}}
 
==Numbers==
 
===Using an SI prefix: ''gigameter (Gm)'', or ''micrometer (&#x03BC;m)''===
{{Sidebar metric prefixes (small)}}
Units can have an [[metric prefix|SI prefixprefixes]] like: <code>G, k, m, &mu;</code> beforefor giga-, kilo-, milli-, micro- multiplication factors. The symbol (letter) is added to the unit: <code>Gm</code>, andthe <code>giga</code>word is added beforeto the name: <code>gigameter</code>.Gm Theseand are plain multiplication factorsgigameter.
 
To illustrate, these are trivial calculations (from meter to meter), showingdisplaying the multiplication factor:
* {{convert|12|Gm|m|abbr=on}}
* {{convert|12|μm|m|abbr=on}}
 
The prefix can be added before thean SI unit (here: unit <code>m</code> for meter):
* <code><nowiki>{{convert|12|Gm|mi|abbr=on}}</nowiki></code> &rarr; {{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>&#x03BC;mμm</code>: {{convert|12|μm|mm|abbr=on}}
* <code>um</code>: {{convert|12|um|mm|abbr=on}} (letter "u" can be used for "&#x03BC;μ" here)
 
The prefix can be used in the output unit:
* <code><nowiki>{{convert|12000|mi||Mm|abbr=on}}</nowiki></code> &rarr; {{convert|12000|mi|Mm|abbr=on}}
* <code><nowiki>{{convert|12|in|μm|abbr=on}}</nowiki></code> &rarr; {{convert|12|in|μm|abbr=on}}
 
As an exception, the non-SI unit "inch" can have the "&#x03BC;" prefix too)
* <code><nowiki>{{convert|12|&#x03BC;m|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}
 
{{further information|Help:Convert units#SI prefixes}}
 
===Engineering notation: ''7 × 10<sup>6</sup> m''===
 
====In the unit: ''e6m''====
[[Engineering notation|Engineering number notations]] like ''7{{smallcaps|E}}6'' (for 7 × 10<sup>6</sup>) 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}}
 
AnyAs standardan unit (not a combinationexception, multiple,the or builtnon-inSI unit) inch can have suchthe a"μ" prefix: too)
* <code><nowiki>{{convert|12|μm|μin|abbr=on}}</nowiki></code> &rarr; {{convert|12|μm|μin|abbr=on}}
* <code>e3</code> (thousand),
* <code>e6</code> (million),
* <code>e9</code> (billion),
* <code>e12</code> (trillion),
* <code>e15</code> (quadrillion).
 
===Scientific notation: ''1.23 × 10<sup>−14</sup>''===
In [[scientific notation]], a number is written like {{rnd|12.3e-15|16}}. The plain number has exactly one digit before the decimal point.
 
:{{further|Help:Convert units#SI prefixes}}
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}}
Also the fraction slash (<code>⁄</code>) is accepted:
*<code><nowiki>{{convert|1⁄2|in|mm|1}}</nowiki></code> → {{convert|1⁄2|in|mm|1}}
:<code><nowiki>{{convert|1⁄2|in|mm|1}}</nowiki><code> → {{convert|1⁄2|in|mm|1}}
With integers, use a <code>+</code> sign
:<code><nowiki>{{convert|2+1⁄2|in|mm|1}}</nowiki><code> → {{convert|2+1⁄2|in|mm|1}}
When negative, use a hyphen <code>-</code> and repeat it:
:<code><nowiki>{{convert|-2-1⁄2|in|mm|1}}</nowiki><code> → {{convert|-2-1⁄2|in|mm|1}}
:<code><nowiki>{{convert|2-1⁄2|in|mm|1}}</nowiki><code> → {{convert|2-1⁄2|in|mm|1}} Note: this is read as a range
:<code><nowiki>{{convert|-2+1⁄2|in|mm|1}}</nowiki><code> → {{convert|-2+1⁄2|in|mm|1}} {{nay}} Should be a number, not an expression (do not require a calculation)
 
===Input in engineering notation: ''7 &times; 10<sup>6</sup> m''===
With positive [[mixed number]]s (a positive integer and a fraction), use a <code>+</code> sign
[[Engineering notation|Engineering number notations]] like ''7{{smallcaps|E}}6'' (for 7 &times; 10<sup>6</sup>) are to be entered as a prefix <code>e''n''</code> to the unit:
*<code><nowiki>{{convert|2+1⁄2|in|mm|1}}</nowiki></code> → {{convert|2+1⁄2|in|mm|1}}
:<code><nowiki>{{convert|7|e6m}}</nowiki></code> → {{convert|7|e6m}}
Any standard unit (not a combination, multiple, or built-in) can have a prefix:
:<code>e3</code> (thousand), <code>e6</code> (million), <code>e9</code> (billion), <code>e12</code> (trillion), <code>e15</code> (quadrillion).
 
===Output with horizontal fraction bar in: ''{{sfrac|1|2}}&nbsp;inch'' ===
With negative mixed numbers, use a hyphen <code>-</code> and repeat it:
<!-- techinical restriction: TOC does not show the example horizontal bar intended here; rephrased section title-->
*<code><nowiki>{{convert|-2-1⁄2|in|mm|1}}</nowiki></code> → {{convert|-2-1⁄2|in|mm|1}}
 
Note that the following cases are not interpreted as mixed numbers:
*<code><nowiki>{{convert|2-1⁄2|in|mm|1}}</nowiki></code> → {{convert|2-1⁄2|in|mm|1}}. This is interpreted as a range from 2 inches to 1⁄2 inch.
*<code><nowiki>{{convert|-2+1⁄2|in|mm|1}}</nowiki></code> → {{convert|-2+1⁄2|in|mm|1}} {{nay}} This is neither a mixed number nor a range, and mathematical expressions requiring calculations are not allowed here.
 
===Output with horizontal fraction bar in: ''{{sfrac|1|2}}&nbsp;inch''===
<!-- technical restriction: TOC does not show the example horizontal bar intended here; rephrased section title-->
Using a double slash (<code>//</code>) 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}}
 
== Output manipulation ==
===Thousands separator: ''1,000 mi'' or ''1000 mi''===
In input, a comma for thousands separator is accepted but not required; a gap (space) is not accepted. In output, by default, the thousand separator is the comma:
* <code><nowiki>{{convert|1234567|m|ft}}</nowiki></code> → {{convert|1234567|m|ft}}
* <code><nowiki>{{convert|1,234,567|m|ft}}</nowiki></code> → {{convert|1,234,567|m|ft}}
* <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}} will only add the separator when the number of digits is 5 or more:
* <code><nowiki>{{convert|1234|m|ft|comma=5}}</nowiki></code> → {{convert|1234|m|ft|comma=5}}
* <code><nowiki>{{convert|1234567|m|ft|comma=5}}</nowiki></code> → {{convert|1234567|m|ft|comma=5}}
Default behaviour, for comparison:
* <code><nowiki>{{convert|1234|m|ft}}</nowiki></code> → {{convert|1234|m|ft}}
 
==Output manipulation==
===Brackets and separators: ''10 m [33 ft]''===
Punctuation that distinguishes the two measurements is set by {{para|disp|}}.<br />
Options are: <code>b</code> <small>(the default)</small>, <code>sqbr</code>, <code>comma</code>, <code>or</code>, <code>br</code>, <code>x{{!}}...</code>:
* :<code><nowiki>{{convert|10|m|ft|disp=sqbr}}</nowiki></code> &rarr; {{convert|10|m|ft|disp=sqbr}} -- ''(&nbsp;) brackets are the default''
* :<code><nowiki>{{convert|10|m|ft|disp=commasqbr}}</nowiki></code> &rarr; {{convert|10|m|ft|disp=commasqbr}}
* :<code><nowiki>{{convert|10|m|ft|disp=orcomma}}</nowiki></code> &rarr; {{convert|10|m|ft|disp=orcomma}}
:<code><nowiki>{{convert|10|m|ft|disp=or}}</nowiki></code> &rarr; {{convert|10|m|ft|disp=or}}
Default behaviour, for comparison:
* <code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
 
Setting {{para|disp|br}} will force a new line (<code>&lt;br/></code>)
* <code><nowiki>{{convert|10|m|ft|disp=br}}</nowiki></code> → {{convert|10|m|ft|disp=br}}
 
:<code><nowiki>{{convert|10|m|ft|disp=br}}</nowiki></code> &rarr; {{convert|10|m|ft|disp=br}}
Also {{para|disp|br()}} will force a new line, and keep the brackets (useful in tables):
Setting {{para|disp|x{{!}}...}} allows any text as separator:
* <code><nowiki>{{convert|10|m|ft|disp=br()}}</nowiki></code> → {{convert|10|m|ft|disp=br()}}
 
:<code><nowiki>{{convert|10|m|ft|disp=x|_MyText_}}</nowiki></code> &rarr; {{convert|10|m|ft|disp=x|_MyText_}} -- <small>(To display spaces, use <code>&amp;nbsp;</code>)</small>
Setting {{para|disp|x{{!}}…}} allows any text as separator:
* <code><nowiki>{{convert|10|m|ft|disp=x|_MyText_}}</nowiki></code> → {{convert|10|m|ft|disp=x|_MyText_}} <small>(To display spaces, use <code>&amp;nbsp;</code>)</small>
<!--todo: works for multiple freetexts too! |disp=x|TextA|TextB -->
 
===Flipping (reordering) the two measurements: ''{{convert|1|mi|m|order=flip|sigfig=5|abbr=off}}'' ===
Setting {{para|order|flip}} will flip (swap) the two measurements:
*:<code><nowiki>{{convert|1|mi|m}}</nowiki></code> &rarr; {{convert|1|mi|m|sigfig=5|abbr=off}} <small>(To compare, default)</small>
:<code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> &rarr; {{convert|1|mi|m|order=flip|sigfig=5|abbr=off}}<!-- Extra settings added to enhance the illustration. Don't know if this is ideal way of documenting. DePiep, August 2014. --></small>
Default behaviour, for comparison:
* <code><nowiki>{{convert|1|mi|m}}</nowiki></code> → {{convert|1|mi|m|sigfig=5|abbr=off}}
 
When converting to multiple units, the effect is:
* :<code><nowiki>{{convert|10|km|mi nmi|order=flip}}</nowiki></code> &rarr; {{convert|10|km|mi nmi|order=flip|sigfig=5|abbr=off}}
* :<code><nowiki>{{convert|10|km|nmi mi|order=flip}}</nowiki></code> &rarr; {{convert|10|km|nmi mi|order=flip|sigfig=5|abbr=off}}
 
=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
Line 392 ⟶ 247:
! Convert !! Output !! Description
|-
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}} || Default, to compare
| Default behaviour, for comparison
|-
| <code><nowiki>{{convert|2|cuyd|m3|abbr=values}}</nowiki></code> || {{convert|2|cuyd|m3|abbr=values}} || Input and output numbers
| {{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
| 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)
| 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''. {{nowrap|1=Note repetition of unit in input}})
|-
| <code><nowiki>{{convert|2|cuyd|m3|abbr=~}}</nowiki></code> || {{convert|2|cuyd|m3|abbr=~}}
| Input: both name and symbol
|-
| <code><nowiki>{{convert|2|cuyd|m3|disp=unit2}}</nowiki></code> || {{convert|2|cuyd|m3|disp=unit2}} || Output unit (symbol)
Line 413 ⟶ 261:
| <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
| Output value
|-
| <code><nowiki>{{convert|2|cuyd|m3|disp=out}}</nowiki></code> || {{convert|2|cuyd|m3|disp=out}} || Output value and unit
| 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()}}
|-
| <code><nowiki>{{convert|2|cuyd|m3|abbr=off|disp=out}}</nowiki></code> || {{convert|2|cuyd|m3|abbr=off|disp=out}} || Output value and unit
|{{convert|100|km|mi|disp=br}}
|{{convert|100|km|mi|disp=br()}}
|}
 
=== Table columns showing numbersoptions only===
For the [[Help:Table/Manual tables|wikitable]] structure, there are two options: split over columns and make the table sortable.
=== Show numbers only in columns in a table ===
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> &rarr; {{convert|10|m|ft|disp=table}}
::<code>{{convert|10|m|ft|disp=table}}</code>
 
{{para|disp|tablecen}} does the same, and also centers the text:
:<code><nowiki>{{convert|20|m|ft|disp=tablecen}}</nowiki></code> &rarr; {{convert|20|m|ft|disp=tablecen}}
::<code>{{convert|20|m|ft|disp=tablecen}}</code>
 
The units are added as a column header:
Line 467 ⟶ 293:
|}
 
=== Sorting ===
:Use both {{para|disp|table}} {{para|sortable|on}} to produce table columns (pipe symbols), with sortable table column. As of January 2013, only the first (lefthand) column will sort (improvements pending).
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=→ &lt;span style="display:none">}}7001100000000000000<wbr />&lt;/span>10 metres (33&amp;nbsp;ft)
 
:<nowiki>{{convert|10|m|ft|disp=table|sortable=on}}</nowiki> &rarr;
Use both {{para|disp|table}} and {{para|sortable|on}} together to produce table columns (pipe symbols) for each value in sortable columns:
<code>{{nowrap|{{convert|10|m|ft|disp=table|sortable=on}}}}</code>
:This shows the hidden numerical sortkey:
<code>align="right"|&lt;span style="display:none">7001100000000000000&lt;/span>10 |align="right"|33</code>
 
:{| 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==
{{selfref|See also: complete [[Template:Convert/list of units|Convert/list of 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}}
 
==={{anchor|Units of difference}}Units of difference: Expressing a change or difference in temperature===
We have already discussed standard temperature conversions (°C, °F, K), as shown in these two examples:
* {{#invoke:DemoTemplate|convert|10|C}} (standard temperature conversion)
* {{#invoke:DemoTemplate|convert|10-15|C}} (standard temperature range conversion)
 
When expressing a temperature ''change'' (e.g., "The temperature ''increased'' by 10&nbsp;°C"), or when ''comparing'' temperatures (e.g., "10 to 15&nbsp;°C ''warmer''"), we cannot use the standard temperature units ({{para||C}}, {{para||F}} and {{para||K}}). Instead, we must use one of the following "units of difference": {{para||C-change}}, {{para||F-change}} and {{para||K-change}}.
 
Compare the following two examples with the two above:
 
* {{#invoke:DemoTemplate|convert|10|C-change}} increase in temperature
* {{#invoke:DemoTemplate|convert|10-15|C-change}} warmer than normal
 
To produce multiple units in the output:
* {{#invoke:DemoTemplate|convert|10|C-change|F-change K-change}} difference
 
===Multiple units: ''1 ft 5 in''===
====In input====
Base document {{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
<!-- todo: mention the 0-3 limits -->
 
===Currency per unit: ''$/mi &rarr; $/km''===
Using currency symbols in a ''$ per unit'' value, you can convert the per-unit:
* <code><nowiki>{{convert|10|$/mi|$/km}}</nowiki></code> → {{convert|10|$/mi|$/km}}
 
You can set the currency in ''both'' values using {{para|$|€}}:
* <code><nowiki>{{convert|10|$/mi|$/km|$=€}}</nowiki></code> → {{convert|10|$/mi|$/km|$=€}}
 
It is ''not'' possible to convert the currency. So, this result (mixed currencies) is ''not'' possible: {{!mxt|1=$15 per mile (€8.6/km)}} {{nay}}
 
==Using convert inside templates==
For usage in template code, like infoboxes, {{tlf|Convert}} has these options:
;Pre-formatting fraction input
* [[Module:Convert/helper]] can read regular input and pre-format it into {{tlf|Convert}}-accepted input.
:Your template can accept {{para|input|16 7/8}} and use <nowiki>{{#invoke:Convert/helper|number|16 7/8}}</nowiki> &rarr; {{#invoke:Convert/helper|number|16 7/8}}
 
;Using a Wikidata property
* Adding the Wikidata property code, like code {{para|input|P2073}}, to your template code automatically returns the Wikidata property for that article, and convert it. Both number and unit are read.
Note: to return that property value for an ''other'' article, use {{para|qid}}.
 
Example for {{Wikidata property link|P2073}}:
Note: this example uses {{para|qid|Q1056131}} (testing for {{Wikidata entity link|Q1056131}})
* <code><nowiki>{{convert|input=P2073|qid=Q1056131|ftin|abbr=on}}</nowiki></code> &rarr; {{convert|input=P2073|qid=Q1056131|ftin|abbr=on}}
* <code><nowiki>{{convert|input=P2073|qid=Q1056131|km|abbr=on}}</nowiki></code> &rarr; {{convert|input=P2073|qid=Q1056131|km|abbr=on}}
* <code><nowiki>{{convert|input=P2073|qid=Q1056131|km|abbr=on|disp=out}}</nowiki></code> &rarr; {{convert|input=P2073|qid=Q1056131|km|abbr=on|disp=out}}
:For example see [[template:Infobox Telescope]].
 
==Parameter list==
Line 569 ⟶ 324:
 
==Deprecated options==
Deprecated options should not be used. There is no guarantee that they will be supported in the future.
{{Convert/doc/deprecations list}}
<!-- see for example [[Template_talk:Convert/Archive_September_2014#Next_grand_step:_.7Bconvert.7D_3.0]] -->
* {{!xt|1=disp=slash}}, {{!xt|1=disp=s}}, {{!xt|1=disp=/}} are deprecated. Use {{xt|1=disp=or}} instead
* {{!xt|1=disp=flip}}, {{!xt|1=adj=flip}} are deprecated. Use {{xt|1=order=flip}} instead
* {{!xt|1=disp=flip5}} is deprecated. Use {{xt|1=order=flip}} {{xt|1={{!}}round=5}} instead
* {{!xt|1=disp=5}}, {{!xt|1=near=5}}, is deprecated. Use {{xt|1=round=5}} instead
* {{!xt|1=abbr=comma}} is deprecated. Use {{xt|1=adj=nocomma}} instead
* {{!xt|1=disp=2}} is deprecated. Use {{xt|1=disp=output only}} instead
* {{!xt|1=disp=u2}} is deprecated. Use {{xt|1=disp=unit2}} instead
* {{!xt|1=abbr=mos}} is deprecated (not [[MOS:UNITS|MOS]]). Use range separator {{xt|<nowiki>|by|</nowiki>}} ''or'' {{xt|<nowiki>|x|</nowiki>}} instead
* Range separator {{!xt|<nowiki>|xx|</nowiki>}} is deprecated (not [[MOS:UNITS|MOS]]). Use {{xt|<nowiki>|x|</nowiki>}} instead
* Range separator {{!xt|<nowiki>|*|</nowiki>}} is deprecated (not [[MOS:UNITS|MOS]]). Use {{xt|<nowiki>|x|</nowiki>}} instead
* Range separator {{!xt|<nowiki>|to-|</nowiki>}} is deprecated. Use {{xt|<nowiki>|to(-)|</nowiki>}} instead
 
==TemplateData==
{{TemplateDataHeader}}
 
<templatedata>{
"description": "Converts measurements to other units.",
{
"params": {
"description": "Converts measurements to other units.",
"params1": {
"1label": {"value",
"description": "the value to convert",
"label": "Value",
"type": "number"
"description": "The value to convert.",
},
"type": "number",
"required2": true{
"label": "from unit",
},
"description": "",
"2": {
"labeltype": "From unitstring/line",
},
"description": "The unit for the provided value.",
"3": {
"type": "string/line",
"examplelabel": "kmto units",
"description": "",
"required": true
"type": "string/line"
},
},
"3": {
"4": {
"label": "To units",
"label": "precision or suffix",
"description": "The units to convert into. Separate units by a space for multiple outputs. In an output unit, use + for a multiplication space.",
"description": "significant digits after decimal dot or, if negative, exponent of ten",
"type": "string",
"exampletype": "mi nminumber",
},
"suggested": true
"lk": {
},
"label": "link units",
"4": {
"description": "“on” all, “in” input, “out” output or “off” no units",
"label": "Precision or suffix",
"default": "off",
"description": "Significant digits after decimal dot or, if negative, exponent of ten.",
"type": "numberstring/line"
},
"lkabbr": {
"label": "Link unitsabbreviation",
"description": "Indicationdisplay offor whatthe units: to“on” applyunit wikilinkssymbols, to.“off” Useall “on”unit fornames allin full words, “in” for the input unit symbol, “out” for theabbreviated output units, or“values” “off”no forunits noneat of the units.all",
"default": "offout",
"type": "string/line",
},
"example": "on"
"sp": {
},
"label": "spelling",
"abbr": {
"description": "“us” display U.S. spelling of unit names",
"label": "Abbreviation",
"type": "string/line"
"description": "Display for the units: “on” to display all units using their unit symbols, “off” to display all units in full words, “in” to display the unit symbol for the input unit, “out” to display the unit symbols for the output units, “unit” to display unit symbols for both input and output units when using scientific notation, “values” for no units at all (neither unit symbols nor full words of units).",
},
"default": "out",
"typeadj": "string"{
"label": "adjective",
},
"description": "adjective form (singular unit name appended by hyphen) “on” or “mid” to put conversion at end",
"sp": {
"labeltype": "Spellingstring/line",
},
"description": "Spelling of units. Use “us” to display unit names using U.S. spelling.",
"disp": {
"type": "string",
"examplelabel": "usconversion",
"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",
},
"adjdefault": {"b",
"labeltype": "Adjectivestring/line",
},
"description": "Whether to use adjectival form. Use “on” for singular unit name appended by a hyphen, “mid” to put conversion at end, or “off” (default) for no adjectival form.",
"order": {
"type": "boolean",
"examplelabel": "onordering",
"description": "“flip” returns converted value first, input value second.",
"default": "off"
"type": "string/line"
},
},
"disp": {
"sigfig": {
"label": "Conversion",
"label": "significant figures",
"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.",
"description": "number that sets the number of significant figures",
"type": "string",
"exampletype": "bnumber"
},
"orderround": {
"label": "Orderingrounding 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",
"description": "“flip” returns converted value first, input value second.",
"type": "string/line",
},
"example": "flip"
"sortable": {
},
"label": "sort key",
"sigfig": {
"description": "“on” generates a hidden sort key",
"label": "Significant figures",
"type": "string/line"
"description": "Indicates the number of significant figures to be used in rounding.",
"type": "number"
},
"round": {
"label": "Rounding output",
"description": "The type of rounding. “5” rounds the output number to nearest multiple of 5, “25” to nearest multiple of 25, “each” rounds each number in a range.",
"type": "number"
},
"comma": {
"label": "Thousands separator",
"description": "Sets or suppresses the use of thousands separators in the numbers. “off”: no separator; “gaps”: use space instead of comma as thousands separator; “5” and “gaps5”: only add thousands separator when the integral part of the number uses 5 positions or more (10,000 or more; if using comma as thousands separator, 1234 would produce '1234', 12345 would produce '12,345').",
"default": "on",
"type": "string",
"example": "off"
},
"sortable": {
"label": "Sort key",
"description": "“on” generates a hidden sort key",
"type": "string",
"example": "on"
},
"spell": {}
},
"format": "inline"
}
}}</templatedata>
<!--''to be added''
==Glossary==
:''to be added''
;unit code
:
;unit symbol
:
-->
 
==See also==
* [[Template:Convert/old]]&nbsp;— Version as used until December 2013
* {{Temp|Cvt}}
* [[Template:Convert/units not supported]]
* {{Temp|SI units}}
* [[:Category:Convert error categories]]
{{Convert navs}}
{{Math templates|conversion}}<noinclude>
[[Category:Convert by module documentation| ]]
</noinclude><includeonly>{{#ifeq:{{SUBPAGENAME}}|doc||
[[Category:Convert templates| ]]
[[Category:Conversion templates]]
[[Category:Numbers as words conversion templates]]
</includeonly>
[[Category:Sorting templates]]
}}</includeonly>
"https://te.wikipedia.org/wiki/మూస:Convert/doc" నుండి వెలికితీశారు