Template:Mi2 to Km2/doc

From Citizendium
< Template:Mi2 to Km2
Revision as of 23:54, 14 June 2009 by imported>Drew R. Smith (New page: <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> ;Usage: :<nowiki>{{Mi2 to Km2 | 1 | abbr | spell | precision | wiki}}</nowiki> ;Examples :<nowiki>{{Mi2 to Km2|10000}}</nowiki> &...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Usage
{{Mi2 to Km2 | 1 | abbr | spell | precision | wiki}}
Examples
{{Mi2 to Km2|10000}} → 10,000 sq mi (25,899.9 km2)
Abbreviated notation: {{Mi2 to Km2|10000|abbr=yes}} → 10,000 sq mi (25,899.9 km2)
Fully spelled out notation: {{Mi2 to Km2|10000|abbr=no}} → 10,000 sq mi (25,899.9 km2)

Italicized parameters are optional:

  • Either num or 1 (an unnamed parameter) is required. This specifies the number of square miles to be converted to square kilometers. Please do not format this parameter; i.e., use 1234 instead of 1,234.
  • 2 (a second unnamed parameter) is optional. This specifies the number of square miles to be converted for the end of a range. Please do not format this parameter; i.e., use 1234 instead of 1,234.
  • abbr can take values of either yes or no.
  • yes 
both unit names will be abbreviated i.e. sq ft and
  • no
both unit names will be spelt out i.e. square miles and square kilometers or square kilometres
The default is to spell only the first unit name out as specified in the Manual of Style for dates and numbers i.e. square miles and .
  • spell can take values of Commonwealth, Com, C, BrE or UK. For any of these values the spelling square kilometre(s) will be used. The default spelling is square kilometer(s). This is only meaningful when abbr is set to no.
  • precision is the number of decimal digits in the converted value. Defaulting to conversions to the most precise of the following.
  • conversions rounded down one decimal place as compared to the input value
    • note: Where a range is given the most precise of the inputs is used.
    • note: One square foot is of comparable size to ten square kilometers.
or
  • conversions rounded to two significant figures
  • sigfig specifies the number of significant figures in the converted value.
    • This overrides precision.
    • Where the conversion is of a range it is the number of significant figures in the first value which is specified with the second being rounded to the same level of precision.
  • max precision specifies the maximum precision to round to.
  • min precision specifies the minimum precision to round to.
  • 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.

See also