Template:Mi to Km

From Citizendium
Revision as of 22:05, 14 June 2009 by imported>Drew R. Smith
Jump to navigation Jump to search
This template employs intricate features of template syntax.
You are encouraged to familiarise yourself with its setup and parser functions before editing the template.
If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages.
Remember that you can and should conduct experiments and test improvements in your user space before changing anything here.
This documentation is transcluded from Template:Mi to Km/doc (edit | history)


This template is intended to perform Mile-to-Kilometer conversions. It converts single values, ranges, as well as two- and three-dimensional measurements.

Accepted parameters

Italicized parameters are optional:

  • num, or l (length), or from, or first unnamed parameter is a required parameter, which specifies the number of miles to be converted to kilometers (for single value conversions), or length (for two- and three-dimensional conversions), or start of range (for range conversions). Please do not format this parameter; i.e., use 1234 instead of 1,234.
  • w (width), or to, or second unnamed parameter is a parameter specifying width (for dimensional conversions) or end of range (for range conversions) in miles to be converted to kilometers. Please do not format this parameter; i.e., use 1234 instead of 1,234.
  • h (height) or third unnamed parameter is a parameter specifying height (for three-dimensional conversions) in miles to be converted to kilometers. Please do not format this parameter; i.e., use 1234 instead of 1,234.
  • convtype (conversion type) can take values of either range or dim. Range is only meaningful when two values are supplied for conversion. The default value is dim.
  • abbr can take values of either mos, yes, or no. Mos will show the names of the units as (miles, Km); yes will show the abbreviated names of the units (Mi, Km); and no will show the full names of the units (miles, kilometers). With dimensional conversions, all values will be separated with the "by" preposition when the parameter is set to no, and with the "×" sign when the parameter is set to yes. When the parameter is set to mos, mile values will be separated with the "by" preposition, and the converted values in kilometers—with the "×" sign. The default value is mos.
  • spell can take values of American or Commonwealth and is only meaningful when abbr is set to no. American will use "kilometers", and Commonwealth—"kilometres". The default value is American.
  • precision is the number of decimal digits in the converted value. The default value is 0 for converted values equal or more than 10 and 1 for converted values of less than 10.
  • wiki specifies whether the names of the units should be wikified or not and can take values of either yes or no. The default value is no.

Capitalization of the parameters is unimportant.

Usage and examples

Single value conversion

Usage
{{Mi to Km | num | abbr | spell | precision | wiki}}
Examples
{{Mi to Km|1}} → 1 mile (0.4 km)
Short notation: {{Mi to Km|1|abbr=yes}} → 1 in (0.4 km)
Full notation: {{Mi to Km|num=1|abbr=no|spell=Commonwealth|precision=2|wiki=yes}} → 1 mile (0.39 kiloimetres)

Range conversions

Usage
{{Mi to Km | from | to | convtype | abbr | spell | precision | wiki}}
Examples
{{Mi to Km|10|20|convtype=range}} → Template:Mi2 to Km2 range
Short notation: {{Mi to Km|10|20|convtype=range|abbr=yes}} → Template:Mi2 to Km2 range
Full notation: {{Mi to Km|from=10|to=20|convtype=range|abbr=no|spell=Commonwealth|precision=1|wiki=yes}} → Template:Mi2 to Km2 range

Two-dimensional conversions

Usage
{{Mi to Km | l | w | convtype | abbr | spell | precision | wiki}}
Examples
{{Mi to Km|10|20}} → Template:Mi2 to Km2 2D
Short notation: {{Mi to Km|10|20|abbr=yes}} → Template:Mi2 to Km2 2D
Full notation: {{Mi to Km|l=10|w=20|convtype=dim|abbr=no|spell=Commonwealth|precision=1|wiki=yes}} → Template:Mi2 to Km2 2D

Three-dimensional conversions

Usage
{{Mi to Km | l | w | h | convtype | abbr | spell | precision | wiki}}
Examples
{{Mi to Km|1|2|3}} → Template:Mi2 to Km2 3D
Short notation: {{Mi to Km|1|2|3|abbr=yes}} → Template:Mi2 to Km2 3D
Full notation: {{Mi to Km|l=1|w=2|h=3|convtype=dim|abbr=no|spell=Commonwealth|precision=2|wiki=yes}} → Template:Mi2 to Km2 3D

</noinclude>

See also