Editing Template:Unit/doc

{{doc/start}}
<templatedata>
{
	"params": {
		"number": {
			"label": "Number",
			"type": "number",
			"description": "Numerical value to format for display with the unit.",
			"example": "2, -2, 3.45"
		},
		"abbr": {
			"label": "Unit abbreviation",
			"description": "Case sensitive abbreviation of a unit of measure. If the abbreviation contains a forward slash \"/\" it may be replaced with the character \"p\".",
			"example": "m/s, mps, GHz, ppm, kg, m2, kWh",
			"type": "string"
		}
	},
	"description": "Add a tooltip to an abbreviation of a unit of measure showing the actual name of the unit.",
	"format": "inline",
	"paramOrder": [
		"number",
		"abbr"
	]
}
</templatedata>

== Usage ==
* With a formatted number: {{tlx|Unit|''number''|''abbr''}}
** If a number is specified, it is formatted with a space " " as a thousands separator and a period "." as the decimal separator.
* With unit abbreviation only: {{tlx|Unit|''abbr''}}

== New units ==
Recognized units are defined and documented in [[Module:Unit/data]].

== Examples ==
{| class="wikitable"
|+ Commonly used units.
|-
! Code !! Result
|-
| {{tlx|Unit|ppm}} || {{Unit|ppm}}
|-
| {{tlx|Unit|1200|m}} || {{Unit|1200|m}}
|-
| {{tlx|Unit|1|m/s}} || {{Unit|1|m/s}}
|-
| {{tlx|Unit|mps}} || {{Unit|mps}}
|-
| 34 {{tlx|Unit|kg}} || 34 {{Unit|kg}}
|-
| {{tlx|Unit|+2|degc}} || {{Unit|+2|degc}}
|}

Note that the abbreviation is case sensitive and if the unit contains special symbols they are displayed correctly:
{| class="wikitable"
|+ Various units.
|-
! Code !! Result
|-
| {{tlx|Unit|-2,1|mHz}} || {{Unit|-2,1|mHz}}
|-
| {{tlx|Unit|-0.1||MHz}} || {{Unit|-0.1|MHz}}
|-
| {{tlx|Unit|0|m2}} || {{Unit|0|m2}}
|-
| {{tlx|Unit|+1|kohm}} || {{Unit|+1|kohm}}
|-
| {{tlx|Unit|852001,99|kWh}} || {{Unit|852001,99|kWh}}
|-
| 4–8 {{tlx|Unit|um}} || 4–8 {{Unit|um}}
|-
| {{tlx|Unit|J/(Kmol)}} || {{Unit|J/(Kmol)}}
|}

If a unit definition is not found, the abbreviation (or text) is returned unchanged.
{| class="wikitable"
|+ Invalid units.
|-
! Code !! Result
|-
| {{tlx|Unit|things}} || {{Unit|things}}
|-
| {{tlx|Unit|something/other}} || {{Unit|something/other}}
|-
| {{tlx|Unit|players per hour}} || {{Unit|players per hour}}
|-
| {{tlx|Unit}} || {{Unit}}
|}

== Modules ==
This template is using the following Modules:
*[[Module:Unit]]
{{doc/end}}
<includeonly>[[Category:Formatting templates]]</includeonly>