Difference between revisions of "Template:Convert/doc"

From Teampedia
Jump to: navigation, search
Line 1: Line 1:
−
<noinclude>
+
{{documentation subpage}}
−
{{Documentation subpage|種類=[[Help:テンプレート|テンプレート]]}}
+
=== Units of measurement usage on Wikivoyage ===
−
</noinclude><includeonly>
+
Format and conventions used for units can be found at [[Wikivoyage:Measurements]].
−
{{複雑なテンプレート}}
+
−
{{#ifeq:{{#titleparts:{{FULLPAGENAME}}|1|}}|Template:Convert2
+
−
|{{混同|Template:Convert|x1=機能と使用法はほぼ同じですが、テンプレート版の}} {{lua|モジュール:Convert}}
+
−
|{{混同|Template:Convert2|x1=機能と使用法はほぼ同じですが、Luaモジュールを使用している}}
+
−
}}
+
−
</includeonly>
+
−
__NOTOC__
+
−
{{Infobox
+
−
| title =  
+
−
| data1 = {{Infobox
+
−
        | child = yes
+
−
        | title = [[Special:Whatlinkshere/{{#titleparts:{{FULLPAGENAME}}|1|}}{{!}}{{#titleparts:{{FULLPAGENAME}}|1|}}を使用している記事一覧]]
+
−
        | label1 =
+
−
        | data1 =
+
−
        }}
+
−
| below = <!--最下部テキスト-->
+
−
}}
+
−
==Template purpose==
+
−
This is a template for converting numbers with units to another unit and writing them together. For example, a unit of weight[[G]](g)を[[グレーン]](gr)という単位に置き換えるには、<nowiki>{{convert|10|g|gr}}</nowiki>Will write {{convert|10|g|gr}}, side by side.
+
−
Initially, when I copied the English version of the article,
+
−
{{font|color=red|Template:Convert/DWton}}If it appears like this, it means that the internal template has not been ported to the English version yet, and to display it, you may need to port it yourself or wait for someone to port it. did. In addition, in some cases, multiple templates had to be ported, even if it appeared to be a single template.
+
  
−
If it appears like this, it means that the internal template has not been ported to the Japanese version yet, and to display it, you may need to port it yourself or wait for someone to port it. did. In addition, in some cases, multiple templates had to be ported, even if it appeared to be a single template.
+
To ensure units are displayed correctly, the simplified individual template should be used.
  
−
However, the English version of Wikipedia has shifted to using Lua modules, and internal templates are no longer used.{{tl|convert2}}
+
The Convert template can be used in cases where standard format is not optimum.
 +
==== Simplified unit of measurement templates ====
 +
*{{tl|km}} , {{tl|mi}}
 +
*{{tl|m}} , {{tl|ft}}, {{tl|yd}}
 +
*{{tl|mm}} , {{tl|in}}
 +
*{{tl|ha}} , {{tl|acre}}
 +
* {{tl|km2}} , {{tl|mi2}}
 +
* {{tl|m2}} , {{tl|ft2}}
 +
* {{tl|kmh}} , {{tl|mph}}
 +
* {{tl|kg}} , {{tl|lb}}
 +
* {{tl|g}} , {{tl|oz}}
 +
* {{tl|C}} , {{tl|F}}
  
−
It is better to rewrite it.
+
=== 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|km|mi}}</nowiki></code> → {{convert|2|km|mi}}
 +
:<code><nowiki>{{convert|7|mi|km}}</nowiki></code> → {{convert|7|mi|km}}<br />
 +
 
 +
Multiple '''formatting''' and calculation options are listed below.
 +
 
 +
==Unit name or symbol (abbreviation): ''1 pound'' or ''1 lb''?==
 +
By default, the first value shows unit name, the second the symbols (= abbreviation).
 +
Use {{para|abbr|on/off}} to change this behaviour:
 +
:<code><nowiki>{{convert|1|lb|kg}}</nowiki></code> → {{convert|1|lb|kg}} (To compare; default: first value shows unit name)
 +
:<code><nowiki>{{convert|1|lb|kg|abbr=on}}</nowiki></code> → {{convert|1|lb|kg|abbr=on}}
 +
:<code><nowiki>{{convert|1|lb|kg|abbr=off}}</nowiki></code> → {{convert|1|lb|kg|abbr=off}}
 +
* {{para|abbr|in}} toggles the default behaviour ({{para|abbr|out}}):
 +
:<code><nowiki>{{convert|1|lb|kg|abbr=in}}</nowiki></code> → {{convert|1|lb|kg|abbr=in}}
 +
 
 +
==Adjective: ''a 10-mile distance''==
 +
Use {{para|adj|on}} to produce the adjective form. The difference:
 +
:<code><nowiki>{{convert|10|mi|km}} to go</nowiki></code> → {{convert|10|mi|km}} to go. ''(To compare, default)''
 +
:<code><nowiki>A {{convert|10|mi|km|adj=on}} distance</nowiki></code> → A {{convert|10|mi|km|adj=on}} distance. ''(Adjective form)''
 +
 
 +
==Rounding: ''100 ft'' is ''30&nbsp;m'' or ''30.5&nbsp;m'' or ''30.48&nbsp;m''?==
 +
In detail, it is {{convert|100|ft|mm|sigfig=5|disp==}}. In practical use, it is common to round the calculated metric number. With that, there are several possibilities.
 +
 
 +
===Default rounding===
 +
:By default, the conversion result will be rounded either to precision comparable to that of the input value (the number of digits after the decimal point—or the negative of the number of non-significant zeroes before the point—is increased by one if the conversion is a multiplication by a number between 0.02 and 0.2, remains the same if the factor is between 0.2 and 2, is decreased by 1 if it is between 2 and 20, and so on) or to two significant figures, whichever is more precise. An exception to this is ''rounding temperatures'' (see [[#Rounding temperatures|below]]).
  
−
This template is used relatively frequently in the English version. When creating a new conversion formula, make sure that there are no similar templates in the English version. In particular, do not create a template with the same title as the English version but another meaning.
 
−
==Example==
 
−
<!--For a single number:--><!-- Left character, omit until you write an example of the range-->
 
 
{| class="wikitable"
 
{| class="wikitable"
−
!変換!!記法!!表示
 
−
!Convert!!Notation!!Show
 
−
|- 
 
−
|kilometers to Miles||<nowiki>{{convert|18.75|km|mi}}</nowiki>||{{convert|18.75|km|mi}}
 
 
|-
 
|-
−
|From kilogram to pound||<nowiki>{{convert|3.215|kg|lb}}</nowiki>||{{convert|3.215|kg|lb}}
+
! colspan="3" | Examples of rounding
 
|-
 
|-
−
|単位を略号にする場合||<nowiki>{{convert|3.215|kg|lb|abbr=on}}</nowiki>||{{convert|3.215|kg|lb|abbr=on}}
+
|'''Input'''||'''Displays as'''||'''Note'''
 
|-
 
|-
−
|さらに単位の記事への内部リンクを作成||<nowiki>{{convert|3.215|kg|lb|lk=on|abbr=on}}</nowiki>||{{convert|3.215|kg|lb|lk=on|abbr=on}}
+
|<nowiki>{{convert|123|ft|m|-1}}</nowiki>||{{convert|123|ft|m|-1}} ||
 
|-
 
|-
−
|表示を"/"区切りで並べる場合||<nowiki>{{convert|3.215|kg|lb|disp=s}}</nowiki>||{{convert|3.215|kg|lb|disp=s}}
+
|<nowiki>{{convert|123|ft|m|0}}</nowiki>||{{convert|123|ft|m|0}} ||
 
|-
 
|-
−
|単位の前に"-"を付ける場合||<nowiki>{{convert|3.215|kg|lb|adj=on}}</nowiki>||{{convert|3.215|kg|lb|adj=on}}
+
|<nowiki>{{convert|123|ft|m|1}}</nowiki>||{{convert|123|ft|m|1}} ||
 
|-
 
|-
−
|小数点以下1桁となるよう四捨五入する場合||<nowiki>{{convert|3.215|kg|lb|1}}</nowiki>||{{convert|3.215|kg|lb|1}}
+
|<nowiki>{{convert|550|ft|m|0}}</nowiki>||{{convert|550|ft|m|0}} || Approximate value is 167.64 m
 
|-
 
|-
−
|(変換後の単位を省略すると、最も一般的な単位に変換する)||<nowiki>{{Convert|7|lb}}</nowiki>||{{Convert|7|lb}}
+
|<nowiki>{{convert|550|ft|m}}</nowiki>||{{convert|550|ft|m}} || Rounds to 170, when approximate value is 167.64 m
 
|-
 
|-
−
|誤差を併記する場合||<nowiki>{{convert|60|+/-|10|m|ft}}</nowiki>||{{convert|60|+/-|10|m|ft}}
+
|<nowiki>{{convert|500|ft|m|0}}</nowiki>||{{convert|500|ft|m|0}} || Approximate value is 152.4 m
 
|-
 
|-
−
|複数単位への変換<br/>(スペースで区切って並べる)||<nowiki>{{convert|1|R|C F K}}</nowiki>||{{convert|1|R|C F K|lk=on}}
+
|<nowiki>{{convert|500|ft|m}}</nowiki>||{{convert|500|ft|m}} || Rounds to 150, when approximate value is 152.4 m
−
|-
+
|}<!--NOTE: rows require "nowiki", using &#123;{ disappears. -->
−
|Miles to Kilometers||<nowiki>{{convert|10|mi|km}}</nowiki>||{{convert|10|mi|km}}
+
 
−
|}
+
''Convert'' supports four types of rounding:
−
'''注意'''
+
 
−
*上記のスイッチ（abbr=onとか）は、その組み合わせ毎にテンプレートを作っています。そのため、スイッチのon、offの組み合わせによっては新たにテンプレートを作成または移植する必要があります。
+
===Round to a given precision: ''use {{para|precision|}}''===
−
*複数単位への変換の場合もその組み合わせに対応するテンプレートを新たに作成する必要がある場合があります。
+
Specify the desired precision with the fourth unnamed parameter (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest power of 1/10 this number. For instance, if the result is 8621 and the round number is "-2", the result will be 8600. If the result is "234.0283043" and the round number is "0", the result will be 234.
 +
 
 +
===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>}}:
 +
* <small>To compare:</small> <nowiki>{{convert|1200|ft|m}}</nowiki> → {{convert|1200|ft|m}}
 +
* <nowiki>{{convert|1200|ft|m|sigfig=4}}</nowiki> → {{convert|1200|ft|m|sigfig=4}}
 +
* <nowiki>{{convert|1200|ft|m|sigfig=3}}</nowiki> → {{convert|1200|ft|m|sigfig=3}}
 +
* <nowiki>{{convert|1200|ft|m|sigfig=2}}</nowiki> → {{convert|1200|ft|m|sigfig=2}}
 +
* <nowiki>{{convert|1200|ft|m|sigfig=1}}</nowiki> → {{convert|1200|ft|m|sigfig=1}}
 +
Setting {{para|sigfig|&lt;=0}} is meaningless
 +
* <nowiki>{{convert|1200|ft|m|sigfig=0}}</nowiki> → {{convert|1200|ft|m|sigfig=0}}
 +
 
 +
===Round to a multiple of 5: ''15'', ''20'', ''25'', ...===
 +
Using {{para|round|5}} rounds the outcome to a multiple of 5.
 +
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
 +
:<code><nowiki>{{convert|10|m|ft|round=5}}</nowiki></code> → {{convert|10|m|ft|round=5}}
 +
 
 +
Similar: using {{para|round|25}} rounds the outcome to a multiple of 25.
 +
:<code><nowiki>{{convert|10|m|ft}}</nowiki></code> → {{convert|10|m|ft}}
 +
:<code><nowiki>{{convert|10|m|ft|round=25}}</nowiki></code> → {{convert|10|m|ft|round=25}}
 +
:<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}}
 +
 
 +
===Round to a multiple of a given fraction: ''2 3/16 inch''===
 +
Specify the desired ''denominator'' using {{para|frac|&lt;some positive integer&gt;}}. (Denominator is the below-the-slash number, for example the 3 in 1/3).
 +
:<code><nowiki>{{convert|5.56|cm|in|frac=16}}</nowiki></code> → {{convert|5.56|cm|in|frac=16}}
 +
:<code><nowiki>{{convert|8|cm|in|frac=4}}</nowiki></code> → {{convert|8|cm|in|frac=4}}
 +
The fraction is reduced when possible:
 +
:<code><nowiki>{{convert|8|cm|in|frac=100}}</nowiki></code> → {{convert|8|cm|in|frac=100}}
 +
:<code><nowiki>{{convert|8|cm|in}}</nowiki></code> → {{convert|8|cm|in|sigfig=4}} (To compare)
 +
 
 +
==={{anchor|Rounding temperatures}}Rounding the temperatures °C, °F and K===
 +
In temperatures, the conversion will be rounded either to precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.
 +
:<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}}
 +
 
 +
