Template:Convert/doc: Difference between revisions
Jump to navigation
Jump to search
imported>Caesar Schinas (→Parameters That Need to be Created: use the talk page) |
imported>Daniel Mietchen m (typo) |
||
| (10 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{TOC|right}} | {{TOC|right}} | ||
This template is used in articles to easily convert one unit to another. This template will always be under construction, as we can’t possibly include conversions | This template is used in articles to easily convert one unit to another. This template will always be under construction, as we can’t possibly include conversions ''from'' every possible unit ''to'' every possible unit. Should you find a combination of unis which isn't supported but which you think should be, please {{plainlink|{{fullurl:{{TALKPAGENAME}}|action=edit§ion=new}} leave a note on the talk page}} and it will be added.<br /> | ||
The goal of this template is to make the ''Citizendium'' accessible to all readers regardless of nationality. Instead of only showing [[SI units|SI/Metric units]] or [[Imperial units]], {{tl|convert}} automatically converts a number from the specified unit to another unit and displays it as "'''Metric (Imperial)'''" or "'''Imperial (Metric)'''", depending on which unit was converted from. | The goal of this template is to make the ''Citizendium'' accessible to all readers regardless of nationality. Instead of only showing [[SI units|SI/Metric units]] or [[Imperial units]], {{tl|convert}} automatically converts a number from the specified unit to another unit and displays it as "'''Metric (Imperial)'''" or "'''Imperial (Metric)'''", depending on which unit was converted from. | ||
== Usage == | == Usage == | ||
The template has | The template has five parameters - {{tlc|convert|number{{!}}from{{!}}to{{!}}precision{{!}}plain}}. | ||
# ''required'' — The number to convert. | # ''required'' — The number to convert. | ||
# ''required'' — The unit to convert ''from''. | # ''required'' — The unit to convert ''from''. | ||
# ''required'' — The unit to convert ''to''. | # ''required'' — The unit to convert ''to''. | ||
# ''optional'' — The precision of the result. Positive values cause the specified number of [[decimal place]]s to be shown, whilst negative values cause the numbers to be rounded to the specified number of [[significant figures]]. The default value is ''2'' (2 decimal places). | # ''optional'' — The precision of the result. Positive values cause the specified number of [[decimal place]]s to be shown, whilst negative values cause the numbers to be rounded to the specified number of [[significant figures]]. The default value is ''2'' (2 decimal places). | ||
# ''optional'' — set the 5th parameter to "plain" to make the template output a plain number, without units and without the input number. If this is used, the previous parameter must be given a value. | |||
The names of the units can be specified as either abbreviations or full words, using either British or American spelling. The unit names in the output will be in the same format as the input. | The names of the units can be specified as either abbreviations or full words, using either British or American spelling. The unit names in the output will be in the same format as the input. | ||
== Examples == | == Examples == | ||
| Line 27: | Line 22: | ||
|Simple conversion of 123.4 kilometres to miles. | |Simple conversion of 123.4 kilometres to miles. | ||
|- | |- | ||
|{{tlc|convert|12{{!}}in{{!}}cm}} | |{{tlc|convert|12{{!}}in{{!}}cm{{!}}0}} | ||
|{{convert|12|in|cm|0}} | |{{convert|12|in|cm|0}} | ||
|Convert 12 in to cm, rounding to the nearest whole cm. | |Convert 12 in to cm, rounding to the nearest whole cm. | ||
|- | |- | ||
|{{tlc|convert|60{{!}}nmi{{!}}mi}} | |{{tlc|convert|60{{!}}nmi{{!}}mi{{!}}6}} | ||
|{{convert|60|nmi|mi|6}} | |{{convert|60|nmi|mi|6}} | ||
|Convert 60 nautical miles to statute miles, showing the result to 6 decimal places. | |Convert 60 nautical miles to statute miles, showing the result to 6 decimal places. | ||
|- | |- | ||
|{{tlc|convert|60{{!}} | |{{tlc|convert|60{{!}}nautical miles{{!}}miles{{!}}-1}} | ||
|{{convert|60|nautical miles|miles|-1}} | |{{convert|60|nautical miles|miles|-1}} | ||
|Convert 60 nautical miles to statute miles, and round the result to one significant figure. | |Convert 60 nautical miles to statute miles, and round the result to one significant figure. | ||
|} | |} | ||
==Supported Conversions== | |||
<small>Transcluded from [[Template:Convert/doc/conversions]] ({{plainlink|{{fullurl:Template:Convert/doc/conversions|action=edit}} edit}})</small> | |||
{{box|style=height:35em; overflow:auto;| | |||
{{Convert/doc/conversions}} | |||
}} | |||
[[Template:Convert/doc/conversions/detail|For in-depth information, see the detailed list.]] | |||
{{br|3}} | |||
<includeonly>[[Category:Conversion templates]]</includeonly> | <includeonly>[[Category:Conversion templates]]</includeonly> | ||
Latest revision as of 08:14, 16 June 2009
This template is used in articles to easily convert one unit to another. This template will always be under construction, as we can’t possibly include conversions from every possible unit to every possible unit. Should you find a combination of unis which isn't supported but which you think should be, please and it will be added.
The goal of this template is to make the Citizendium accessible to all readers regardless of nationality. Instead of only showing SI/Metric units or Imperial units, {{convert}} automatically converts a number from the specified unit to another unit and displays it as "Metric (Imperial)" or "Imperial (Metric)", depending on which unit was converted from.
Usage
The template has five parameters - {{convert|number|from|to|precision|plain}}.
- required — The number to convert.
- required — The unit to convert from.
- required — The unit to convert to.
- optional — The precision of the result. Positive values cause the specified number of decimal places to be shown, whilst negative values cause the numbers to be rounded to the specified number of significant figures. The default value is 2 (2 decimal places).
- optional — set the 5th parameter to "plain" to make the template output a plain number, without units and without the input number. If this is used, the previous parameter must be given a value.
The names of the units can be specified as either abbreviations or full words, using either British or American spelling. The unit names in the output will be in the same format as the input.
Examples
| Code | Result | Notes |
|---|---|---|
{{convert|123.4|km|mi}}
|
123.4 km (76.68 mi) | Simple conversion of 123.4 kilometres to miles. |
{{convert|12|in|cm|0}}
|
12 in (30 cm) | Convert 12 in to cm, rounding to the nearest whole cm. |
{{convert|60|nmi|mi|6}}
|
60 nmi (69.046767 mi) | Convert 60 nautical miles to statute miles, showing the result to 6 decimal places. |
{{convert|60|nautical miles|miles|-1}}
|
60 nautical miles (70 miles) | Convert 60 nautical miles to statute miles, and round the result to one significant figure. |
Supported Conversions
Transcluded from Template:Convert/doc/conversions ()
Length Conversions
Metric to Imperial
| → | Inches (in) | Feet (ft) | Yards (yd) | Miles (mi) | Nautical Miles (nmi) |
|---|---|---|---|---|---|
| Millimetres (mm) | Yes | Yes | No | No | No |
| Centimetres (cm) | Yes | Yes | No | No | No |
| Decimetres (dm) | Yes | Yes | No | No | No |
| Metres (m) | Yes | Yes | Yes | Yes | Yes |
| Kilometres (km) | No | No | Yes | Yes | Yes |
Imperial to Metric
| → | Millimetres (mm) | Centimetres (cm) | Decimetres (dm) | Metres (m) | Kilometres (km) |
|---|---|---|---|---|---|
| Inches (in) | Yes | Yes | Yes | Yes | No |
| Feet (ft) | Yes | Yes | Yes | Yes | Yes |
| Yards (yd) | Yes | Yes | Yes | Yes | Yes |
| Miles (mi) | No | No | No | Yes | Yes |
| Nautical Miles (nmi) | No | No | No | Yes | Yes |
Imperial to Imperial
| → | Miles (mi) | Nautical Miles (nmi) |
|---|---|---|
| Miles (mi) | - | Yes |
| Nautical Miles (nmi) | Yes | - |
Weight Conversions
| → | Kilogrammes (kg) | Grammes (g) | Pounds (lbs) | Ounces (oz) |
|---|---|---|---|---|
| Kilogrammes (kg) | - | No | Yes | Yes |
| Grammes (g) | No | - | Yes | Yes |
| Pounds (lbs) | Yes | Yes | - | No |
| Ounces (oz) | Yes | Yes | No | - |
Temperature Conversions
| → | Celsius (°C) | Kelvin (°K) | Fahrenheit (°F) | Rankine (°R) |
|---|---|---|---|---|
| Celsius (°C) | - | Yes | Yes | Yes |
| Kelvin (°K) | Yes | - | Yes | No |
| Fahrenheit (°F) | Yes | Yes | - | Yes |
| Rankine (°R) | Yes | No | Yes | - |