convert
Template } calculates a measurement value (number × unit) into the same measurement by a different unit, and then presents the results, formatted.
Inyandikorugero documentation | See this information on copying this template and modifying it for use on another wiki. |
 | This template uses Lua: |
The complete list of unit symbols recognized by the template is here.
For example:
{{convert|2|km|mi}}→ 2 kilometres (1.2 mi) (km entered, converted into miles){{convert|7|mi|km}}→ 7 miles (11 km) (mi entered, converted into km)
Numbers can be rounded, units can be abbreviated into symbols:
{{convert|2|km|mi|2|abbr=on}}→ 2 km (1.24 mi){{convert|7|mi|km|2|abbr=on}}→ 7 mi (11.27 km)
Value ranges can be entered using |to|... or |-|...:
{{convert|2|to|5|km|mi}}→ 2 to 5 kilometres (1.2 to 3.1 mi){{convert|2|-|5|km|mi}}→ 2–5 kilometres (1.2–3.1 mi)
Combined effect example:
{{convert|2|-|5|km|mi|2|abbr=on}}→ 2–5 km (1.24–3.11 mi){{convert|2|and|5|km|mi|sigfig=3|abbr=off}}→ 2 and 5 kilometres (1.24 and 3.11 miles)
Units to convert
Enter units to convert from into:
{{convert|1|lb|kg}}→ 1 pound (0.45 kg)
- SI units generally accept prefixes, like "m" for milli (10−3), and "M" for mega (106)
- For "per" units, use "/" (slash): kg/ha (see § 'per' units: kg/ha and § Currency per unit: $/km)
- For three-unit units, etc., see Category:Convert-like templates
Unit name or symbol (abbreviation): 1 pound or 1 lb?
By default, the first quantity shows the unit name, the second shows the symbol (or abbreviation):
{{convert|1|lb|kg}}→ 1 pound (0.45 kg)
Using |abbr=in shows the symbol for first (left-hand side) unit, and the name instead of the symbol for the second unit:
{{convert|1|lb|kg|abbr=in}}→ 1 lb (0.45 kilograms)
To abbreviate both or neither:
{{convert|1|lb|kg|abbr=on}}→ 1 lb (0.45 kg){{convert|1|lb|kg|abbr=off}}→ 1 pound (0.45 kilograms)
Convenience: {{cvt}} has |abbr=on by default
Template {{cvt}} is the same as {{convert}}, except that it has |abbr=on as the default behavior. In {{cvt}}, all other options are available. So:
{{cvt|1|lb|kg}}→ Inyandikorugero:Cvt
is equivalent to:
{{convert|1|lb|kg|abbr=on}}→ Inyandikorugero:Cvt
Adjective: a 10-mile distance
Use |adj=on to produce the adjectival (hyphenated) form:
A {{convert|10|mi|km|adj=on}} distance→ A 10-mile (16 km) distance.
Default behavior, for comparison:
{{convert|10|mi|km}} to go→ 10 miles (16 km) to go.
|adj=on does not produce hyphens with unit symbols, as per Manual of Style:
A {{convert|9|in|cm|adj=on|abbr=on}} nail→ A 9 in (23 cm) nail.
Rounding: 100 ft is 30 m or 30.5 m or 30.48 m?
By definition, 100 ft equals 30.48 m. In practical use, it is common to round the calculated metric number. With that, there are several possibilities.
Default rounding
By {{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 digits, 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}} | 123 feet (37 m) | same output as with 0 (below) |
{{convert|123|ft|m|0}} | 123 feet (37 m) | |
{{convert|123|ft|m|1}} | 123 feet (37.5 m) | |
{{convert|123|ft|m|2}} | 123 feet (37.49 m) | The more-exact value is 37.4904 m or so, which gets converted to 37 m if this parameter is not specified at all. |
{{convert|500|ft|m|-1}} | 500 feet (150 m) | |
{{convert|500|ft|m}} | 500 feet (150 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) |
{{convert|500|ft|m|0}} | 500 feet (152 m) | |
{{convert|500|ft|m|1}} | 500 feet (152.4 m) | |
{{convert|500|ft|m|2}} | 500 feet (152.40 m) | exact value is 152.4 m |
{{convert|500|ft|cm|-3}} | 500 feet (15,000 cm) | |
{{convert|500|ft|cm}} | 500 feet (15,000 cm) | same output as with -3 (above), because the conversion factor is between 20 and 200 (hence, it should decrease input 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) |
{{convert|500|ft|cm|0}} | 500 feet (15,240 cm) | |
Convert supports four types of rounding:
Round to a given precision: use a 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 of 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.
Round to a given number of significant figures: |sigfig=
To specify the output number to be with n significant figures use |sigfig=:
{{convert|1200|ft|m|sigfig=4}}→ 1,200 feet (365.8 m){{convert|1200|ft|m|sigfig=3}}→ 1,200 feet (366 m){{convert|1200|ft|m|sigfig=2}}→ 1,200 feet (370 m){{convert|1200|ft|m|sigfig=1}}→ 1,200 feet (400 m)
Default behavior, for comparison:
{{convert|1200|ft|m}}→ 1,200 feet (370 m)
Setting |sigfig= to a value less than 1 is meaningless:
{{convert|1200|ft|m|sigfig=0}}→ 1,200 feet (370 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 (33 ft){{convert|10|m|ft|round=5}}→ 10 metres (35 ft)
Similar: using |round=25 rounds the outcome to a multiple of 25.
{{convert|10|m|ft}}→ 10 metres (33 ft){{convert|10|m|ft|round=25}}→ 10 metres (25 ft)
Default behavior, for comparison:
{{convert|10|m|ft|sigfig=4}}→ 10 metres (32.81 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 by 200 by 3,000 metres (33 ft × 656 ft × 9,843 ft){{convert|10 x 200 x 3000|m|ft|round=each}}→ 10 by 200 by 3,000 metres (33 ft × 660 ft × 9,800 ft)
Round to a multiple of a given fraction: 2+3⁄16 inch
Specify the desired denominator using |frac=. (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+3⁄16 in){{convert|8|cm|in|frac=4}}→ 8 centimetres (3+1⁄4 in)
The fraction is reduced when possible:
{{convert|8|cm|in|frac=100}}→ 8 centimetres (3+3⁄20 in)
Default behavior uses decimal notation:
{{convert|5.56|cm|in}}→ 5.56 centimetres (2.19 in)
Rounding 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.
{{convert|10,000|C|F K}}→ 10,000 °C (18,000 °F; 10,300 K){{convert|10,000.1|C|F K}}→ 10,000.1 °C (18,032.2 °F; 10,273.2 K){{convert|-272|C|F K}}→ −272 °C (−457.60 °F; 1.15 K){{convert|-272|C}}→ −272 °C (−457.60 °F){{convert|100|C|F K}}→ 100 °C (212 °F; 373 K){{convert|0|C|F K}}→ 0 °C (32 °F; 273 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 0.1 degrees Celsius change is a 0.18 degrees Fahrenheit change, 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 |sigfig=:
{{convert|10000|C|sigfig=5}}→ 10,000 °C (18,032 °F)
or you set the precision positionally, relative to the decimal point (zero being at the decimal point):
{{convert|10000|C|0}}→ 10,000 °C (18,032 °F)
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 {{#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:
|adj=ri0|adj=ri1|adj=ri2|adj=ri3
Note that it is not possible to round above the decimal place (|adj=ri-1
). 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:
{{convert|4.14159|mi|km|adj=ri0}}→ 4 miles (6.66524 km) (precisions are mismatched){{convert|4.14159|mi|km|0|adj=ri0}}→ 4 miles (7 km)
In this case, if the input were rounded before conversion, a different result would be obtained:
{{convert|{{#expr:4.14159 round 0}}|mi|km|0}}→ 4 miles (6 km) (rounds intermediate calculation, giving a different result)
Into multiple units: 10 °C (50 °F; 283 K)
Separate the multiple output units by a space:
{{convert|10|C|F K}}→ 10 °C (50 °F; 283 K){{convert|5|km|mi nmi}}→ 5 kilometres (3.1 mi; 2.7 nmi)
If the output unit names contain spaces, use + as the separator.
See also:
- For multiple-unit options like 1 ft 5 in, see § In input and § In output.
Ranges of values
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:
Inyandikorugero:Convert/doc/range separator list
Multiple dimensions: 6 m × 12 m (20 ft × 39 ft)
Use by:
{{convert|6|by|12|ft|m}}→ 6 by 12 feet (1.8 by 3.7 m)
Use ×, multiplication sign, or x, letter:
{{convert|6|x|12|m|ft}}→ 6 by 12 metres (20 ft × 39 ft)
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 m × 12 m (20 ft × 39 ft)
Lists of values: 20, 40, or 60 miles
{{convert|20|,|40|, or|60|mi}}→ 20, 40, or 60 miles (32, 64, or 97 km)
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|x|3|ft|5|in|mm}}→ 1 foot 3 inches ([convert: unknown unit])*
Default behavior, for comparison:
{{convert|1|ft|3|in|mm}}→ 1 foot 3 inches (380 mm)
However, converting metric units into feet and inches with |order=flip can produce the desired output:
{{convert|380|x|1040|mm|ftin|order=flip}}→ 1 foot 3 inches by 3 feet 5 inches (380 mm × 1,040 mm)
Words
Spelling of unit name: international metre or US meter?
Default spelling of units is in the en (generic) locale. To show en-US spelling, use |sp=us:
{{convert|1|m|ft}}→ 1 metre (3.3 ft)—default{{convert|1|m|ft|sp=us}}→ 1 meter (3.3 ft)
Spell out numbers: ten miles
To write a number in words, use |spell=in:
{{convert|10|mi|m|spell=in}}→ ten miles (16,000 m)
To spell out both in and out values, use |spell=on:
{{convert|10|mi|m|spell=on}}→ ten miles (sixteen thousand metres)
To make first letter a capital, use |spell=In, |spell=On
{{convert|10|mi|m|spell=In}}→ Ten miles (16,000 m){{convert|10|mi|m|spell=On}}→ Ten miles (sixteen thousand metres)
Remember that the spelling of the units (ft, m) is independently set by |abbr=. To the extreme:
{{convert|10|mi|m|spell=on|abbr=off|sp=us}}→ ten miles (sixteen thousand meters)
Inserted before units: 4 planted acres
{{convert|4|acre||adj=pre|planted}}→ 4 planted acres (1.6 ha)
disp=preunit is similar, but has no separator after the specified text, and can have different text for the output value:
{{convert|4|acre||disp=preunit|planted }}→ 4 planted acres (1.6 planted ha){{convert|4|acre||disp=preunit|planted |reforested-}}→ 4 planted acres (1.6 reforested-ha)
After adjective unit: A 10-foot-long corridor
Note that two units (in this case, ft and m) are required. Use with just one unit will generate an error message.
{{convert|10|ft|m|adj=mid|-long}}→ 10-foot-long (3.0 m)
Plurals: 1 inch, 2 inches
The unit symbol is singular always. Depending on the preceding number only, a unit name can be shown plural.
{{convert|1|metre}}→ 1 metre (3 ft 3 in){{convert|2|metre}}→ 2 metres (6 ft 7 in){{convert|2|metre|abbr=on}}→ 2 m (6 ft 7 in)
- Exception
Entering the unit "foot" instead of "ft" forces singular output "foot", whatever the number is.
{{convert|100|foot|abbr=off}}→ 100 foot (30 metres)
Fractions: one-eighth of an imperial pint
The convert template also supports spelling out fractions.
{{convert|3+1/2|oz|g|spell=in}}→ three and a half ounces (99 g)
Any additional words needed for the fraction can also be added at the end of the template.
{{convert|1/8|imppt|ml|spell=in|adj=pre|of an}}→ one-eighth of an imperial pint (71 ml)
Wrapping and line breaking
- See Help:Convert § Wrapping and line breaking
Spelling out "thousands", "millions", etc.
Most unit codes accept a prefix of e3 (thousand) or e6 (million) or e9 (billion).
{{convert|100|e6mi|e6km}}→ 100 million miles (160×106 km){{convert|120|e6acre}}→ 120 million acres (490,000 km2){{convert|120|e6acre|e3km2}}→ 120 million acres (490×103 km2)
To display both input and output in scientific notation, use |abbr=on
{{convert|100|e6mi|e6km|abbr=on}}→ 100×106 mi (160×106 km)
To spell out "thousands", "millions", etc., |abbr=unit abbreviates the unit; |abbr=off displays both full unit names.
{{convert|100|e6mi|e6km|abbr=unit}}→ 100 million mi (160 million km){{convert|100|e6mi|e6km|abbr=off}}→ 100 million miles (160 million kilometres)
Numbers
Using an SI prefix: gigametre (Gm), or micrometre (μm)
Inyandikorugero:Sidebar metric prefixes (small) Units can have an SI prefix like G before the unit: Gm, and giga before the name: gigametre. These are plain multiplication factors.
To illustrate, these are trivial calculations (from metre to metre), showing the multiplication factor:
- 12 Gm (1.2×1010 m)
- 12 μm (1.2×10−5 m)
The prefix can be added before the SI unit (here: unit m for metre):
{{convert|12|Gm|mi|abbr=on}}→ 12 Gm (7,500,000 mi)Mm: 12 Mm (7,500 mi)km: 12 km (39,000 ft)mm: 12 mm (0.47 in)μm: 12 μm (0.012 mm)um: 12 μm (0.012 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 (19 Mm){{convert|12|in|μm|abbr=on}}→ 12 in (300,000 μm)
As an exception, the non-SI unit "inch" can have the "μ" prefix too:
{{convert|12|μm|μin|abbr=on}}→ 12 μm (470 μin)
Engineering notation: 7 × 106 m
In the unit: e6m
Engineering notation can be entered as a "prefix" to the unit:
{{convert|70|e6m}}→ 70×106 m (230,000,000 ft)
The same is possible for the output unit:
{{convert|23,000,000|ft|e6m}}→ 23,000,000 feet (7.0×106 m)
Any standard unit (not a combination, multiple, or built-in unit) can have such a prefix:
e3(thousand),e6(million),e9(billion),e12(trillion),e15(quadrillion).
Scientific notation: 1.23 × 10−14
In scientific notation, a number is written like Inyandikorugero:Val. The plain number has exactly one digit before the decimal point.
With {{convert}}, the input can be in e-notation such as 12.3e4. This value is displayed as a power of ten, and the output is displayed in scientific notation, except that an output value satisfying 0.01 <= v < 1000 is shown as a normal number. In addition, if the output value is 1000 and sigfig=4 is used, the value is displayed as a normal number.
{{convert|12.3e-15|atm|atm|abbr=on}}→ 12.3×10−15 atm (1.23×10−14 atm){{convert|0.00000005|atm|atm|abbr=on}}→ 0.00000005 atm (5.0×10−8 atm)
Input with fractions: 1+1⁄2 inches (38.1 mm)
The number to convert can be written in fractions. Both / (keyboard slash) and ⁄ (fraction slash) are accepted:
{{convert|1/2|in|mm|1}}→ 1⁄2 inch (12.7 mm){{convert|1⁄2|in|mm|1}}→ 1⁄2 inch (12.7 mm)
With positive mixed numbers (a positive integer and a fraction), use a + sign
{{convert|2+1⁄2|in|mm|1}}→ 2+1⁄2 inches (63.5 mm)
With negative mixed numbers, use a hyphen - and repeat it:
{{convert|-2-1⁄2|in|mm|1}}→ −2+1⁄2 inches (−63.5 mm)
Note that the following cases are not interpreted as mixed numbers:
{{convert|2-1⁄2|in|mm|1}}→ 2–1⁄2 inch (50.8–12.7 mm). This is interpreted as a range from 2 inches to 1⁄2 inch.{{convert|-2+1⁄2|in|mm|1}}→ [convert: invalid number] This is neither a mixed number nor a range, and mathematical expressions requiring calculations are not allowed here.{{convert|2+½|in|mm|1}}→ [convert: invalid number] Fractions consisting of a single Unicode character are not allowed either.
Horizontal fraction bar: 1/2 inch
Using a double slash (//) provides a horizontal fraction bar for the original (input) unit:
{{convert|1//2|in|mm|1}}→ 1/2 inch (12.7 mm){{convert|6+3//8|in|mm|1}}→ 6+3/8 inches (161.9 mm)
Using a negative value for |frac= provides a horizontal fraction bar for the converted (output) unit:
{{convert|12.7|mm|frac=-2}}→ 12.7 millimetres (1/2 in){{convert|161.9|mm|frac=-8}}→ 161.9 millimetres (6+3/8 in)
Thousands separator: 1,000 mi or 1000 mi
In input, a comma for thousands separator is accepted but not required; a gap (space) is not accepted. In output, by default, the thousand separator is the comma:
{{convert|1234567|m|ft}}→ 1,234,567 metres (4,050,417 ft){{convert|1,234,567|m|ft}}→ 1,234,567 metres (4,050,417 ft)
Set |comma=off to remove the separator from the output:
{{convert|1234567|m|ft|comma=off}}→ 1234567 metres (4050417 ft)
Use |comma=gaps to use digit grouping by gap (thin space) as a thousands separator:
{{convert|1234567|m|ft|comma=gaps}}→ 1234567 metres (4050417 ft)
Default behavior, for comparison:
{{convert|1234567|m|ft}}→ 1,234,567 metres (4,050,417 ft)
Setting |comma=5 will only add the separator when the number of digits is 5 or more:
{{convert|1234|m|ft|comma=5}}→ 1234 metres (4049 ft){{convert|1234567|m|ft|comma=5}}→ 1,234,567 metres (4,050,417 ft)
Default behavior, for comparison:
{{convert|1234|m|ft}}→ 1,234 metres (4,049 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, br(), x|…:
{{convert|10|m|ft|disp=sqbr}}→ 10 metres [33 ft]{{convert|10|m|ft|disp=comma}}→ 10 metres, 33 ft{{convert|10|m|ft|disp=or}}→ 10 metres or 33 feet
Default behavior, for comparison:
{{convert|10|m|ft}}→ 10 metres (33 ft)
Setting |disp=br will force a new line (
{{convert|10|m|ft|disp=br}}→ 10 metres
33 feet
Also |disp=br() will force a new line, and keep the brackets (useful in tables):
{{convert|10|m|ft|disp=br()}}→ 10 metres
(33 feet)
Setting |disp=x|… allows any text as separator:
{{convert|10|m|ft|disp=x|_MyText_}}→ 10 metres_MyText_33 ft (To display spaces, use
Flipping (reordering) the two measurements: 1,609.3 metres (1 mile)
Setting |order=flip will flip (swap) the two measurements:
{{convert|1|mi|m|order=flip}}→ 1,609.3 metres (1 mile)
Default behavior, for comparison:
{{convert|1|mi|m}}→ 1 mile (1,609.3 metres)
When converting to multiple units, the effect is:
{{convert|10|km|mi nmi|order=flip}}→ 6.2137 miles; 5.3996 nautical miles (10 kilometres){{convert|10|km|nmi mi|order=flip}}→ 5.3996 nautical miles; 6.2137 miles (10 kilometres)
Fixed ordering of output units: 212 °F (100 °C; 373 K)
Setting |order=out shows the output-units as ordered; the input unit is skipped:
{{convert|100|C|F C K|abbr=on|order=out}}→ 212 °F (100 °C; 373 K){{convert|200|PS|kW hp|0|abbr=on|order=out}}→ 147 kW (197 hp)
See also: § Displaying parts of the output.
Displaying parts of the result: 2 (1.5)
It is possible to display only parts of the conversion result: The following examples show how to display only a part of the result.
- Note: in Convert, abbr is synonym for unit symbol
| Convert | Returns | Components |
|---|---|---|
{{convert|2|cuyd|m3}} | 2 cubic yards (1.5 m3) | all (default conversion) |
{{convert|2|cuyd|m3|abbr=on}} | 2 cu yd (1.5 m3) | all (default conversion, abbr) |
{{convert|2|cuyd|m3Inyandikorugero:Bg}} | 2 (1.5) | numbers only |
{{convert|2|cuyd|m3Inyandikorugero:Bg}} | cubic yards | input unit |
{{convert|2|cuyd|m3Inyandikorugero:Bg}} | cubic-yard | input unit, adjectival (hyphenated) |
{{convert|2|cuyd|m3Inyandikorugero:Bg}} | cu yd | input unit, adjectival (abbr so not hyphenated) |
{{convert|2|cuydInyandikorugero:Bg}} | 2.0 cu yd | input unit abbr (unit repeated, workaround) |
{{convert|2|cuyd|m3Inyandikorugero:Bg}} | 1.5 m3 | output value, symbols |
{{convert|2|cuyd|m3Inyandikorugero:Bg}} | 1.5 cubic metres | output value, names |
{{convert|2|cuyd|m3Inyandikorugero:Bg}} | 1.5-cubic-metre | output, adjective |
{{convert|2|cuyd|m3Inyandikorugero:Bg}} | 1.5 | output number |
{{convert|2|cuyd|m3Inyandikorugero:Bg}} | m3 | output unit (abbr by default) |
{{convert|2|cuyd|m3Inyandikorugero:Bg}} | cubic metres | output unit (name) |
{{convert|2|cuyd|m3Inyandikorugero:Bg}} | m3 | output unit (abbr) |
Display both input name and symbol: 2 kilopascals [kPa]
Setting |abbr=~ returns both name and symbol of the first (input) unit:
{{convert|2|kPa|psi|abbr=~}}→ 2 kilopascals [kPa] (0.29 psi)A {{convert|2|kPa|psi|abbr=~|adj=on}} pressure→ A 2-kilopascal [kPa] (0.29 psi) pressure
Table options
For the wikitable table-responsive structure, there are three options: add a line-break, split the result over columns and make the table sortable.
Enforced line break
|disp=br adds a line-break and omits brackets.
|disp=br() adds a line-break and does add brackets to the converted value. This may be useful in tables:
|disp=br | |disp=br() |
|---|---|
| 100 kilometres 62 miles | 100 kilometres (62 miles) |
Table columns
Using {convert} in a table cell, with |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 |abbr= parameter. Multiple-unit outputs, like ftin, always output their units to the table.
{{convert|10|m|ft|disp=table}}→
style="text-align:right;"|10 |style="text-align:right;"|33
|disp=tablecen does the same, and also centers the text:
{{convert|20|m|ft|disp=tablecen}}→
style="text-align:center;"|20 |style="text-align:center;"|66
The units are added as a column header:
kilograms pounds stone and pounds |disp=table10 22 1 st 8 lb |disp=tableand|abbr=on20 kg 44 lb 3 st 2 lb |disp=tableand|abbr=off30 kilograms 66 pounds 4 stone 10 pounds |disp=tablecen40 88 6 st 4 lb |disp=(default)50 kilograms (110 lb; 7 st 12 lb)
Sorting
Use |sortable=on to include a hidden numerical sortkey in the output, suitable for use in a table with sortable columns. Technically, this places a hidden string before the actual displayed values:
{{convert|10|m|ft|sortable=on}}→10 metres (33 ft)- showing: 10 metres (33 ft).
Use both |disp=table and |sortable=on together to produce table columns (pipe symbols) for each value in sortable columns:
m m ft A Inyandikorugero:Val 15+3⁄4 52 B Inyandikorugero:Val 15.5 51 C Inyandikorugero:Val 16.0 52.5 D Inyandikorugero:Val 16 52
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 here.
All units
Inyandikorugero:Convert/list of units
'per' units: kg/ha, miles per gallon
When using a slash (/), a unit like kg/ha is recognized as kilograms per hectare and will be converted in to other mass/area units. A unit in the numerator is not required.
{{convert|1000|kg/ha}}→ 1,000 kilograms per hectare (890 lb/acre){{convert|350|/in2}}→ 350 per square inch (54/cm2)
Population density (inhabitants per square mile) can be converted using
{{convert|10|PD/sqmi|PD/km2}}→ 10 inhabitants per square mile (3.9/km2)
Vehicular fuel efficiency, commonly expressed in miles per gallon or litres per 100 km can also be converted
{{convert|26|mpgUS|l/100km mpgimp}}→ 26 miles per US gallon (9.0 l/100 km; 31 mpg‑imp)
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:
{{convert|10|C}}→ 10 °C (50 °F) (standard temperature conversion){{convert|10|-|15|C}}→ 10–15 °C (50–59 °F) (standard temperature range conversion)
When expressing a temperature change (e.g., "The temperature increased by 10 °C"), or when comparing temperatures (e.g., "10 to 15 °C warmer"), we cannot use the standard temperature units (|C, |F and |K), which refer to points on the respective scale. Instead, we must use one of the following "units of difference": |C-change, |F-change and |K-change.
Compare the following two examples with the two above:
{{convert|10|C-change}}→ 10 °C (18 °F) increase in temperature{{convert|10|-|15|C-change}}→ 10–15 °C (18–27 °F) warmer than normal
To produce multiple units in the output:
{{convert|10|C-change|F-change K-change}}→ 10 °C (18 °F; 10 K) difference
Multiple units: 1 ft 5 in
In input
Base document § Input multiples lists options for multiple unit input (like ft,in). It can catch predefined sets only (units that can be subdivided; e.g., yd into ft):
{{convert|1|yd|2|ft|3|in}}→ 1 yard 2 feet 3 inches (1.60 m){{convert|2|ft|3|in|cm}}→ 2 feet 3 inches (69 cm){{convert|1|lb|5|oz|g}}→ 1 pound 5 ounces (600 g)
In output
Available multiple-unit output options predefined, like ftin and ydftin. The full list is at § Output multiples.
{{convert|2|m|ftin}}→ 2 metres (6 ft 7 in){{convert|2|m|ft in}}→ 2 metres (6.6 ft; 79 in), using a space, returns the decimal point
Default behavior, for comparison:
{{convert|2|m}}→ 2 metres (6 ft 7 in)
See also:
- {{hands}} a length used to measure horses
- {{Long ton}} a weight in ton, cwt, qr and lb
Currency per unit: $/mi → $/km
Using currency symbols in a $ per unit value, you can convert the per-unit:
{{convert|10|$/mi|$/km}}→ $10 per mile ($6.2/km){{convert|1500|$/ozt|$/g}}→ $1,500 per troy ounce ($48/g)
You can set the currency in both values using |$=€:
{{convert|10|$/mi|$/km|$=€}}→ €10 per mile (€6.2/km)
It is not possible to convert the currency. So, this result (mixed currencies) is not possible: $15 per mile (€8.6/km)
Using convert inside templates
For usage in template code, like infoboxes, {{Convert}} has these options:
- Pre-formatting fraction input
- Module:Convert/helper can read regular input and pre-format it into {{Convert}}-accepted input.
- Your template can accept
|input=16 7/8and use {{#invoke:Convert/helper|number|16 7/8}} → 16+7/8
- Using a Wikidata property
- Adding the Wikidata property code, like code
|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 |qid=.
Example for (P2073) of Inyandikorugero:Convert (Q6271187):
{{convert|input=P2073|qid={{get QID|Cessna 208 Caravan}}|ftin|abbr=on}}→{{convert|input=P2073|qid=Q1056131|km|abbr=on}}→ 1,500 mi (2,400 km){{convert|input=P2073|qid=Q1056131|km|abbr=on|disp=out}}→ 2,400 km
- For example see template:Infobox Telescope.
Sometimes a property may have more than one value against it in Wikidata. You can use the |qual= parameter to specify which of the values you want to use.
Example for (P2386): Note: this example uses |qid=Q1513315 (testing for (Q1513315))
- (Q613628):
{{convert|input=P2386|qual=Q613628|ft|abbr=on}}→ 10.0 m (32.8 ft) - (Q1395645):
{{convert|input=P2386|qual=Q1395645|ft|abbr=on}}→ 1 m (3.3 ft)
Parameter list
Inyandikorugero:Convert/doc/parameter list
Deprecated options
Inyandikorugero:Convert/doc/deprecations list
TemplateData
TemplateData for Convert
Converts measurements to other units.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Value | 1 | The value to convert. | Number | required |
| From unit | 2 | The unit for the provided value.
| String | required |
| To units | 3 | The units to convert into. Separate units by a space for multiple outputs. In an output unit, use + for a multiplication space.
| String | suggested |
| Precision or suffix | 4 | Significant digits after decimal dot or, if negative, exponent of ten. | Number | optional |
| Link units | lk | 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. For more fine-grained control over which units to link, use the template multiple times.
| String | optional |
| Abbreviation | abbr | 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).
| String | suggested |
| Spelling | sp | Spelling of units. Use “us” to display unit names using U.S. spelling.
| String | optional |
| Adjective | adj | 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.
| Unbalanced wikitext | optional |
| Conversion | disp | 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.
| String | optional |
| Ordering | order | “flip” returns converted value first, input value second.
| String | optional |
| Significant figures | sigfig | Indicates the number of significant figures to be used in rounding. | Number | optional |
| Rounding output | round | 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. | Number | optional |
| Thousands separator | comma | 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').
| Boolean | optional |
| Sort key | sortable | “on” generates a hidden sort key
| Boolean | optional |
| Spell numbers? | spell | If used, spells input or input and output numbers in words, optionally capitalizing the first
| String | optional |
| Singular? | sing | If 'yes', uses singular form of units (deprecated)
| Boolean | deprecated |
| Fraction? | frac | fraction as rounding unit | Number | optional |
| Currency symbol | $ | sets currency symbol in both units
| String | optional |
| Mach altitude (ft) | altitude_ft | Mach (speed) depends on altitide
| Number | optional |
| Mach altitude (m) | altitude_m | Mach (speed) depends on altitude | Number | optional |
| WD property | input | Reads the property value of the item (article), then converts it
| String | optional |
See also
- {{Cvt}}
- {{SI units}}
- {{Inflation}}, for converting historical prices to their current equivalent
- {{To USD}}, for currency conversions
Inyandikorugero:Convert/documentation navbox