:<small>To compare: "A temperature of 20 °C" would yield: A temperature of {{convert|20|C|F K}}</small>
 +
 
 +
==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}}
 +
 
 +
==Ranges of values==
 +
===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 "by":
 +
:<code><nowiki>{{convert|6|by|12|ft|m}}</nowiki></code> → {{convert|6|by|12|ft|m}}
 +
;Use "×" or ""x"":
 +
:<code><nowiki>{{convert|6|x|12|m|ft}}</nowiki></code> → {{convert|6|x|12|m|ft}}
 +
 
 +
In science, the formal way is to set <code>&#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|mm}}</nowiki></code> → {{convert|1|ft|3|in|mm}} <small>(to compare)</small>
 +
* <code><nowiki>{{convert|1|ft|3|in|x|3|ft|5|in|mm}}</nowiki></code> → {{convert|1|ft|3|in|x|3|ft|5|in|mm}}
 +
 
 +
==Words==
 +
===Spelling of unit name: UK ''metre'' or US ''meter''?===
 +
Default spelling of units is en-UK. To show en-US spelling, use {{para|sp|us}}:
 +
:<code><nowiki>{{convert|1|m|ft}}</nowiki></code> → {{convert|1|m|ft}} -- ''default''
 +
:<code><nowiki>{{convert|1|m|ft|sp=us}}</nowiki></code> → {{convert|1|m|ft|sp=us}}
 +
 
 +
