Help:Convert/parameter options
This page wants to give an elaborate overview of the {{convert}}} parameters and their options. It is a technical overview.
- Help:Convert units • Simplified list of some commonly used units.
- Help:Convert messages • Error and warning messages.
Units
[edit source]- Help:Convert units • Simplified list of some commonly used units
- Module:Convert/documentation/conversion data/doc • Full list of units
Rounding
[edit source]By default, the output value is rounded to adjust its precision to match that of the input. An input such as 1234 is interpreted as 1234 ± 0.5, while 1200 is interpreted as 1200 ± 50, and the output value is displayed accordingly, taking into account the scale factor used in the conversion.
If the default is not wanted, the precision of output values can be specified using:
|N(whereNis a number) to specify the number of digits to be displayed after the decimal mark (round output to N decimal places)|-N(where-Nis a negative number) to specify the number of digits before the decimal mark that should be replaced with zero (round output to nearest 10N).|sigfig=N(whereNis a positive number) to specify the number of significant digits (round output to N significant figures)|round=5to round the output to the nearest multiple of 5
Examples:
{{convert|1234|ft|m}}→ 1,234 feet (376 m){{convert|1234|ft|m|2}}→ 1,234 feet (376.12 m){{convert|1234|ft|m|-1}}→ 1,234 feet (380 m){{convert|1234|ft|m|round=5}}→ 1,234 feet (375 m){{convert|1234|ft|m|sigfig=2}}→ 1,234 feet (380 m){{convert|1234|ft|m|sigfig=4}}→ 1,234 feet (376.1 m){{convert|1230|ft|m}}→ 1,230 feet (370 m){{convert|1230|ft|m|0}}→ 1,230 feet (375 m){{convert|1230|ft|m|1}}→ 1,230 feet (374.9 m){{convert|5670|sqft}}→ 5,670 square feet (527 m2){{convert|5670|sqft|-2}}→ 5,670 square feet (500 m2)
Spell
[edit source]- Use US (en-US) spelling for unit names
Use |sp=us to specify that unit names should be displayed with US spelling:
{{convert|6|km}}→ 6 kilometres (3.7 mi){{convert|6|km|sp=us}}→ 6 kilometers (3.7 mi)
- Spell out numbers in words
Use |spell=in to specify that the input value should be spelled in words, or |spell=In (uppercase "I") to start with an uppercase letter:
{{convert|5|mi|km|spell=in}}→ five miles (8.0 km){{convert|5|mi|km|spell=in|abbr=off|0}}→ five miles (8 kilometres){{convert|5|mi|km|spell=In|0}}→ Five miles (8 km){{convert|5|mi|km|spell=In|abbr=off|0}}→ Five miles (8 kilometres){{convert|2+1/4|mi|km|abbr=off|0|spell=In}}→ Two and a quarter miles (4 kilometres){{convert|2+1/4|mi|km|abbr=off|0|spell=In|sp=us}}→ Two and a fourth miles (4 kilometers)
The input and output can be "flipped", as shown in these examples. Logically, the resulting first number is spelled:
{{convert|5|mi||0|order=flip|spell=in}}→ eight kilometres (5 mi){{convert|5|mi||0|order=flip|spell=In|abbr=off}}→ Eight kilometres (5 miles)
The "||" provides an empty output unit to mean "use the default".
Both input and output values can be spelled:
{{convert|5|mi|m|-2|spell=on|sp=us|abbr=off}}→ five miles (eight thousand meters){{convert|5|mi|m|-2|spell=On|sp=us|abbr=off}}→ Five miles (eight thousand meters)
Fractions
[edit source]An input value can be specified as a fraction.
{{convert|1/2|in|mm|1}}→ 1⁄2 inch (12.7 mm){{convert|1/2|in|mm|1|adj=on}}→ 1⁄2-inch (12.7 mm){{convert|2+1/2|in|mm|1}}→ 2+1⁄2 inches (63.5 mm){{convert|-2-1/4|in|mm|1}}→ −2+1⁄4 inches (−57.2 mm){{convert|1/2|in|mm|1|spell=in}}→ one-half inch (12.7 mm)
If two slashes are used, a horizontal fraction bar is used.
{{convert|1//2|in|mm|1}}→ 1/2 inch (12.7 mm){{convert|2+1//2|in|mm|1}}→ 2+1/2 inches (63.5 mm)
An output can be expressed with a fraction using |frac=N where N is the denominator. For example, |frac=8 rounds the output to the nearest eighth.
{{convert|219|mm|in|abbr=on}}→ 219 mm (8.6 in){{convert|219|mm|in|abbr=on|frac=2}}→ 219 mm (8+1⁄2 in){{convert|219|mm|in|abbr=on|frac=4}}→ 219 mm (8+1⁄2 in){{convert|219|mm|in|abbr=on|frac=8}}→ 219 mm (8+5⁄8 in){{convert|222|mm|in|abbr=on|frac=8}}→ 222 mm (8+3⁄4 in)
A fraction is applied to the output unit (if there is only one), or to non-SI units (if using a combination), except that if a precision is also specified, the fraction only applies to the hand unit.
{{convert|18.45|in|m|frac=2}}→ 18.45 inches (1⁄2 m){{convert|18.45|in|ft in hand cm|frac=2}}→ 18.45 inches (1+1⁄2 ft; 18+1⁄2 in; 4.2+1⁄2 hands; 46.9 cm){{convert|18.45|in|ft in hand cm|frac=2|1}}→ 18.45 inches (1.5 ft; 18.5 in; 4.2+1⁄2 hands; 46.9 cm)
Joins
[edit source]The |disp= ("display") option may be used to "join" the input and output, as shown in the following examples.
| Convert | Output | Description |
|---|---|---|
{{convert|2.4|m|ft}} |
2.4 metres (7.9 ft) | default |
{{convert|2.4|m|ft|disp=b}} |
2.4 metres (7.9 ft) | brackets (same as default) |
{{convert|2.4|m|ft|disp=sqbr}} |
2.4 metres [7.9 ft] | square brackets |
{{convert|2.4|m|ft|disp=or}} |
2.4 metres or 7.9 feet | or |
{{convert|2.4|m|ft|disp=comma}} |
2.4 metres, 7.9 ft | comma |
{{convert|2.4|m|ft|disp=br}} |
2.4 metres 7.9 feet |
"<br />", line break |
Ranges
[edit source]| Separator | Convert | Result | Notes |
|---|---|---|---|
-
|
{{convert|3|-|6|ft}}
|
3–6 feet (0.91–1.83 m) | Input can be hyphen (-) or en dash (–), output uses en dash |
– – (en dash)
|
{{convert|3|–|6|ft}}
|
3–6 feet (0.91–1.83 m) | |
and
|
{{convert|3|and|6|ft}}
|
3 and 6 feet (0.91 and 1.83 m) | |
and(-)
|
{{convert|3|and(-)|6|ft}}
|
3 and 6 feet (0.91–1.83 m) | |abbr=on abbreviates the first unit
|
and(-)|abbr=on
|
{{convert|3|and(-)|6|ft|abbr=on}}
|
3 and 6 ft (0.91–1.83 m) | |
or
|
{{convert|3|or|6|ft}}
|
3 or 6 feet (0.91 or 1.83 m) | |
to
|
{{convert|3|to|6|ft}}
|
3 to 6 feet (0.91 to 1.83 m) | |
to(-)
|
{{convert|3|to(-)|6|ft}}
|
3 to 6 feet (0.91–1.83 m) | |abbr=on abbreviates the first unit
|
to(-)|abbr=on
|
{{convert|3|to(-)|6|ft|abbr=on}}
|
3 to 6 ft (0.91–1.83 m) | |
to about
|
{{convert|3|to about|6|ft}}
|
3 to about 6 feet (0.91 to about 1.83 m) | |
+/-
|
{{convert|3|+/-|6|ft}}
|
3 ± 6 feet (0.91 ± 1.83 m) | |
± ±
|
{{convert|3|±|6|ft}}
|
3 ± 6 feet (0.91 ± 1.83 m) | |
+
|
{{convert|3|+|6|ft}}
|
3 + 6 feet (0.91 + 1.83 m) | |
,
|
{{convert|3|,|6|ft}}
|
3, 6 feet (0.91, 1.83 m) | |
, and
|
{{convert|3|, and|6|ft}}
|
3, and 6 feet (0.91, and 1.83 m) | |
, or
|
{{convert|3|, or|6|ft}}
|
3, or 6 feet (0.91, or 1.83 m) | |
by
|
{{convert|3|by|6|ft}}
|
3 by 6 feet (0.91 by 1.83 m) | |
x
|
{{convert|3|x|6|ft}}
|
3 by 6 feet (0.91 m × 1.83 m) | |abbr=on abbreviates and repeats the first unit
|
× ×
|
{{convert|3|×|6|ft}}
|
3 by 6 feet (0.91 m × 1.83 m) | |
x|abbr=on
|
{{convert|3|x|6|ft|abbr=on}}
|
3 ft × 6 ft (0.91 m × 1.83 m) | |
xx
|
|xx| is deprecated. Use |x| instead | ||
*
|
|*| is deprecated. Use |x| instead | ||
The following ranges provide different output when units are abbreviated.
| Convert | Output |
|---|---|
{{convert|3|and(-)|6|ft|abbr=on}} |
3 and 6 ft (0.91–1.83 m) |
{{convert|3|to(-)|6|ft|abbr=on}} |
3 to 6 ft (0.91–1.83 m) |
{{convert|3|x|6|ft|abbr=on}} |
3 ft × 6 ft (0.91 m × 1.83 m) |
Ranges can use more than two values.
| Convert | Output |
|---|---|
{{convert|3|x|4|x|24|in}} |
3 by 4 by 24 inches (76 mm × 102 mm × 610 mm) |
{{convert|3|x|4|to|6+1/2|x|8+3/4|in}} |
3 by 4 to 6+1⁄2 by 8+3⁄4 inches (76 mm × 102 mm to 165 mm × 222 mm) |
Ranges can be specified in the first parameter.
| Convert | Output |
|---|---|
{{convert|3.2-7.5|ha}} |
3.2–7.5 hectares (7.9–18.5 acres) |
{{convert|3x4x24|in}} |
3 by 4 by 24 inches (76 mm × 102 mm × 610 mm) |
Extra words
[edit source]Some options provide text that is included in the output, as shown in the following examples.
| Convert | Output | Description |
|---|---|---|
{{convert|4|ft||adj=mid|-long}} |
4-foot-long (1.2 m) | adjectival with mid-text between input and output |
{{convert|40|acre||adj=pre|planted}} |
40 planted acres (16 ha) | text before the input unit |
{{convert|4|m||disp=preunit|+ }} |
4+ metres (13+ ft) | same text before the input and output units |
{{convert|4|m||disp=preunit|+ |or more }} |
4+ metres (13 or more ft) | different text before the input and output units |
{{convert|20|impfloz||disp=x|, approximately }} |
20 imperial fluid ounces, approximately 570 ml; 19 US fl oz | text before the output (replaces the join) |
{{convert|100|m||disp=x|/day (|/day)}} |
100 metres/day (330 ft/day) | text before and after the output (replaces the join) |
In each of the above examples, "||" provides an empty output unit which causes the default output to be used. An output unit, possibly empty, must be specified to avoid the template interpreting the extra text as the output unit. For example, using {{convert|4|ft|adj=mid|-long}} has the same effect as using {{convert|4|ft|-long|adj=mid}}, namely that an error would occur because "-long" would be used as the output unit. The following illustrates the error (hover the mouse over the error text to see that the problem is due to "-long" ) and how it may be avoided.
{{convert|4|ft|adj=mid|-long}}→ 4-foot ([convert: unknown unit]){{convert|4|ft||adj=mid|-long}}→ 4-foot-long (1.2 m){{convert|4|ft| |adj=mid|-long}}→ 4-foot-long (1.2 m){{convert|4|ft|m|adj=mid|-long}}→ 4-foot-long (1.2 m)
Displaying parts of a convert
[edit source]The following examples show how to display only some part of the output result.
| Convert | Output | Description |
|---|---|---|
{{convert|2|cuyd|m3}} |
2 cubic yards (1.5 m3) | normal convert |
{{convert|2|cuyd|m3|abbr=values}} |
2 (1.5) | input and output values |
{{convert|2|cuyd|m3|disp=unit}} |
cubic yards | input unit |
{{convert|2|cuyd|m3|disp=unit|adj=on}} |
cubic-yard | input unit, adjectival (hyphenated) |
{{convert|2|cuyd|cuyd|0|disp=out|abbr=off}} |
2 cubic yards | input (workaround) |
{{convert|2|cuyd|m3|disp=unit2}} |
m3 | output unit (symbol) |
{{convert|2|cuyd|m3|disp=unit2|abbr=off}} |
cubic metres | output unit (name) |
{{convert|2|cuyd|m3|disp=number}} |
1.5 | output value |
{{convert|2|cuyd|m3|disp=out}} |
1.5 m3 | output value and unit |
{{convert|2|cuyd|m3|abbr=off|disp=out}} |
1.5 cubic metres | output value and unit |
Wrapping and line breaking
[edit source]Convert uses the regular space (" ") and non-breaking space ( which shows: " ") to control line-breaking (also called wrapping/nowrapping).
Wrapping is possible where a space (" ") is used. Prevent wrapping is enforced by using the non-breaking space, that ties and keeps text elements together.
3 feetmay break after "3"3 ft, or 3_ft, will not break after "3"
In the examples below, an is shown as "_" (red underscore): "3_ft".
A line break (<br/>) forces a newline (line break), and so overrules any nowrap setting at that point.
- Within a measurement (value+unit)
The separator between the value and the unit can be a space or a nonbreaking space ( ):
- When a unit is abbreviated (symbol is shown), the separator is
.
{{convert|12|m|ft|abbr=on}}→ 12_m (39_ft)
- When a unit is not abbreviated (name is shown), the separator is a space.
{{convert|12|m|ft}}→ 12 metres (39_ft)- This can be set (overruled) to be
by|adj=j(for 'join'). {{convert|12|m|ft|adj=j}}→ 12 metres (39_ft)*
- Some units do not have a symbol and always use a space (such as acre).
{{convert|3|acre|m2|abbr=on}}→ 3 acres (12,000_m2)
- Except, option
|adj=j("join") forces the separator to be .
{{convert|3|acre|m2|adj=j}}→ 3 acres (12,000_m2)*
- Except,
is always used when a measurement is in multiple units.
{{convert|1|ft|6|in|cm}}→ 1_foot 6_inches (46_cm){{convert|2|m|ftin}}→ 2 metres (6_ft 7_in)
- Except, if option
|adj=onis used and the unit is not abbreviated, the separator is a hyphen ("-").
{{convert|2|m|ftin|adj=on}}→ 2-metre (6_ft 7_in)
- When the name of a number is used,
is used as the separator between the value and the name. For example, a measurement spelled as "12 million metres" has before "million" and a space afterwards.
{{convert|12|e6m}}→ 12_million metres (39,000,000_ft)
- Between measurements
- A space is used as the separator in a join between the first and second measurement.
{{convert|3|ft|m}}→ 3 feet (0.91_m)
- Except for the special case before "[" :
{{convert|12|in|cm|disp=sqbr|abbr=on}}→ 12_in_[30_cm] ( before "[")
- Multiple output measurements (by listing units) always use a space between measurements ("; " has a space after ";").
{{convert|2|acre|m2 sqft ha}}→ 2 acres (8,100_m2; 87,000_sq_ft; 0.81_ha)
- Between components of a measurement (e.g., in a range; between foot–inch)
- A measurement in multiple units always uses a space between components ("1 foot 6 inches" has
before the unit names, but a space after "foot").
{{convert|1|ft|6|in|cm}}→ 1_foot 6_inches (46_cm)
- In a range, spaces are generally used to separate items. For example, "to" and "or" have a space before and after in the following.
{{convert|12|to|20|in|cm}}→ 12 to 20 inches (30 to 51_cm){{convert|12|or|20|in|cm}}→ 12 or 20 inches (30 or 51_cm)
- The ranges
+/-and,always use :
{{convert|12|+/-|2|in|cm}}→ 12_±_2 inches (30.5_±_5.1_cm){{convert|12|,|20|in|cm}}→ 12,_20 inches (30,_51_cm)
- The "to(-)" range is an exception. When a unit is not abbreviated, "to" has
before and a space after.
{{convert|12|to(-)|20|in|cm}}→ 12_to 20 inches (30–51_cm)
- The "x" range is an exception. When a unit is abbreviated, "×" has a space before and
after.
{{convert|12|x|20|in|cm}}→ 12 by 20 inches (30_cm ×_51_cm)
- Overrule by setting a line break
- Parameter
|disp=bradds a forced line break (<br/>) between measurements; brackets are omitted.
{{convert|12|m|ft|disp=br}}→ 12 metres
39 feet
- Preview wikicode
To see the wikicode result of the convert template: put your {{convert|...}} code into Special:ExpandTemplates and then preview by clicking OK.
Tables
[edit source]The following parameters are intended for use in tables.
| Parameter | Description |
|---|---|
|disp=table |
for a table cell with align="right"
|
|disp=tablecen |
for a table cell with align="center"
|
|sortable=on |
output a numeric hidden sort field for a sortable table |
The following shows the wikitext output by some example converts.
| Convert | Resulting wikitext |
|---|---|
{{convert|47.5|kg|lb}} |
47.5 kilograms (105 lb) |
{{convert|47.5|kg|lb|disp=table}} |
align="right"|47.5 |align="right"|105 |
{{convert|47.5|kg|lb|disp=tablecen}} |
align="center"|47.5 |align="center"|105 |
{{convert|47.5|kg|lb|sortable=on}} |
<span style="display:none">7001475000000000000</span>47.5 kilograms (105 lb) |
Fixed table
[edit source]This wikitext:
{|class="wikitable"
! align=right, rowspan="2" |
!colspan="2"| Length
!colspan="2"| Weight
|- style="vertical-align:bottom;"
!metres !!ft in !!kg !!lb
|-
! Lorem ipsum
| {{convert|28.1|m|ftin|disp=table}}
| {{convert|47.5|kg|lb|disp=table}}
|-
! Dolor sit amet
| {{convert|9.9|m|ftin|disp=table}}
| {{convert|74.1|kg|lb|disp=table}}
|-
! Consectetur
| {{convert|38.2|m|ftin|disp=table}}
| {{convert|31.5|kg|lb|disp=table}}
|-
! Adipisicing elit
| {{convert|18.7|m|ftin|disp=table}}
| {{convert|52.7|kg|lb|disp=table}}
|}
produces this table:
| Length | Weight | |||
|---|---|---|---|---|
| metres | ft in | kg | lb | |
| Lorem ipsum | 28.1 | 92 ft 2 in | 47.5 | 105 |
| Dolor sit amet | 9.9 | 32 ft 6 in | 74.1 | 163 |
| Consectetur | 38.2 | 125 ft 4 in | 31.5 | 69 |
| Adipisicing elit | 18.7 | 61 ft 4 in | 52.7 | 116 |
Sortable table
[edit source]This wikitext:
{|class="wikitable sortable"
! align=right, rowspan="2" |
!colspan="2"| Length
!colspan="2"| Weight
|- style="vertical-align:bottom;"
!metres !!ft in !!kg !!lb
|-
! Lorem ipsum
| {{convert|28.1|m|ftin|disp=table|sortable=on}}
| {{convert|47.5|kg|lb|disp=table|sortable=on}}
|-
! Dolor sit amet
| {{convert|9.9|m|ftin|disp=table|sortable=on}}
| {{convert|74.1|kg|lb|disp=table|sortable=on}}
|-
! Consectetur
| {{convert|38.2|m|ftin|disp=table|sortable=on}}
| {{convert|31.5|kg|lb|disp=table|sortable=on}}
|-
! Adipisicing elit
| {{convert|18.7|m|ftin|disp=table|sortable=on}}
| {{convert|52.7|kg|lb|disp=table|sortable=on}}
|}
produces this table:
| Length | Weight | |||
|---|---|---|---|---|
| metres | ft in | kg | lb | |
| Lorem ipsum | 28.1 | 92 ft 2 in | 47.5 | 105 |
| Dolor sit amet | 9.9 | 32 ft 6 in | 74.1 | 163 |
| Consectetur | 38.2 | 125 ft 4 in | 31.5 | 69 |
| Adipisicing elit | 18.7 | 61 ft 4 in | 52.7 | 116 |
Parameter list
[edit source]| Parameter | Value | Description | Note |
|---|---|---|---|
|abbr=in |
in
|
Use symbol for first (left-hand side) unit | Unit display |
|abbr=off |
off
|
Use name for all units | Unit display |
|abbr=on |
on
|
Use symbol for all units (default for {{cvt}})
|
Unit display |
|abbr=out |
out
|
Use symbol for right-hand side unit (default) | Unit display |
|abbr=unit |
unit
|
Same as abbr=on but only for units (e6km → "million km")
|
Unit display |
|abbr=values |
values
|
Show only the input and output numbers; omit units | Unit display |
|abbr=~ |
~
|
Shows both unit name and symbol for the input | Unit display |
|adj=mid|... |
mid
|
User-specified text after the input unit; sets adj=on (adjectival); requires one unnamed parameter
|
Word adding, adjectival |
|adj=on |
on
|
adjectival; unit name is singular and hyphenated | Grammar, adjectival |
|adj=pre|... |
pre
|
User-specified text before input unit (prefix); requires one unnamed parameter | Word adding |
|adj=ri0 |
ri0
|
Round input with precision 0 | Input precision |
|adj=ri1 |
ri1
|
Round input with precision 1 | Input precision |
|adj=ri2 |
ri2
|
Round input with precision 2 | Input precision |
|adj=ri3 |
ri3
|
Round input with precision 3 | Input precision |
|altitude_ft=N |
N
|
Specifies altitude in feet for a conversion with mach as the input unit | Qualifier |
|altitude_m=N |
N
|
Specifies altitude in metres for a conversion with mach as the input unit | Qualifier |
|comma=5 |
5
|
Only use comma for thousands separator if 5 or more digits | Number format |
|comma=gaps |
gaps
|
Use gaps (space), not comma, for thousands separator | Number format |
|comma=off |
off
|
No thousands separator (raw number) | Number format |
|disp=b |
b
|
Join input and output using " (...)" (default) | Join values |
|disp=sqbr |
sqbr
|
Join input and output using " [...]" | Join values |
|disp=br |
br
|
Join input and output using "<br />" | Join values |
|disp=br() |
br
|
Join input and output using "<br />(...)" | Join values |
|disp=comma |
comma
|
Join input and output using ", " | Join values |
|disp=semicolon |
semicolon
|
Join input and output using "; " | Join values |
|disp=or |
or
|
Join input and output using " or " | Join values |
|disp=(or) |
or
|
Join input and output using " (...)" but with "or" between outputs in a combination | Join values |
|disp=number |
number
|
Display output number only | Parts only |
|disp=output number only |
output number only
| ||
|disp=out |
out
|
Display only output number and name/symbol | Parts only |
|disp=output only |
output only
| ||
|disp=preunit|...[|...] |
preunit
|
Text to be inserted after value and before units, for both input and output, with optionally different text for output; requires 1 or 2 unnamed parameters | Word adding |
|disp=table |
table
|
Output is suitable for a table cell with align="right" | Table columns |
|disp=tablecen |
tablecen
|
Output is suitable for a table cell with align="center" | Table columns |
|disp=unit |
unit
|
Display input name/symbol only (not input number, not output) | Parts only |
|disp=unit2 |
unit2
|
Display output name/symbol only (not input; not output number) | Parts only |
|disp=x|... |
x
|
Join input and output using one (or two) unnamed parameter(s) before (and after) the output | Word adding |
|error=x |
any text
|
This has no effect if the conversion works; if a conversion error occurs, the result is x (and the original error message is suppressed) | Inside template |
|frac=N |
3⁄4 (e.g.)
|
Show number as a fraction with denominator N | Number format, fraction |
|frac=-N |
3/4 (e.g.)
|
Show number as a fraction with a horizontal bar | Number format, fraction |
|input=P2048 |
P2048 (e.g.)
|
Reads and converts a Wikidata property | Inside template |
|lk=in |
in
|
Link left-hand side unit name or symbol | Unit link |
|lk=on |
on
|
Link all unit names or symbols (but not twice for the same unit) | Unit link |
|lk=out |
out
|
Link right-hand side unit name or symbol | Unit link |
|order=flip |
flip
|
Swaps the order of the input and output measurements | Order |
|order=out |
out
|
Displays output units in the order entered, skipping input unit | Order |
|qid=Q1056131 |
Q1056131 (e.g.)
|
Specifies the Wikidata entity to be used with a property such as input=P2048
|
Inside template; testing |
|qual=Q613628 |
Q613628 (e.g.)
|
Specifies a statement qualifier for a Wikidata property | Qualify Wikidata property |
|round=N |
N
|
Rounds output value to nearest N which can be 0.5 or 5 or 10 or 25 or 50
|
Output precision |
|round=each |
each
|
In a range, round each number separately rather than selecting the same rounding precision | Output precision |
|sigfig=N |
N
|
Round output number to N significant figures (N is a positive integer) | Output precision |
|sortable=on |
on
|
Adds an invisible sort key | Table sort |
|sp=us |
us
|
Use U.S. spelling ("meter" instead of default "metre") | Spelling U.S. names |
|spell=in |
in
|
Spell input number in words | Spelling numbers |
|spell=In |
In
|
Spell input number in words with first letter uppercase | Spelling numbers |
|spell=on |
on
|
Spell input and output numbers in words | Spelling numbers |
|spell=On |
On
|
Spell input and output numbers in words with first letter uppercase | Spelling numbers |
|$=€ |
€
|
Replace $-sign with a currency sign, for example in €/hectare
|
Cost per unit No currency conversion happens |
|debug=yes |
yes
|
Debugging only. In a sortable table: show the normally hidden sort key | Table sort |
|disp=flip |
flip
|
Deprecated. Use |order=flip | Order |
|sing= |
Deprecated. Use |adj= | Plurals | |
Examples of number grouping:
{{convert|1234|m|ft}}→ 1,234 metres (4,049 ft){{convert|1234|m|ft|comma=5}}→ 1234 metres (4049 ft){{convert|12345|m|ft|comma=5}}→ 12,345 metres (40,502 ft){{convert|1234|m|ft|comma=gaps}}→ 1234 metres (4049 ft){{convert|1234|m|ft|comma=gaps5}}→ 1,234 metres (4,049 ft)*{{convert|1,234,567|m|ft|comma=gaps5}}→ 1,234,567 metres (4,050,417 ft)*{{convert|1,234,567|m|ft|comma=off}}→ 1234567 metres (4050417 ft)
Examples of spelling input values:
{{convert|10|mi|km|spell=in}}→ ten miles (16 km){{convert|10|mi|km|spell=In}}→ Ten miles (16 km){{convert|1/3|mi|km|adj=on|spell=in}}→ one-third-mile (0.54 km)
Differences from templates previously used
[edit source]Before December 2013, {{convert}} was implemented by a series of templates, not a module. Following are some differences between the new and old convert implementations.
- Using
{{subst:convert|...}}works with the module. - The module checks unit types and displays an error message if a mismatch occurs.
- Ranges and all options, including
order=flip, should work with all units. - Scaled units like
e6USgalare not predefined. With some exceptions, all units accept prefixes e3, e6, e9, e12, e15. - The module uses an empty unit code rather than
0to mean "use the default unit", as in{{convert|4|ft||adj=mid|-long}}(it is also possible to use{{convert|4|ft|0|adj=mid|-long}}, but that sets the output precision to zero). - The functionality of
{{convert/3}}and{{convert/4}}is handled by the module, except that the module does not support arbitrary text to separate items in a range. Furthermore, the predefined separator words such as "by" and "to" behave in exactly the same manner as they do for standard converts, so a conversion like{{convert/3|2|x|4|x|6|m|ft}}would need to use the new*separator rather thanxto produce exactly the same output with the module. - The module does not have a problem with template loops, and will allow pointless conversions like
{{convert|123|m|m}}.
Limitations
[edit source]This is a list of features that the module may be expected to support, but which will not work.
Composite units cannot be used in a range:
{{convert|2|ft|6|in|to|3|ft|9|in}}→ 2 feet 6 inches ([convert: unknown unit])*
If an expression is wanted, it has to use {{#expr:...}}:
{{convert|3*12|ft|mm}}→ 3×12 feet (910×3,660 mm){{convert|{{#expr:3*12}}|ft|mm}}→ 36 feet (11,000 mm)