Changes

Jump to: navigation, search

Template:Convert/doc

26,057 bytes removed, 18:28, 29 February 2020
no edit summary
{{documentation subpage}}<!--Template convert transclusionsStatistics === Units of measurement usage on total tc's:2014-09-05 6739402014-12-16 6931412015-01-28 7000002015-08-31 7369892016-05-25 7890912016-11-17 8329942017-07-29 8720002017-12-15 9022312018-12-27 9577702019-01-12 9607692019-10-26 9951522019-01-01 by TDmonthly error report: Page [article] count: 651064; Transclusion count: 2878293-->{{hatnote|For currency conversion into US dollars, see [[Template:To USD]]}}{{#ifeq:{{FULLPAGENAME}}|Template:Convert|{{high-risk| {{formatnum:995000}}+ }}}}{{Transwiki guide |smallWikivoyage =yes |text=See [[Template:Convert/Transwiki guide|'''this information''']] on copying this template =Format and modifying it conventions used for use on another wiki.}}{{Lua|Module:Convert}}'''Template {{tl|convert}}''' ''calculates'' from one measurement unit to another one, and then ''presents'' the results formatted. The complete list of unit symbols recognized by the template is units can be found at [[ModuleWikivoyage:Convert/documentation/conversion dataMeasurements]].
For example::<code><nowiki>{{convert|2|km|mi}}</nowiki></code> → {{mile|2|km|mi}} <small>(km enteredTo ensure units are displayed correctly, so converted into mile)</small>:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> → {{mile|7|mi|km}} <small>(mi entered, so converted into km)</small>the simplified individual template should be used.
''Numbers'' The Convert template can be rounded, ''units'' can be abbreviated into symbols:used in cases where standard format is not optimum.:<code><nowiki>==== Simplified unit of measurement templates ====*{{convert|2tl|km}} , {{tl|mi}}*{{tl|2m}} , {{tl|abbr=onft}}</nowiki></code> → , {{miletl|2yd}}*{{tl|kmmm}} , {{tl|miin}}*{{tl|2ha}} , {{tl|abbr=onacre}}:<code><nowiki>* {{converttl|7km2}} , {{tl|mimi2}}* {{tl|kmm2}} , {{tl|2ft2}}* {{tl|abbr=onkmh}}</nowiki></code> → , {{miletl|7|mi|km|2|abbr=onmph}}Value ''ranges'' can be entered using <code>* {{tl|tokg}} , {{tl|...</code> or <code>|-|...</code>:lb}}:<code><nowiki>* {{converttl|2|to|5|km|mig}}</nowiki></code> → , {{kilometer|2|totl|5|km|mioz}}:<code><nowiki>* {{converttl|2|-|5|km|miC}}</nowiki></code> → , {{kilometertl|2|-|5|km|miF}}
Combined effect === Convert template usage ==='''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|-|5|km|mi|2|abbr=on}}</nowiki></code> → {{kilometerconvert|2|-|5|km|mi|2|abbr=on}}:<code><nowiki>{{convert|27|and|5mi|km|mi|sigfig=3|abbr=off}}</nowiki></code> → {{kilometerconvert|27|and|5mi|km|mi|sigfig=3|abbr=off}}{{hatnote|See [[Help:Convert]] for more detailed, technical information}}<br />
==Units to convert=={{hatnote|See also: the summary at [[Template:Convert/list of units|Complete list of units for {{tlf|Convert}}]] and the complete list at [[ Module:Convert/documentation/conversion data]]}}Enter units to convert ''fromMultiple ''&nbsp;'formatting'into'':* <code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{pound|1|lb|kg}}:[[International System of Units|SI]] units generally accept prefixes, like "m" for milli (10<sup>−3</sup>), and "M" for mega (10<sup>6</sup>):For "per" units, use "/" (slash): kg/ha:For three-unit units, etccalculation options are listed below., see {{cl|Convert-like templates}}
==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
By default, the first quantity value shows the unit name, the second shows the symbol symbols (or = abbreviation):.* <code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{pound|1|lb|kg}} Using Use {{para|abbr|inon/off}} is the ''reverse to change this behaviour'' to the default:*:<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{poundconvert|1|lb|kg|abbr=in}} (To abbreviate both or neithercompare; default:first value shows unit name)* :<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{poundconvert|1|lb|kg|abbr=on}}* :<code><nowiki>{{convert|1|lb|kg|abbr=off}}</nowiki></code> → {{poundconvert|1|lb|kg|abbr=off}} ===Convenience: {{tlf|cvt}} has * {{para|abbr|onin}} by toggles the default===Template {{tl|cvt}} is the same as {{tlf|convert}}, except that it has behaviour ({{para|abbr|onout}} 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=onin}}</nowiki></code> → {{cvtconvert|1|lb|kg|abbr=onin}}
==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 {{convert|10|mi|km|adj=on}} distanceto go.Default behaviour''(To compare, for comparison:default)''* :<code><nowiki>A {{convert|10|mi|km|adj=on}} to godistance</nowiki></code> → A {{convert|10|mi|km|adj=on}} to godistance.''(Adjective form)''
{{para|adj|on}} does not produce hyphens with unit symbols, as per [[MOS:UNITSYMBOLS|Manual of Style]]:* <code><nowiki>A {{convert|9|in|cm|adj=on|abbr=on}} nail</nowiki></code> → A {{convert|9|in|cm|adj=on|abbr=on}} nail. =={{anchor|Rounding}}Rounding: ''100 ft'' is ''30&nbsp;m'' or ''30.5&nbsp;m'' or ''30.48&nbsp;m''?=={{hatnote|See {{section link|Help:Convert#Rounding}} for a more mathematical description of the rounding options}}By definitionIn detail, 100&nbsp;ft equals it is {{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 digitsfigures, whichever is more precise. An exception to this is ''rounding temperatures'' (see [[#Rounding temperatures|below]]).
{| class="wikitable"
|'''Input'''||'''Displays as'''||'''Note'''
|-
|<code><nowiki>{{convert|123|ft|m|-1}}</nowiki></code> || {{convert|123|ft|m|-1}} |||-|<code><nowiki>{{convert|123|ft|m}}</nowiki></code> || {{convert|123|ft|m}} || same output as with 0 (below)|-|<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|123|ft|m|2}}</nowiki></code> || {{convert|123|ft|m|2}} ||The more-exact value is 37.4904 m or so, which gets converted to 37 m if this parameter is not specified at all.|-|<code><nowiki>{{convert|500|ft|m|-1}}</nowiki></code> || {{convert|500|ft|m|-1}} |||-|<code><nowiki>{{convert|500|ft|m}}</nowiki></code> || {{convert|500|ft|m}} || same output as with −1 (above), because the conversion factor is between 0.2 and 2 (hence, it should produce same double-zero precision (−2) as in the input value), but the conversion must produce two significant digits at a minimum (hence, a higher single-zero precision (−1) is used)
|-
|<code><nowiki>{{convert|500123|ft|m|0}}</nowiki></code> || {{convert|500123|ft|m|0}} ||
|-
|<code><nowiki>{{convert|500123|ft|m|1}}</nowiki></code> || {{convert|500123|ft|m|1}} ||
|-
|<code><nowiki>{{convert|500550|ft|m|20}}</nowiki></code> || {{convert|500550|ft|m|20}} || exact Approximate value is 152167.4 64 m
|-
|<code><nowiki>{{convert|500550|ft|cm|-3m}}</nowiki></code> || {{convert|500550|ft|cm|-3m}} ||Rounds to 170, when approximate value is 167.64 m
|-
|<code><nowiki>{{convert|500|ft|cmm|0}}</nowiki></code> || {{convert|500|ft|cmm|0}} || same output as with −3 (above), because the conversion factor is between 20 and 200 (hence, it should decrease input Approximate value's double-zero precision (−2) by 2), but the conversion must produce two significant digits at a minimum (hence, a higher triple-zero precision (−3) is used)152.4 m
|-
|<code><nowiki>{{convert|500|ft|cm|0m}}</nowiki></code> || {{convert|500|ft|cm|0m}} ||Rounds to 150, when approximate value is 152.4 m
|}<!--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 multiple power of {{frac|1/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.
{{Anchor|Round to a given number of significant figures}}===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> → {{convert|1200|ft|m|sigfig=4}}* <code><nowiki>{{convert|1200|ft|m|sigfig=34}}</nowiki></code> → {{convert|1200|ft|m|sigfig=34}}* <code><nowiki>{{convert|1200|ft|m|sigfig=23}}</nowiki></code> → {{convert|1200|ft|m|sigfig=23}}* <code><nowiki>{{convert|1200|ft|m|sigfig=12}}</nowiki></code> → {{convert|1200|ft|m|sigfig=12}}Default behaviour, for comparison:* <code><nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki></code> → {{convert|1200|ft|m|sigfig=1}}Setting {{para|sigfig|&lt;=0}} 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> → {{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:* <small>To compare:</small> <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}}
===<span id="Round to a multiple of a given fraction"></span>Round to a multiple of a given fraction: ''{{frac|2|3|/16}} inch''===Specify the desired ''denominator'' using {{para|frac|&lt;some positive integer&gt;}}. ([[Fraction (mathematics)|Denominator]] is the below-the-slash number, for example the 3 in {{frac|1|/3}}).* :<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 uses decimal notation:* <code><nowiki>{{convert|5.568|cm|in}}</nowiki></code> → {{convert|5.568|cm|in|sigfig=4}}(To compare)
==={{anchor|Rounding temperatures}}Rounding the temperatures: ''°C'', ''°F'' and ''K''===In temperatures, the conversion will be rounded either to the precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.:<code><nowiki>{{convert|10|C|F K}}</nowiki></code> → {{convert|10|C|F K}}''Note'':For a temperature ''difference'', like to convert "A rise of 20 °C", use {{para|C-change|20}} &tc.:<code><nowiki>{{convert|20|C-change|F-change K-change}}</nowiki></code> → A rise of {{convert|20|C-change|F-change K-change}}
#{{#invoke:DemoTemplate|convert|10,000|C|F K}}#{{#invoke<small>To compare:DemoTemplate|convert|10,000.1|C|F K}}#{{#invoke"A temperature of 20 °C" would yield:DemoTemplate|convert|-272|C|F K}}#A temperature of {{#invoke:DemoTemplate|convert|-272|C}}#{{#invoke:DemoTemplate|convert|10020|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 takes place ''after'' conversion, so the output is based on the full-precision input. This is useful when the input is produced by {{tlc|&#35;expr:}} or otherwise available to a higher precision than is usefully displayed, and it's desirable to avoid double-rounding. To round the input to a specified number of digits after the decimal point, use one of the parameters:* {{para|adj|ri0}}* {{para|adj|ri1}}* {{para|adj|ri2}}* {{para|adj|ri3}}Note that there is no {{para|adj|ri-1}}{{nay}} or similar for rounding above the decimal place. Neither is there support for significant figures, multiples of 5, or any other output-rounding feature. The default precision is computed based on the input, so an explicit output precision must usually be supplied:* {{tlc|convert|4.14159|mi|km|adj{{=}}ri0}} → {{convert|4.14159|mi|km|adj=ri0}} {{nay}} (precisions are mismatched)* {{tlc|convert|4.14159|mi|km|0|adj{{=}}ri0}} → {{convert|4.14159|mi|km|0|adj=ri0}} {{aye}} In this case, if the input were rounded before conversion, a different result would be obtained:* {{tlc|convert|<nowiki>{{#expr:4.14159 round 0}}</nowikismall>|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> → {{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 {{section link||In input}} and {{section link||In output}}.
==Ranges of values==
{{For|a conversion of a difference|#Units of difference}}
A ''range'' converts ''two'' values and separates them by your choice of words and punctuation.
 
===A range: ''6 to 17 kg (13 to 37 lb)''===
Range indicators are entered as the second parameter (between the values). Range separators can be:<br/>
{{Convert/doc/range separator list}}
===Multiple dimensions: ''{{convert|6|x|12|m|ft|abbr=on}}''===
; Use <code>"by</code>":* :<code><nowiki>{{convert|6|by|12|ft|m}}</nowiki></code> → {{convert|6|by|12|ft|m}} ;Use <code>"×</code>, multiplication sign, " or <code>""x</code>, letter"":* :<code><nowiki>{{convert|6|x|12|m|ft}}</nowiki></code> → {{convert|6|x|12|m|ft}}
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}} ===Lists of values: ''20, 40, or 60 miles''===:<code><nowiki>{{convert|20|,|40|, or|60|mi}}</nowiki></code> &rarr; {{convert|20|,|40|, or|60|mi}}
===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}} {{nay}}Default behaviour, for comparison:<small>(to compare)</small>* <code><nowiki>{{convert|1|ft|3|in|x|3|ft|5|in|mm}}</nowiki></code> → {{convert|1|ft|3|in|mm}}However, converting metric units into feet and inches with {{para|order|flip}} can produce the desired output:* <code><nowiki>{{convert|380|x|10403|mmft|ftin5|order=flip}}</nowiki></code> → {{convert|380|x|1040in|mm|ftin|order=flip}}
==Words==
===Spelling of unit name: international UK ''metre'' or US ''meter''?===Default spelling of units is in the en (generic) locale-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}}
===<span id="spell"></span>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 valuesmake first letter a capital, use {{para|spell|onIn}}:* <code><nowiki>{{convert|10|mi|m|spell=onIn}}</nowiki></code> → {{convert|10|mi|m|spell=onIn}}
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}}=Extra words: ''4 planted acres''===:''Incomplete section''* :<code><nowiki>{{convert|104|miacre|m|spelladj=Onpre|planted}}</nowiki></code> → {{convert|104|miacre|m|spelladj=Onpre|planted}}
Remember that the spelling of the units (ft, m) is independently set by ===Extra adjective words: ''A {{paraconvert|abbr10|ft|ft|adj=mid|-long|disp=out|order=flip}}. To the extreme:corridor''===* :<code><nowiki>{{convert|104|mift|m|spelladj=onmid|abbr=off|sp=us-long}}</nowiki></code> → {{convert|10|mift|m|spelladj=onmid|abbr=off|sp=us-long}}
===Inserted before unitsGrammatical construction: ''4 planted acresThe 18-, 24- and 32-pounder (8, 11 and 15 kg) cannons''===*<code><nowiki>: "''The American defenders had 18-, 24- and 32-pounder (8,&nbsp;11&nbsp;and 15&nbsp;kg) cannons.''"This formatted result is not possible straightforward by using {{converttl|4|acre||adj=pre|plantedconvert}}</nowiki></code> → . However, it can be made in three steps.:'''Step 1:''' Enter the input numbers and units in {{tl|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 just to get the calculated output value::*<code><nowiki>had {{convert|418 |acre, |24 |disp=preunit, |planted }}</nowiki></code> → {{convert32 |4lb |acrekg ||disp=preunit|planted }}*<code><nowiki>{{convert|4|acre||disp=preunit|planted |reforested-0 }}cannons</nowiki></code> ::had {{convert|418 |acre, |24 |disp=preunit, |32 |planted lb |reforested-kg |0 }}cannons:The core conversion should look good now. You can save this (or preview).===After adjective unit: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor'Step 2:'===Note that two units ('' We need the resulting text in this caseplain code in the page, ft and m) are required. Use with just one unit will generate an error message.:<code><nowiki>not as a {{converttl|10|ft|m|adj=mid|-long}}</nowiki></code> → {{convert|10|ft|m|adj=mid|-long...}}template. ===Plurals: For this, ''1'add&nbsp;inch, 2&nbsp;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>subst:</code> → {{convert|1|metre}}to the template name''' (for 'substitute') ::* <code><nowiki>had {{convert|2|metre}}</nowiki>'''subst:'''</codenowiki> → {{convert|218 |metre}}* <code><nowiki>{{convert, |224 |, |32 |lb |metrekg |abbr=on0 }}cannons</nowiki></code> → {{convert|2|metre|abbr=on}} ;Exception:Entering As a check: the unit spelled <code>|foot|</code> forces singular output "foot"preview result should show the conversion correct, whatever with the number isnumbers still right.* <code><nowiki>{{convert|100|foot|abbr=off}}</nowiki></code> :'''Now save this'''.::{{convert|100|foot|abbr=off}}had 18,&nbsp;24,&nbsp;32 pounds (8,&nbsp;11,&nbsp;15&nbsp;kg) cannons ===Fractions: ''one-eighth of an imperial pint'Step 3:''' When opening the edit screen again, you'===ll see that the text is there in code. The convert template also supports spelling out fractions.* <code><nowiki>{{converttl|3+1/2|oz|g|spell=in}}</nowiki></code> → {{convert|3+1/2|oz|g|spell=in...}}Any additional words needed for the fraction itself has disappeared. You can also be added at change the end of the templatetext as needed.* <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}}<!-- todoThe edit screen text is: decimals & negative examples --> ===Wrapping and line breaking===:See {{section link|Help:Convert|Wrapping and line breaking}} ===<span id="million"code></spannowiki>Spelling out "thousands"had 18, "millions"&amp;nbsp;24, etc.===Most unit codes accept a prefix of e3 &amp;nbsp;32 pounds (thousand8,&amp;nbsp;11,&amp;nbsp;15&amp;nbsp;kg) or e6 (million) or e9 (billion).* <code><nowiki>{{convert|100|e6mi|e6km}}cannons</nowiki></code> → {{convert|100|e6mi|e6km}}* <code><nowiki>{{convert|120|e6acre}}</nowiki></code> → {{convert|120|e6acre}}:You can edit this text to add the grammar::* <code><nowiki>{{convert|120|e6acre|e3km2}}</nowiki>had 18'''-''','''_'''24'''-_and_'''32'''-'''pound'''er''' (8,&amp;nbsp;11'''_and_'''15&amp;nbsp;kg) cannons </code> → {{convert|120|e6acre|e3km2}} To display both input and output in scientific notation:After saving your edit, use {{para|abbr|on}}it shows:* <code><nowiki>{{convert|100|e6mi|e6km|abbr=on}}</nowiki></code> ::{{convert|100|e6mi|e6km|abbr=on}} To spell out "thousands"had 18-, "millions"24- and 32-pounder (8, etc., {{para|abbr|unit}} abbreviates the unit&nbsp;11&nbsp; {{para|abbr|off}} displays both full unit namesand 15&nbsp;kg) cannons".* <code><nowiki>{{convert|100|e6mi|e6km|abbr=unit}}</nowiki></code> → {{convert|100|e6mi|e6km|abbr=unit}}* <code><nowiki>{{convert|100|e6mi|e6km|abbr=off}}</nowiki></code> → {{convert|100|e6mi|e6km|abbr=off}}
==Numbers==
===Using an SI prefix: ''gigameter (Gm)'', or ''micrometer (μm)''===
Units can have an 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.
===Using an SI prefix: ''gigametre (Gm)'', or ''micrometre (&#x03BC;m)''==={{Sidebar metric prefixes (small)}}Units can have an [[metric prefix|SI prefix]] like <code>G</code> before the unit: <code>Gm</code>, and <code>giga</code> before the name: <code>gigametre</code>. These are plain multiplication factors. To illustrate, these are trivial calculations (from metre meter to metremeter), 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 metremeter):
* <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>&#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> → {{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 "&#x03BC;μ" prefix too:)* <code><nowiki>{{convert|12|&#x03BC;mμm|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}
===Thousands separator: ''1,000 mi'' and ''1000 mi''===In input, a comma for thousands separator is accepted. A gap (space) is not. In output, by default, the thousand separator is the comma:*<code><nowiki>{{further informationconvert|Help:Convert units#SI prefixes1,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}}*<s><code><nowiki>{{convert|1 234 567|m|ft}}</nowiki></code> → {{convert|1 234 567|m|ft}}</s>
===Engineering notationSet {{para|comma|off}} to remove the separator: ''7 × 10*<supcode>6</supnowiki> {{convert|1234567|m''=|ft|comma=off}}</nowiki></code> → {{convert|1234567|m|ft|adj=nocomma}}
====In the unit: ''e6m''====[[Engineering notation]] can be entered as a "prefix" Use {{para|comma|gaps}} to the unitset digit grouping by gap (<code>&lt;space></code>) in larger numbers (thousands separator):* <code><nowiki>{{convert|701234567|e6mm|ft}}</nowiki></code> → {{convert|701234567|m|ft}} <small>(To compare, default)</small>*<code><nowiki>{{convert|1234567|m|ft|comma=gaps}}</nowiki></code> → {{convert|1234567|m|e6mft|abbrcomma=ongaps}}
The same is possible for the output unit:* <code><nowiki>Setting {{convertpara|23,000,000comma|ft|e6m5}}</nowiki></code> → {{convert|23,000,000|ft|e6m}} Any standard unit (not a combination, multiple, or built-in unit) can have such a prefix:* <code>e3</code> (thousand),* <code>e6</code> (million),* <code>e9</code> (billion),* <code>e12</code> (trillion),* <code>e15</code> (quadrillion). ===Scientific notation: ''1.23 × 10<sup>−14</sup>''===In [[scientific notation]], a number is written like {{rndpara|12.3e-15comma|16gaps5}}. The plain number has exactly one digit before will only add the decimal point. With {{tlf|convert}}, separator when the input can be in e-notation such as <code>12.3e4</code>. This value is displayed as a power number of ten, and the output digits 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 positive [[mixed number]]s (a positive integer and a fraction), use a <code>+</code> sign*<code><nowiki>{{convert|2+1⁄2|in|mm|1}}</nowiki></code> → {{convert|2+1⁄2|in|mm|1}} With negative mixed numbers, 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}} Note that the following cases are not interpreted as mixed numbers:*<code><nowiki>{{convert|2-1⁄2|in|mm|1}}</nowiki></code> → {{convert|2-1⁄2|in|mm|1}}. This is interpreted as a range from 2 inches to 1⁄2 inch.*<code><nowiki>{{convert|-2+1⁄2|in|mm|1}}</nowiki></code> → {{convert|-2+1⁄2|in|mm|1}} {{nay}} This is neither a mixed number nor a range, and mathematical expressions requiring calculations are not allowed here. ===Horizontal fraction bar: ''{{sfrac|1|2}}&nbsp;inch''===<!-- technical restriction: TOC does not show the example horizontal bar intended here; rephrased section title-->Using a double slash (<code>//</code>) provides a horizontal fraction bar for the original (input) unit:* <code><nowiki>{{convert|1//2|in|mm|1}}</nowiki></code> → {{convert|1//2|in|mm|1}}* <code><nowiki>{{convert|6+3//8|in|mm|1}}</nowiki></code> → {{convert|6+3//8|in|mm|1}}Using a negative value for {{para|frac}} provides a horizontal fraction bar for the converted (output) unit:*<code><nowiki>{{convert|12.7|mm|frac=-2}}</nowiki></code> → {{convert|12.7|mm|frac=-2}}*<code><nowiki>{{convert|161.9|mm|frac=-8}}</nowiki></code> → {{convert|161.9|mm|frac=-8}} ===Thousands separator: ''1,000 mi'' 5 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 commamore:* <code><nowiki>{{convert|12345671234|m|ft}}</nowiki></code> → {{convert|12345671234|m|ft}}* <code><nowiki>{{convert|1(To compare,234,567|m|ft}}</nowiki></code> → {{convert|1,234,567|m|ft}} Set {{para|comma|off}} to remove the separator from the output:default)* <code><nowiki>{{convert|12345671234|m|ft|comma=off5}}</nowiki></code> → {{convert|12345671234|m|ft|comma=off5}} Use {{para|comma|gaps}} to use digit grouping by gap (thin space) as a thousands separator:* <code><nowiki>{{convert|1234567|m|ft|comma=gaps5}}</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=5gaps5}}</nowiki></code> → {{convert|1234|m|ft|comma=5gaps5}}* <code><nowiki>{{convert|1234567|m|ft|comma=5gaps5}}</nowiki></code> → {{convert|1234567|m|ft|comma=5}}Default behaviour, for comparison:* <code><nowiki>{{convert|1234|m|ft}}</nowiki></code> → {{convert|1234|m|ftgaps5}}
==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> → {{convert|10|m|ft|disp=sqbr}}-- ''(&nbsp;) brackets are the default''* :<code><nowiki>{{convert|10|m|ft|disp=commasqbr}}</nowiki></code> → {{convert|10|m|ft|disp=commasqbr}}* :<code><nowiki>{{convert|10|m|ft|disp=orcomma}}</nowiki></code> → {{convert|10|m|ft|disp=orcomma}}Default behaviour, for comparison:* <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>&lt;br/></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 (useful in tables):* <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:
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 -->
===<span id="flip"></span>Flipping (reordering) the two measurements: ''{{convert|1|mi|m|order=flip|sigfig=5|abbr=off}}'' ===
Setting {{para|order|flip}} will flip (swap) the two measurements:
* :<code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> → {{convert|1|mi|m|order=flip|sigfig=5|abbr=off}}<!-- Extra settings added to enhance the illustration. Don't know if this is ideal way of documenting. DePiepsmall>(To compare, August 2014. --default)</small>Default behaviour, for comparison:* <code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> → {{convert|1|mi|m|order=flip|sigfig=5|abbr=off}}<!-- Extra settings added to enhance the illustration. Don't know if this is ideal way of documenting. DePiep, August 2014. -->
When converting to multiple units, the effect is:
* :<code><nowiki>{{convert|10|km|mi nmi|order=flip}}</nowiki></code> → {{convert|10|km|mi nmi|order=flip|sigfig=5|abbr=off}}* :<code><nowiki>{{convert|10|km|nmi mi|order=flip}}</nowiki></code> → {{convert|10|km|nmi mi|order=flip|sigfig=5|abbr=off}} ===Fixed ordering of output units: ''{{convert|100|C|F C K|abbr=on|order=out}}'' ===Setting {{para|order|out}} shows the output-units as ordered; the input unit is skipped:*<code><nowiki>{{convert|100|C|F C K|abbr=on|order=out}}</nowiki></code> &rarr; {{convert|100|C|F C K|abbr=on|order=out}}*<code><nowiki>{{convert|200|PS|kW hp|0|abbr=on|order=out}}</nowiki></code> → {{convert|200|PS|kW hp|0|abbr=on|order=out}} ''See also: [[Template:Convert#Displaying_parts_of_the_result:_2_(1.5)|§ Displaying parts of the output]]''.
=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
{| class="wikitable"
! Convert !! Output !! ReturnsDescription
|-
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}}| Regular output (for comparison)| 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''. {{nowrap|1=Note repetition of unit in input}})|-| <code><nowiki>{{convert|2|cuyd|m3|abbr=~}}</nowiki></code> || {{convert|2|cuyd|m3|abbr=~}}| Input: both name and symbol
|-
| <code><nowiki>{{convert|2|cuyd|m3|disp=unit2}}</nowiki></code> || {{convert|2|cuyd|m3|disp=unit2}} || Output unit (symbol)
| <code><nowiki>{{convert|2|cuyd|m3|disp=unit2|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 name
|-
| <code><nowiki>{{convert|2|cuyd|m3|disp=out|abbr=off}}</nowiki></code> || {{convert|2|cuyd|m3|disp=outou|abbr=offofft}}|| Output value and unit symbol
|}
 
===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 two 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 Show numbers only in tables:{| class=wikitable! {{para|disp|br}} !! {{para|disp|br()}}|-|{{convert|100|km|mi|disp=br}}|{{convert|100|km|mi|disp=br()}}|} ===Table columns in a table===Using {convert} in a table cell, with {{para|disp|table}} splits the result over two (or more) columns. By default units are not included in the table, however, they can be added using the {{para|abbr|}} parameter. Multiple-unit outputs, like <code>ftin</code>, always output their units to the table.::<code><nowiki>{{convert|10|m|ft|disp=table}}</nowiki></code> →<code>{{convert|10|m|ft|disp=table}}</code>
{{para|disp|tablecen}} does the same, and also centers the text:
:<code><nowiki>{{convert|20|m|ft|disp=tablecen}}</nowiki></code> →<code>{{convert|20|m|ft|disp=tablecen}}</code>
The units are added as a column header:
:{| class=wikitable
! style="width:10em;" | &nbsp;
! style="width:10em;" | kilogramsm! style="width:10em;" | pounds! style="width:10em;" | stone and poundsft
|-
| {{para|disp|table}}
| {{convert|10|kgm|lb stlbft|disp=table}}|-|{{para|disp|table}} and {{para|abbr|on}}| {{convert|20|kg|lb stlb|disp=table|abbr=on}}|-|{{para|disp|table}} and {{para|abbr|off}}| {{convert|30|kg|lb stlb|disp=table|abbr=off}}
|-
|{{para|disp|tablecen}}
| {{convert|4020|kgm|lb stlbft|disp=tablecen}}
|-
|{{para|disp|&lt;other>}} <small>(default)</small>
|{{convert|5030|kgm|lb stlbft|disp=}}|-
|}
===Sorting===
:Use both {{para|disp|table}} {{para|sortable|on}} to include a ''hidden numerical sortkey'' in the outputproduce table columns (pipe symbols), suitable for use in a [[Help:Sorting|table with sortable columns]]table column. TechnicallyAs of January 2013, this places a hidden string before only the actual displayed values::<code><nowiki>{{convert|10|m|ft|sortable=on}}</nowiki></code> {{nowrap|1=→ <code>&lt;span data-first (lefthand) column will sort-value="7001100000000000000♠">&lt;/span>10 metres (33&nbsp;ftimprovements pending)</code>}}:showing: {{convert|10|m|ft|sortable=on}}.
Use both :<nowiki>{{paraconvert|disp10|m|ft|disp=table|sortable=on}} and </nowiki> →<code>{{paranowrap|sortable{{convert|10|m|ft|disp=table|sortable=on}} together to produce table columns (pipe symbols) for each value in sortable columns}}</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==
The conversion factors and physical constants are sourced [[Module:Convert/documentation/conversion data introduction/doc#Conversion factors and physical constants|here]].
 
===All units===
{{selfref|See also: [[Template:Convert/list of units|Convert/list of units]]}}
{{hatnote|Units are case-sensitive: use {{xt|kW}}, not {{!xt|KW}} or {{!xt|kw}}}}
{{Convert/list of units}}
 
==={{anchor|per}}'per' units: ''kg/hl'', ''miles per gallon''===
When using a slash (<code>/</code>), a unit like <code>kg/hl</code> is recognized as kilograms ''per'' hectolitre and will be converted with other mass/volume units.
* <code><nowiki>{{convert|1000|kg/hl}}</nowiki></code> → {{convert|1000|kg/hl}}
 
Population density (''inhabitants per square mile'') can be converted using
* <code><nowiki>{{convert|10|PD/sqmi|PD/km2}}</nowiki></code> → {{convert|10|PD/sqmi|PD/km2}}
 
Vehicular fuel efficiency, commonly expressed in ''miles per gallon'' or ''litres per 100 km'' can also be converted
* <code><nowiki>{{convert|26|mpgUS|l/100km mpgimp}}</nowiki></code> → {{convert|26|mpgUS|l/100km mpgimp}}
 
==={{anchor|Units of difference}}Units of difference: Expressing a change or difference in temperature===
We have already discussed standard temperature conversions (°C, °F, K), as shown in these two examples:
* {{#invoke:DemoTemplate|convert|10|C}} (standard temperature conversion)
* {{#invoke:DemoTemplate|convert|10–15|C}} (standard temperature range conversion)
 
When expressing a temperature ''change'' (e.g., "The temperature ''increased'' by 10&nbsp;°C"), or when ''comparing'' temperatures (e.g., "10 to 15&nbsp;°C ''warmer''"), we cannot use the standard temperature units ({{para||C}}, {{para||F}} and {{para||K}}), which refer to points on the respective scale. Instead, we must use one of the following "units of difference": {{para||C-change}}, {{para||F-change}} and {{para||K-change}}.
 
Compare the following two examples with the two above:
 
* {{#invoke:DemoTemplate|convert|10|C-change}} increase in temperature
* {{#invoke:DemoTemplate|convert|10–15|C-change}} warmer than normal
 
To produce multiple units in the output:
* {{#invoke:DemoTemplate|convert|10|C-change|F-change K-change}} difference
 
===Multiple units: ''1 ft 5 in''===
====In input====
Base document {{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}}
* <code><nowiki>{{convert|1500|$/ozt|$/g}}</nowiki></code> → {{convert|1500|$/ozt|$/g}}
 
You can set the currency in ''both'' values using {{para|$|€}}:
* <code><nowiki>{{convert|10|$/mi|$/km|$=€}}</nowiki></code> → {{convert|10|$/mi|$/km|$=€}}
 
It is ''not'' possible to convert the currency. So, this result (mixed currencies) is ''not'' possible: {{!mxt|1=$15 per mile (€8.6/km)}} {{nay}}
 
==Using convert inside templates==
For usage in template code, like infoboxes, {{tlf|Convert}} has these options:
;Pre-formatting fraction input
* [[Module:Convert/helper]] can read regular input and pre-format it into {{tlf|Convert}}-accepted input.
:Your template can accept {{para|input|16 7/8}} and use <nowiki>{{#invoke:Convert/helper|number|16 7/8}}</nowiki> &rarr; {{#invoke:Convert/helper|number|16 7/8}}
 
;Using a Wikidata property
* Adding the Wikidata property code, like code {{para|input|P2073}}, to your template code automatically returns the Wikidata property for that article, and convert it. Both number and unit are read.
Note: to return that property value for an ''other'' article, use {{para|qid}}.
 
Example for {{Wikidata property link|P2073}}:
Note: this example uses {{para|qid|Q1056131}} (testing for {{Wikidata entity link|Q1056131}})
* <code><nowiki>{{convert|input=P2073|qid=Q1056131|ftin|abbr=on}}</nowiki></code> &rarr; {{convert|input=P2073|qid=Q1056131|ftin|abbr=on}}
* <code><nowiki>{{convert|input=P2073|qid=Q1056131|km|abbr=on}}</nowiki></code> &rarr; {{convert|input=P2073|qid=Q1056131|km|abbr=on}}
* <code><nowiki>{{convert|input=P2073|qid=Q1056131|km|abbr=on|disp=out}}</nowiki></code> &rarr; {{convert|input=P2073|qid=Q1056131|km|abbr=on|disp=out}}
:For example see [[template:Infobox Telescope]].
 
Sometimes a property may have more than one value against it in Wikidata. You can use the {{para|qual}} parameter to specify which of the values you want to use.
 
Example for {{Wikidata property link|P2386}}:
Note: this example uses {{para|qid|Q1513315}} (testing for {{Wikidata entity link|Q1513315}})
* {{Wikidata entity link|Q613628}}: <code><nowiki>{{convert|input=P2386|qual=Q613628|ft|abbr=on}}</nowiki></code> → {{convert|input=P2386|qid=Q1513315|qual=Q613628|ft|abbr=on}}
* {{Wikidata entity link|Q1395645}}: <code><nowiki>{{convert|input=P2386|qual=Q1395645|ft|abbr=on}}</nowiki></code> → {{convert|input=P2386|qid=Q1513315|qual=Q1395645|ft|abbr=on}}
==Parameter list==
{{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", "required": true }, "2": { "label": "From unit", "description": "The unit for the provided value.", "type": "string", "example": "km", "required": true }, "3": { "label": "To units", "description": "The units to convert into. Separate units by a space for multiple outputs. In an output unit, use + for a multiplication space.", "type": "string", "example": "mi nmi", "suggested": true }, "4": { "label": "Precision or suffix", "description": "Significant digits after decimal dot or, if negative, exponent of ten.", "type": "number" }, "lk": { "label": "Link units", "description": "Indication of what units to apply wikilinks to. Use “on” for all, “in” for the input unit, “out” for the output units, or “off” for none of the units.", "default": "off", "type": "string", "example": "on" }, "abbr": { "label": "Abbreviation", "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", "type": "string", "example": "on, unit, in, out, off", "suggested": true }, "sp": { "label": "Spelling", "description": "Spelling of units. Use “us” to display unit names using U.S. spelling.", "type": "string", "example": "us" }, "adj": { "label": "Adjective", "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.", "type": "unbalanced-wikitext", "example": "on", "default": "off" }, "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.", "type": "string", "example": "b" }, "order": { "label": "Ordering", "description": "“flip” returns converted value first, input value second.", "type": "string", "example": "flip" }, "sigfig": { "label": "Significant figures", "description": "Indicates the number of significant figures to be used in rounding.", "type": "number" }, "round": { "label": "Rounding output", "description": "The type of rounding. “5” rounds the output number to nearest multiple of 5, “25” to nearest multiple of 25, “each” rounds each number in a range.", "type": "number" }, "comma": { "label": "Thousands separator", "description": "Sets or suppresses the use of thousands separators in the numbers. “off”: no separator; “gaps”: use space instead of comma as thousands separator; “5”: only add thousands separator when the integral part of the number uses 5 positions or more (10,000 or more; if using comma as thousands separator, 1234 would produce '1234', 12345 would produce '12,345').", "default": "on", "type": "string", "example": "off" }, "sortable": { "label": "Sort key", "description": "“on” generates a hidden sort key", "type": "string", "example": "on" }, "spell": { "label": "Spell numbers?", "description": "If used, spells input or input and output numbers in words, optionally capitalizing the first", "example": "'in', 'In', 'on', or 'On'", "type": "string" }, "sing": { "type": "string", "deprecated": "use adj=", "label": "Singular?", "description": "If 'yes', uses singular form of units (deprecated)", "example": "yes" }, "frac": { "label": "Fraction?", "description": "fraction as rounding unit", "type": "number" }, "$": { "label": "Currency symbol", "description": "sets currency symbol in both units", "example": "$=€ will show \" €10 per mile (€6.2/km)\"", "type": "string" }, "input": { "label": "WD property", "description": "Reads the property value of the item (article), then converts it", "example": "{{convert|input=P2046}} (P2046=area)", "type": "string" } }, "format": "inline"}</templatedata><!--''to be added''==Glossary==;unit code:;unit symbol:--> ==See also==* {{Temp|Cvt}}* {{Temp|SI units}}* {{Temp|Inflation}} to convert historical prices to their current equivalent.{{Convert navs}}<noinclude>[[Category:Convert by module documentation| ]]</noinclude><includeonly>{{#ifeq:{{SUBPAGENAME}}|doc||[[Category:Convert templates| ]][[Category:Conversion templates]][[Category:Numbers as words conversion templates]][[Category:Sorting templatesFormatting and function templates‎]]}}</includeonly>



Navigation menu