===Spell out numbers: ''ten miles''===
 +
To write a number in words, use {{para|spell|in}}:
 +
:<code><nowiki>{{convert|10|mi|m|spell=in}}</nowiki></code> → {{convert|10|mi|m|spell=in}}
 +
 
 +
To make first letter a capital, use {{para|spell|In}}
 +
:<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|4|acre||adj=pre|planted}}</nowiki></code> → {{convert|4|acre||adj=pre|planted}}
 +
 
 +
===Extra adjective words: ''A {{convert|10|ft|ft|adj=mid|-long|disp=out|order=flip}} corridor''===
 +
:<code><nowiki>{{convert|4|ft|m|adj=mid|-long}}</nowiki></code> → {{convert|10|ft|m|adj=mid|-long}}
 +
 
 +
===Grammatical construction: ''The 18-, 24- and 32-pounder (8, 11 and 15 kg) cannons''===
 +
: "''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 {{tl|convert}}. However, it can be made in three steps.
 +
:'''Step 1:''' Enter the input numbers and units in {{tl|convert}} just to get the calculated output:
 +
:*<code><nowiki>had {{convert|18 |, |24 |, |32 |lb |kg |0 }} cannons</nowiki></code>
 +
::→ 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 {{tl|convert|...}} template.
 +
:For this, '''add&nbsp;<code>subst:</code> to the template name''' (for 'substitute') :
 +
:*<code><nowiki>had {{</nowiki>'''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'''.
 +
::→ 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 {{tl|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'''-''','''_'''24'''-_and_'''32'''-'''pound'''er''' (8,&amp;nbsp;11'''_and_'''15&amp;nbsp;kg) cannons </code>
 +
:After saving your edit, it shows:
 +
::→ "had 18-, 24- and 32-pounder (8,&nbsp;11&nbsp;and 15&nbsp;kg) cannons".
 +
 
 +
==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.
 +
 
 +
To illustrate, these are trivial calculations (from meter to meter), showing the multiplication factor:
 +
* {{convert|12|Gm|m|abbr=on}}
 +
* {{convert|12|μm|m|abbr=on}}
 +
 
 +
The prefix can be added before the SI unit (here: unit <code>m</code> for meter):
 +
* <code><nowiki>{{convert|12|Gm|mi|abbr=on}}</nowiki></code> → {{convert|12|Gm|mi|abbr=on}}
 +
* <code>Mm</code>: {{convert|12|Mm|mi|abbr=on}}
 +
* <code>km</code>: {{convert|12|km|ft|abbr=on}}
 +
* <code>mm</code>: {{convert|12|mm|in|abbr=on}}
 +
* <code>μm</code>: {{convert|12|μm|mm|abbr=on}}
 +
* <code>um</code>: {{convert|12|um|mm|abbr=on}} (letter "u" can be used for "μ" here)
 +
 
 +
The prefix can be used in the output unit:
 +
* <code><nowiki>{{convert|12000|mi||Mm|abbr=on}}</nowiki></code> → {{convert|12000|mi|Mm|abbr=on}}
 +
* <code><nowiki>{{convert|12|in|μm|abbr=on}}</nowiki></code> → {{convert|12|in|μm|abbr=on}}
 +
 
 +
As an exception, the non-SI unit "inch" can have the "μ" prefix  too)
 +
* <code><nowiki>{{convert|12|μm|μin|abbr=on}}</nowiki></code> → {{convert|12|μm|μin|abbr=on}}
 +
 
 +
===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>{{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}}
 +
*<s><code><nowiki>{{convert|1 234 567|m|ft}}</nowiki></code> → {{convert|1 234 567|m|ft}}</s>
 +
 
 +
Set {{para|comma|off}} to remove the separator:
 +
*<code><nowiki>{{convert|1234567|m|ft|comma=off}}</nowiki></code> → {{convert|1234567|m|ft|adj=nocomma}}
 +
 
 +
Use {{para|comma|gaps}} to set digit grouping by gap (<code>&lt;space></code>) in larger numbers (thousands separator):
 +
*<code><nowiki>{{convert|1234567|m|ft}}</nowiki></code> → {{convert|1234567|m|ft}} <small>(To compare, default)</small>
 +
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps}}
 +
 
 +
Setting {{para|comma|5}} or {{para|comma|gaps5}} will only add the separator when the number of digits is 5 or more:
 +
*<code><nowiki>{{convert|1234|m|ft}}</nowiki></code> → {{convert|1234|m|ft}} (To compare, default)
 +
*<code><nowiki>{{convert|1234|m|ft|comma=5}}</nowiki></code> → {{convert|1234|m|ft|comma=5}}
 +
*<code><nowiki>{{convert|1234567|m|ft|comma=5}}</nowiki></code> → {{convert|1234567|m|ft|comma=5}}
 +
*<code><nowiki>{{convert|1234|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234|m|ft|comma=gaps5}}
 +
*<code><nowiki>{{convert|1234567|m|ft|comma=gaps5}}</nowiki></code> → {{convert|1234567|m|ft|comma=gaps5}}
 +
 
 +
==Output manipulation==
 +
===Brackets and separators: ''10 m [33 ft]''===
 +
Punctuation that distinguishes the two measurements is set by {{para|disp|}}.<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}}</nowiki></code> → {{convert|10|m|ft}} -- ''(&nbsp;) brackets are the default''
 +
:<code><nowiki>{{convert|10|m|ft|disp=sqbr}}</nowiki></code> → {{convert|10|m|ft|disp=sqbr}}
 +
:<code><nowiki>{{convert|10|m|ft|disp=comma}}</nowiki></code> → {{convert|10|m|ft|disp=comma}}
 +
:<code><nowiki>{{convert|10|m|ft|disp=or}}</nowiki></code> → {{convert|10|m|ft|disp=or}}
 +
 
 +
Setting {{para|disp|br}} will force a new line (<code>&lt;br></code>)
 +
 
 +
:<code><nowiki>{{convert|10|m|ft|disp=br}}</nowiki></code> → {{convert|10|m|ft|disp=br}}
 +
Setting {{para|disp|x{{!}}...}} allows any text as separator:
 +
 
 +
:<code><nowiki>{{convert|10|m|ft|disp=x|_MyText_}}</nowiki></code> → {{convert|10|m|ft|disp=x|_MyText_}} -- <small>(To display spaces, use <code>&amp;nbsp;</code>)</small>
 +
 
 +
===Flipping (reordering) the two measurements: ''{{convert|1|mi|m|order=flip|sigfig=5|abbr=off}}'' ===
 +
Setting {{para|order|flip}} will flip (swap) the two measurements:
 +
:<code><nowiki>{{convert|1|mi|m}}</nowiki></code> → {{convert|1|mi|m|sigfig=5|abbr=off}} <small>(To compare, default)</small>
 +
:<code><nowiki>{{convert|1|mi|m|order=flip}}</nowiki></code> → {{convert|1|mi|m|order=flip|sigfig=5|abbr=off}}<!-- Extra settings added to enhance the illustration. Don't know if this is ideal way of documenting. DePiep, August 2014. -->
 +
 
 +
When converting to multiple units, the effect is:
 +
:<code><nowiki>{{convert|10|km|mi nmi|order=flip}}</nowiki></code> → {{convert|10|km|mi nmi|order=flip|sigfig=5|abbr=off}}
 +
:<code><nowiki>{{convert|10|km|nmi mi|order=flip}}</nowiki></code> → {{convert|10|km|nmi mi|order=flip|sigfig=5|abbr=off}}
 +
 
 +
=== Displaying parts of the result: ''{{convert|2|cuyd|m3|abbr=values}}''===
 +
It is possible to display only parts of the conversion result:
 +
<!-- todo: describe effect of order=flip ("out" means 1st or 2nd measurement?) -->
  
−
<!--まだ赤リンクばかりだから省略
 
−
範囲の指定:
 
 
{| class="wikitable"
 
{| class="wikitable"
−
|'''Input'''||'''Displays as'''
+
! Convert !! Output !! Description
 
|-
 
|-
−
|<nowiki>{{convert|60|and|170|kg|lb}}</nowiki>||{{convert|60|and|170|kg|lb}}
+
| <code><nowiki>{{convert|2|cuyd|m3}}</nowiki></code> || {{convert|2|cuyd|m3}} || Default, to compare
 
|-
 
|-
−
|<nowiki>{{convert|60|to|170|kg|lb}}</nowiki>||{{convert|60|to|170|kg|lb}}
+
| <code><nowiki>{{convert|2|cuyd|m3|abbr=values}}</nowiki></code> || {{convert|2|cuyd|m3|abbr=values}} || Input and output numbers
 
|-
 
|-
−
|<nowiki>{{convert|60|to(-)|170|kg|lb}}</nowiki>||{{convert|60|to(-)|170|kg|lb}}
+
| <code><nowiki>{{convert|2|cuyd|m3|disp=unit}}</nowiki></code> || {{convert|2|cuyd|m3|disp=unit}} || Input unit
 
|-
 
|-
−
|<nowiki>{{convert|60|-|170|kg|lb}}</nowiki>||{{convert|60|-|170|kg|lb}}
+
| <code><nowiki>{{convert|2|cuyd|m3|disp=unit|adj=on}}</nowiki></code> || {{convert|2|cuyd|m3|disp=unit|adj=on}} || Input unit, adjective (hyphenated)
 
|-
 
|-
−
|<nowiki>{{convert|60|by|120|m|ft}}</nowiki>||{{convert|60|by|120|m|ft}}
+
| <code><nowiki>{{convert|2|cuyd|cuyd|0|disp=out|abbr=off}}</nowiki></code> || {{convert|2|cuyd|cuyd|0|disp=out|abbr=off}} || Input (''workaround'')
 
|-
 
|-
−
|<nowiki>{{convert|60|x|120|m|ft}}</nowiki>||{{convert|60|x|120|m|ft}}
+
| <code><nowiki>{{convert|2|cuyd|m3|disp=unit2}}</nowiki></code> || {{convert|2|cuyd|m3|disp=unit2}} || Output unit (symbol)
 
|-
 
|-
−
|<nowiki>{{convert|60|+/-|10|m|ft}}</nowiki>||{{convert|60|+/-|10|m|ft}}
+
| <code><nowiki>{{convert|2|cuyd|m3|disp=unit2|abbr=off}}</nowiki></code> || {{convert|2|cuyd|m3|disp=unit2|abbr=off}} || Output unit (name)
−
|}-->
+
−
 
+
−
===変換精度===
+
−
変換後の精度は入力の精度に依存します。
+
−
 
+
−
{| class="wikitable"
+
−
!入力の精度!!記述例!!表示
+
 
|-
 
|-
−
|1||<nowiki>{{convert|1|R|K}}</nowiki>||{{convert|1|R|K}}
+
| <code><nowiki>{{convert|2|cuyd|m3|disp=number}}</nowiki></code> || {{convert|2|cuyd|m3|disp=number}} || Output value
 
|-
 
|-
−
|1.0000||<nowiki>{{convert|1.0000|R|K}}</nowiki>||{{convert|1.0000|R|K}}
+
| <code><nowiki>{{convert|2|cuyd|m3|disp=out}}</nowiki></code> || {{convert|2|cuyd|m3|disp=out}} || Output value and unit
 
|-
 
|-
−
|1.00000000||<nowiki>{{convert|1.00000000|R|K}}</nowiki>||{{convert|1.00000000|R|K}}
+
| <code><nowiki>{{convert|2|cuyd|m3|disp=out|abbr=off}}</nowiki></code> || {{convert|2|cuyd|m3|disp=ou|abbr=offt}} || Output value and unit
 
|}
 
|}
  
−
==英語版から移植する場合の注意==
+
==Table options==
−
*通常の移植と同様に、[[Wikipedia:FAQ 翻訳]]、[[Wikipedia:翻訳のガイドライン]]をよくお読みのうえ、要約欄に必要事項を記載してください。以下はそれに付け加えての注意です。
+
For the 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> → {{convert|10|m|ft|disp=table}}
  
−
*[[:en:Template:Convert/ft]](21:37, 29 March 2008の版)を例にとると、ソースは
+
{{para|disp|tablecen}} does the same, and also centers the text:
−
::<nowiki>{{convert/{{#ifeq:{{{4}}}|in|and/in|{{{d}}}}}|{{{1}}}|{{{2|}}}|{{{3|}}}|{{{4|}}}|{{{5|}}}|{{{6|}}}|s={{{s|}}}|r={{{r}}}|d={{{d}}}</nowiki>
+
:<code><nowiki>{{convert|20|m|ft|disp=tablecen}}</nowiki></code> → {{convert|20|m|ft|disp=tablecen}}
−
::|u=ft
+
 
−
::|n=foot
+
The units are added as a column header:
−
::|l=feet
+
:{| class=wikitable
−
::|t=Foot (length)
+
! style="width:10em;" | &nbsp;
−
::|o=m
+
! style="width:10em;" | m
−
::|b=0.3048
+
! style="width:10em;" | ft
−
::|j=-0.515985037-{{{j|0}}}}}<nowiki><noinclude>{{pp-template|small=yes}}</nowiki>
+
−
::<nowiki>[[Category:Subtemplates of Template Convert]]</nowiki>
+
−
::<nowiki></noinclude></nowiki>
+
−
:となっています。そのままコピーしても一応動作しますが、
+
−
:*<nowiki>{{pp-template}}または{{pp-template|small=yes}}</nowiki>は、英語版で「影響が大きいため保護されているテンプレート」を意味しますので、日本語版では削除してください。（現在のところ、日本語版の<nowiki>{{pp-template}}</nowiki>は「何もしない」設定になっています。）
+
−
:*tで始まる引数（上の例では「t=Foot (length)」）は、単位の説明記事への内部リンクの記事名ですので、これは日本語版の相当する記事名（上の例では「[[フィート]]」）に変更する必要があります。引数tがない場合には引数nの文字で代用されます。
+
−
:*nで始まる引数とlで始まる引数（上の例では「n=foot」と「l=feet」）は、省略せずに（abbr=offで）書いた場合の表示単位です。引数nは結果が1（単数）の場合、引数lは結果が1以外の場合に表示されます。引数lを省略した場合で、結果が1以外の場合には、単位の末尾に複数形の「s」が付きます。そのため、引数nを日本語に訳す場合には、必ず引数lも定義してください(通常は引数nと同じ文字でよい)。
+
−
:*<nowiki><noinclude></noinclude></nowiki>の間に、英語版への言語間リンクを記載してください。
+
−
:*上記の例の場合、例えば
+
−
::<nowiki>{{convert/{{#ifeq:{{{4}}}|in|and/in|{{{d}}}}}|{{{1}}}|{{{2|}}}|{{{3|}}}|{{{4|}}}|{{{5|}}}|{{{6|}}}|s={{{s|}}}|r={{{r}}}|d={{{d}}}</nowiki>
+
−
::|u=ft
+
−
::|{{font|color=red|n=フィート}}
+
−
::|{{font|color=red|l=フィート}}
+
−
::|{{font|color=red|t=フィート}}
+
−
::|o=m
+
−
::|b=0.3048
+
−
::|j=-0.515985037-{{{j|0}}}}}<nowiki><noinclude></nowiki>
+
−
::<nowiki>[[Category:Subtemplates of Template Convert]]</nowiki>
+
−
::{{font|color=red|<nowiki>[[en:Template:Convert/ft]]</nowiki>}}
+
−
::<nowiki></noinclude></nowiki>
+
−
:とするとよいでしょう。
+
−
<!--
+
−
===Tricks===
+
−
{| class="wikitable"
+
 
|-
 
|-
−
! colspan="2" | <big>'''In order to...'''</big>
+
| {{para|disp|table}}
 +
| {{convert|10|m|ft|disp=table}}
 
|-
 
|-
−
| Use [[United States|US]] spelling || attach <code><nowiki>|sp=us</nowiki></code>
+
|{{para|disp|tablecen}}
 +
| {{convert|20|m|ft|disp=tablecen}}
 
|-
 
|-
−
| Make units [[Wikipedia:Manual of Style (links)|wikilinked]] || attach <code><nowiki>|lk=on</nowiki></code> to link all units<br> attach <code><nowiki>|lk=in</nowiki></code> to link only the input units<br> attach <code><nowiki>|lk=out</nowiki></code> to link only the output units<br>(The [[Wikipedia:Only make links that are relevant to the context|manual of style]] suggests that you should not link common units of measurement).
+
|{{para|disp|&lt;other>}} <small>(default)</small>
 +
|{{convert|30|m|ft|disp=}}
 +
|}
 +
 
 +
===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).
 +
 
 +
:<nowiki>{{convert|10|m|ft|disp=table|sortable=on}}</nowiki> →
 +
<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
 
|-
 
|-
−
| Use the adjective form || attach <code><nowiki>|adj=on</nowiki></code> (e.g. "The 190-foot (58 m) bridge" as opposed to "The 190 feet..."). This produces the adjective form—the unit name in the singular with a hyphen (according to the [[WP:HYPHEN|Manual of Style]]).
+
| {{convert|15+3/4|m|ft|disp=table|sortable=on}}
 
|-
 
|-
−
| Abbreviate all units || attach <code><nowiki>|abbr=on</nowiki></code>
+
| {{convert|15.5|m|ft|disp=table|sortable=on}}
 
|-
 
|-
−
| Use a / instead of ( ) || attach <code><nowiki>|disp=s</nowiki></code> (or  <code><nowiki>|disp=/</nowiki></code>) (e.g. 190&nbsp;foot/58&nbsp;metre).  Note that when using slashes all unit names either spelt out in full or abbreviated (where there exists an abbreviation).
+
| {{convert|16.0|m|ft|disp=table|sortable=on}}
 
|-
 
|-
−
| Use in a table || attach <code><nowiki>|disp=table</nowiki></code> Note: For use in tables the template must start on a new line after a pipe.  Only the number will be displayed unless you set <code><nowiki>|abbr=on</nowiki></code>, <code><nowiki>|lk=on</nowiki></code>, <code><nowiki>|lk=in</nowiki></code> or <code><nowiki>|lk=out</nowiki></code>. Example: [[Phnom_Penh#Highways_in_Phnom_Penh|here]]
+
| {{convert|16|m|ft|disp=table|sortable=on}}
−
|-
+
−
| Round to a specified number of significant figures|| attach <code><nowiki>|sigfig={some non-negative integer}</nowiki></code>. In the case of temperatures Celsius or Fahrenheit this refers to the difference with the absolute-zero temperature. For example, at room temperature two significant digits means rounded to tens of degrees.
+
−
|-
+
−
| Let ''Convert'' decide the unit to convert to|| skip the ''convert to'' parameter (which would otherwise be third unnamed parameter) e.g. <code><nowiki>{{convert|100|mi|0}}</nowiki></code> gives ''{{convert|100|mi|0}}''.
+
 
|}
 
|}
  
−
===Rounding===
+
==Parameter list==
−
''Convert'' supports four types of rounding.
+
{{convert/doc/parameter list}}
−
;Rounding to a given precision
+
−
:Specify the desired precision with the fourth unnamed parameter or third unnamed parameter in the case where the ''convert to'' parameter is skipped (see above).  The conversion is rounded off to the nearest power of 1/10 this number.  For instance, if the result is 8621 and the round number is '-2', the result will be 8600.  If the result is '234.0283043' and the round number is '0', the result will be 234.
+
−
 
+
−
;Rounding to a given number of significant figures
+
−
:Specify the desired number of significant figures using <code><nowiki>|sigfig={some non-negative integer}</nowiki></code> as noted above.
+
−
 
+
−
;Combine both of the above
+
−
:If both the desired precision and the desired number of significant figures are specified, the conversion will be rounded to the least precise of these.
+
−
 
+
−
;Default rounding
+
−
:If neither the desired precision nor the desired number of significant figures are specified, the conversion will be rounded either to a comparable precision as the input value (the number of decimals remains the same if the conversion is a multiplication by a number between 0.2 and 2, is decreased by 1 if the factor is between 2 and 20, etc.) or to two significant figures whichever is the most precise.  An exception to this is temperature wherein 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 kelvin, whichever is the most precise.
+
−
 
+
−
==Units supported by <nowiki>{{Convert}}</nowiki>==
+
−
The table below lists units supported by this template.  It is divided up according to the quantity being measured.  Not all supported units are listed here, there are links to complete lists for each quantity.
+
−
 
+
−
The codes listed in the ''code'' column (column 3) are accepted as input by the template.
+
−
These can be used as the second or third unnamed parameter.  For some units there exist alternative codes. These are listed in brackets and have been incorporated to make the code more flexible for editors, e.g. °F ''or'' F may be entered.
+
−
 
+
−
The codes listed in the ''combinations'' column (column 7) can be used to produce multiple conversions.  They can only be used as the third unnamed parameter, e.g. <code><nowiki>{{convert|55|nmi|km mi}}</nowiki></code> produces ''{{convert|55|nmi|km mi}}''.
+
−
 
+
−
Without box: [[Template:Convert/list of units]].
+
−
 
+
−
<div style="height: 400px; overflow: auto; padding: 3px; border:1px solid #AAAAAA; reflist4" >
+
−
{{Convert/list of units}}
+
−
</div>
+
−
 
+
−
==Example/monitor page==
+
−
Monitor quality or look at examples at [[Template:Convert/check]]
+
  
−
==See also==
 
−
* {{tl|Inflation}} template for calculating inflated prices in USA, UK and other countries.
 
−
-->
 
 
<includeonly>
 
<includeonly>
−
{{#ifeq:{{#titleparts:{{FULLPAGENAME}}|1|}}|Template:Convert2
+
[[Category:Formatting and function templates‎]]
−
|{{Navbox Convert|2}}
+
−
|{{Navbox Convert|1}}
+
−
}}
+
−
<!-- カテゴリーはここに記載する -->
+
−
{{DEFAULTSORT:Convert}}
+
−
[[Category:単位関連のテンプレート]]
+
−
[[Category:数学関数テンプレート]]
+
−
[[Category:特殊効果テンプレート]]
+
−
[[Category:変換テンプレート]]
+
 
</includeonly>
 
</includeonly>

Revision as of 01:35, 11 April 2020

Contents

Units of measurement usage on Wikivoyage

Format and conventions used for units can be found at Wikivoyage:Measurements.

To ensure units are displayed correctly, the simplified individual template should be used.

The Convert template can be used in cases where standard format is not optimum.

Simplified unit of measurement templates

Convert template usage

Template {{convert}} calculates measurements from one unit (you can enter) to another one, and then presents the results. For example:

{{convert|2|km|mi}} → 2 kilometres (1.242742384 mi)
{{convert|7|mi|km}} → 7 miles (11.265408 km)

Multiple formatting and calculation options are listed below.

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

By default, the first value shows unit name, the second the symbols (= abbreviation). Use |abbr=on/off to change this behaviour:

{{convert|1|lb|kg}} → 1  (Expression error: Missing operand for *. ) (To compare; default: first value shows unit name)
{{convert|1|lb|kg|abbr=on}} → 1  (Expression error: Missing operand for *. )
{{convert|1|lb|kg|abbr=off}} → 1  (Expression error: Missing operand for *. )
  • |abbr=in toggles the default behaviour (|abbr=out):
{{convert|1|lb|kg|abbr=in}} → 1  (Expression error: Missing operand for *. )

Adjective: a 10-mile distance

Use |adj=on to produce the adjective form. The difference:

{{convert|10|mi|km}} to go → 10 miles (16.09344 km) to go. (To compare, default)
A {{convert|10|mi|km|adj=on}} distance → A 10 miles (16.09344 km) distance. (Adjective form)

Rounding: 100 ft is 30 m or 30.5 m or 30.48 m?

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

Default rounding

By default, the conversion result will be rounded either to precision comparable to that of the input value (the number of digits after the decimal point—or the negative of the number of non-significant zeroes before the point—is increased by one if the conversion is a multiplication by a number between 0.02 and 0.2, remains the same if the factor is between 0.2 and 2, is decreased by 1 if it is between 2 and 20, and so on) or to two significant figures, whichever is more precise. An exception to this is rounding temperatures (see below).
Examples of rounding
Input Displays as Note
{{convert|123|ft|m|-1}} 123 feet (40 m)
{{convert|123|ft|m|0}} 123 feet (37 m)
{{convert|123|ft|m|1}} 123 feet (37.5 m)
{{convert|550|ft|m|0}} 550 feet (168 m) Approximate value is 167.64 m
{{convert|550|ft|m}} 550 feet (167.64 m) Rounds to 170, when approximate value is 167.64 m
{{convert|500|ft|m|0}} 500 feet (152 m) Approximate value is 152.4 m
{{convert|500|ft|m}} 500 feet (152.4 m) Rounds to 150, when approximate value is 152.4 m

Convert supports four types of rounding:

Round to a given precision: use |precision=

Specify the desired precision with the fourth unnamed parameter (or third unnamed parameter if the "convert to" parameter is omitted; or fifth unnamed parameter if a range is specified; or fourth unnamed parameter again if a range is specified and the "convert to" parameter is omitted; needs to be replaced with a "precision" named parameter). The conversion is rounded off to the nearest power of 1/10 this number. For instance, if the result is 8621 and the round number is "-2", the result will be 8600. If the result is "234.0283043" and the round number is "0", the result will be 234.

Round to a given number of significant figures: use |sigfig=

To specify the output number to be with n significant figures use |sigfig=<number>:

  • To compare: {{convert|1200|ft|m}} → 1,200 feet (365.76 m)
  • {{convert|1200|ft|m|sigfig=4}} → 1,200 feet (365.76 m)
  • {{convert|1200|ft|m|sigfig=3}} → 1,200 feet (365.76 m)
  • {{convert|1200|ft|m|sigfig=2}} → 1,200 feet (365.76 m)
  • {{convert|1200|ft|m|sigfig=1}} → 1,200 feet (365.76 m)

Setting |sigfig= is meaningless

  • {{convert|1200|ft|m|sigfig=0}} → 1,200 feet (365.76 m)

Round to a multiple of 5: 15, 20, 25, ...

Using |round=5 rounds the outcome to a multiple of 5.

{{convert|10|m|ft}} → 10 metres (32.808399 ft)
{{convert|10|m|ft|round=5}} → 10 metres (32.808399 ft)

Similar: using |round=25 rounds the outcome to a multiple of 25.

{{convert|10|m|ft}} → 10 metres (32.808399 ft)
{{convert|10|m|ft|round=25}} → 10 metres (32.808399 ft)
To compare: {{convert|10|m|ft|sigfig=4}} → 10 metres (32.808399 ft)

In a range, one can round each value individually to the default. Use |round=each:

{{convert|10 x 200 x 3000|m|ft}} → 10 x 200 x 3,000 metres (Expression error: Unrecognized word "x". ft)
{{convert|10 x 200 x 3000|m|ft|round=each}} → 10 x 200 x 3,000 metres (Expression error: Unrecognized word "x". ft)

Round to a multiple of a given fraction: 2 3/16 inch

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

{{convert|5.56|cm|in|frac=16}} → 5.56 centimetres (2.18897637572 in)
{{convert|8|cm|in|frac=4}} → 8 centimetres (3.149606296 in)

The fraction is reduced when possible:

{{convert|8|cm|in|frac=100}} → 8 centimetres (3.149606296 in)
{{convert|8|cm|in}} → 8 centimetres (3.149606296 in) (To compare)

Template:AnchorRounding the temperatures °C, °F and K

In temperatures, the conversion will be rounded either to precision comparable to that of the input value or to that which would give three significant figures when expressed in kelvins, whichever is more precise.

{{convert|10|C|F K}} → 10 °C (Expression error: Missing operand for *. )

Note

For a temperature difference, like to convert "A rise of 20 °C", use |C-change=20 &tc.
{{convert|20|C-change|F-change K-change}} → A rise of 20  (Expression error: Missing operand for *. )
To compare: "A temperature of 20 °C" would yield: A temperature of 20 °C (Expression error: Missing operand for *. )

Into multiple units: 10 °C (Expression error: Missing operand for *. )

Separate the multiple output units by a space:

{{convert|10|C|F K}} → 10 °C (Expression error: Missing operand for *. )
{{convert|5|km|mi nmi}} → 5 kilometres (Expression error: Missing operand for *. )

Ranges of values

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

Multiple dimensions: 6  (Expression error: Unexpected round operator. )

Use "by"
{{convert|6|by|12|ft|m}} → 6  (Expression error: Unexpected round operator. )
Use "×" or ""x""
{{convert|6|x|12|m|ft}} → 6  (Expression error: Unexpected round operator. )

In science, the formal way is to set |x| and |abbr=on (keeping dimensions right, like in area = x km2):

{{convert|6|x|12|m|ft|abbr=on}} → 6  (Expression error: Unexpected round operator. )

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:

  • {{convert|1|ft|3|in|mm}} → 1 foot (Expression error: Unexpected round operator. ) (to compare)
  • {{convert|1|ft|3|in|x|3|ft|5|in|mm}} → 1 foot (Expression error: Unexpected round operator. )

Words

Spelling of unit name: UK metre or US meter?

Default spelling of units is en-UK. To show en-US spelling, use |sp=us:

{{convert|1|m|ft}} → 1 metre (3.2808399 ft) -- default
{{convert|1|m|ft|sp=us}} → 1 meter (3.2808399 ft)

Spell out numbers: ten miles

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

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

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

{{convert|10|mi|m|spell=In}} → 10 miles (16,093.44 m)

Extra words: 4 planted acres

Incomplete section
{{convert|4|acre||adj=pre|planted}} → 4 acres (Expression error: Unexpected round operator. )

Extra adjective words: A 10 feetExpression error: Unexpected round operator. ft corridor

{{convert|4|ft|m|adj=mid|-long}} → 10 feet (Expression error: Unrecognized word "long". m)

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

"The American defenders had 18-, 24- and 32-pounder (8, 11 and 15 kg) cannons."

This formatted result is not possible straightforward by using {{convert}}. However, it can be made in three steps.

Step 1: Enter the input numbers and units in {{convert}} just to get the calculated output:
  • had {{convert|18 |, |24 |, |32 |lb |kg |0 }} cannons
→ had 18  (Expression error: Unexpected round operator. ) 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 {{convert}} template.
For this, add subst: to the template name (for 'substitute') :
  • had {{subst:convert|18 |, |24 |, |32 |lb |kg |0 }} cannons
As a check: the preview result should show the conversion correct, with the numbers still right.
Now save this.
→ had 18, 24, 32 pounds (8, 11, 15 kg) cannons
Step 3: When opening the edit screen again, you'll see that the text is there in code. The template {{convert}} itself has disappeared. You can change the text as needed. The edit screen text is:
had 18,&nbsp;24,&nbsp;32 pounds (8,&nbsp;11,&nbsp;15&nbsp;kg) cannons
You can edit this text to add the grammar:
  • had 18-,_24-_and_32-pounder (8,&nbsp;11_and_15&nbsp;kg) cannons
After saving your edit, it shows:
→ "had 18-, 24- and 32-pounder (8, 11 and 15 kg) cannons".

Numbers

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

Units can have an SI prefix like G before the unit: Gm, and giga before the name: gigameter. These are plain multiplication factors.

To illustrate, these are trivial calculations (from meter to meter), showing the multiplication factor:

  • 12  (Expression error: Missing operand for *. m)
  • 12  (Expression error: Missing operand for *. m)

The prefix can be added before the SI unit (here: unit m for meter):

  • {{convert|12|Gm|mi|abbr=on}} → 12  (Expression error: Missing operand for *. mi)
  • Mm: 12  (Expression error: Missing operand for *. mi)
  • km: 12 km (39,370.0788 ft)
  • mm: 12 mm (0.4724409444 in)
  • μm: 12  (Expression error: Missing operand for *. mm)
  • um: 12  (Expression error: Missing operand for *. mm) (letter "u" can be used for "μ" here)

The prefix can be used in the output unit:

  • {{convert|12000|mi||Mm|abbr=on}} → 12,000 mi (Expression error: Missing operand for *. )
  • {{convert|12|in|μm|abbr=on}} → 12 in (Expression error: Missing operand for *. )

As an exception, the non-SI unit "inch" can have the "μ" prefix too)

  • {{convert|12|μm|μin|abbr=on}} → 12  (Expression error: Missing operand for *. )

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:

  • {{convert|1,234,567|m|ft}} → 1,234,567 metres (Expression error: Unrecognized punctuation character ",". ft)
  • {{convert|1,234,567|m|ft}} → 1,234,567 metres (Expression error: Unrecognized punctuation character ",". ft)
  • {{convert|1 234 567|m|ft}} → 1 234 567 metres (Expression error: Unexpected number. ft)

Set |comma=off to remove the separator:

  • {{convert|1234567|m|ft|comma=off}} → 1,234,567 metres (4,050,416.6728233 ft)

Use |comma=gaps to set digit grouping by gap (<space>) in larger numbers (thousands separator):

  • {{convert|1234567|m|ft}} → 1,234,567 metres (4,050,416.6728233 ft) (To compare, default)
  • {{convert|1234567|m|ft|comma=gaps}} → 1,234,567 metres (4,050,416.6728233 ft)

Setting |comma=5 or |comma=gaps5 will only add the separator when the number of digits is 5 or more:

  • {{convert|1234|m|ft}} → 1,234 metres (4,048.5564366 ft) (To compare, default)
  • {{convert|1234|m|ft|comma=5}} → 1,234 metres (4,048.5564366 ft)
  • {{convert|1234567|m|ft|comma=5}} → 1,234,567 metres (4,050,416.6728233 ft)
  • {{convert|1234|m|ft|comma=gaps5}} → 1,234 metres (4,048.5564366 ft)
  • {{convert|1234567|m|ft|comma=gaps5}} → 1,234,567 metres (4,050,416.6728233 ft)

Output manipulation

Brackets and separators: 10 m [33 ft]

Punctuation that distinguishes the two measurements is set by |disp=.
Options are: b (the default), sqbr, comma, or, br, x|...:

{{convert|10|m|ft}} → 10 metres (32.808399 ft) -- ( ) brackets are the default
{{convert|10|m|ft|disp=sqbr}} → 10 metres32.808399 ft
{{convert|10|m|ft|disp=comma}} → 10 metres32.808399 ft
{{convert|10|m|ft|disp=or}} → 10 metres32.808399 ft

Setting |disp=br will force a new line (<br>)

{{convert|10|m|ft|disp=br}} → 10 metres32.808399 ft

Setting |disp=x|... allows any text as separator:

{{convert|10|m|ft|disp=x|_MyText_}} → 10 metresExpression error: Unrecognized punctuation character "_". ft -- (To display spaces, use &nbsp;)

Flipping (reordering) the two measurements: 1 mile (1,609.344 m)

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

{{convert|1|mi|m}} → 1 mile (1,609.344 m) (To compare, default)
{{convert|1|mi|m|order=flip}} → 1 mile (1,609.344 m)

When converting to multiple units, the effect is:

{{convert|10|km|mi nmi|order=flip}} → 10 kilometres (Expression error: Missing operand for *. )
{{convert|10|km|nmi mi|order=flip}} → 10 kilometres (Expression error: Missing operand for *. )

Displaying parts of the result: 2  (Expression error: Missing operand for *. )

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

Convert Output Description
{{convert|2|cuyd|m3}} 2  (Expression error: Missing operand for *. ) Default, to compare
{{convert|2|cuyd|m3|abbr=values}} 2  (Expression error: Missing operand for *. ) Input and output numbers
{{convert|2|cuyd|m3|disp=unit}} 2 Expression error: Missing operand for *.  Input unit
{{convert|2|cuyd|m3|disp=unit|adj=on}} 2 Expression error: Missing operand for *.  Input unit, adjective (hyphenated)
{{convert|2|cuyd|cuyd|0|disp=out|abbr=off}} 2 Expression error: Unexpected round operator.  Input (workaround)
{{convert|2|cuyd|m3|disp=unit2}} 2 Expression error: Missing operand for *.  Output unit (symbol)
{{convert|2|cuyd|m3|disp=unit2|abbr=off}} 2 Expression error: Missing operand for *.  Output unit (name)
{{convert|2|cuyd|m3|disp=number}} 2 Expression error: Missing operand for *.  Output value
{{convert|2|cuyd|m3|disp=out}} 2 Expression error: Missing operand for *.  Output value and unit
{{convert|2|cuyd|m3|disp=out|abbr=off}} 2 Expression error: Missing operand for *.  Output value and unit

Table options

For the 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 |disp=table splits the result over two columns:

{{convert|10|m|ft|disp=table}} → 10 metres32.808399 ft

|disp=tablecen does the same, and also centers the text:

{{convert|20|m|ft|disp=tablecen}} → 20 metres65.616798 ft

The units are added as a column header:

  m ft
|disp=table 10 metres32.808399 ft
|disp=tablecen 20 metres65.616798 ft
|disp=<other> (default) 30 metres (98.425197 ft)

Sorting

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

<templatestyles src="nowrap/core.css"/>10 metres32.808399 ft

This shows the hidden numerical sortkey:

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

m ft
15+3/4 metres17.460629925 ft
15.5 metres50.85301845 ft
16.0 metres52.4934384 ft
16 metres52.4934384 ft

Parameter list

Template:Convert/doc/parameter list


Retrieved from "https://www.teampedia.net/wiki/index.php?title=Template:Convert/doc&oldid=122227"