Template:Unit/doc: Difference between revisions

[unchecked revision]

Revision as of 00:32, 26 February 2022

Add a tooltip to an abbreviation of a unit of measure showing the actual name of the unit.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Unit abbreviation	`abbr`	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	String	required

Usage

{{Template Sandbox/Demian/Unit|abbr}}

New units

Recognized units are defined and documented in Module:Sandbox/Demian/Unit/data.

Examples

Commonly used units.
Code	Result
`{{Template Sandbox/Demian/Unit\|ppm}}`	Template:Template Sandbox/Demian/Unit
`{{Template Sandbox/Demian/Unit\|m}}`	Template:Template Sandbox/Demian/Unit
`{{Template Sandbox/Demian/Unit\|m/s}}`	Template:Template Sandbox/Demian/Unit
`{{Template Sandbox/Demian/Unit\|mps}}`	Template:Template Sandbox/Demian/Unit
`{{Template Sandbox/Demian/Unit\|kg}}`	Template:Template Sandbox/Demian/Unit
`{{Template Sandbox/Demian/Unit\|degc}}`	Template:Template Sandbox/Demian/Unit

Note that the abbreviation is case sensitive and if the unit contains special symbols they are displayed correctly:

Various units.
Code	Result
`{{Template Sandbox/Demian/Unit\|mHz}}`	Template:Template Sandbox/Demian/Unit
`{{Template Sandbox/Demian/Unit\|MHz}}`	Template:Template Sandbox/Demian/Unit
`{{Template Sandbox/Demian/Unit\|m2}}`	Template:Template Sandbox/Demian/Unit
`{{Template Sandbox/Demian/Unit\|kohm}}`	Template:Template Sandbox/Demian/Unit
`{{Template Sandbox/Demian/Unit\|kWh}}`	Template:Template Sandbox/Demian/Unit
`{{Template Sandbox/Demian/Unit\|um}}`	Template:Template Sandbox/Demian/Unit
`{{Template Sandbox/Demian/Unit\|J/(Kmol)}}`	Template:Template Sandbox/Demian/Unit

If a unit definition is not found, the abbreviation (or text) is returned unchanged.

Invalid units.
Code	Result
`{{Template Sandbox/Demian/Unit\|things}}`	Template:Template Sandbox/Demian/Unit
`{{Template Sandbox/Demian/Unit\|something/other}}`	Template:Template Sandbox/Demian/Unit
`{{Template Sandbox/Demian/Unit\|players per hour}}`	Template:Template Sandbox/Demian/Unit

Modules

This template is using the following Modules:

Module:Sandbox/Demian/Unit

Template:Doc/end

@@ Line 1: / Line 1: @@
 {{doc/start}}
+<templatedata>
+{
+ "params": {
+ "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",
+ "required": true
+ }
+ },
+ "description": "Add a tooltip to an abbreviation of a unit of measure showing the actual name of the unit.",
+ "format": "inline",
+ "paramOrder": [
+ "abbr"
+ ]
+}
+</templatedata>
 == Usage ==
+{{tlx|Template Sandbox/Demian/Unit|''abbr''}}
-{{tlx|Template Sandbox/Demian/Unit|''abbr''}}
+== New units ==
+Recognized units are defined and documented in [[Module:Sandbox/Demian/Unit/data]].
 == Examples ==
@@ Line 23: / Line 45: @@
 |}
-Note that the abbreviation is case sensitive and special symbols are formatted correctly:
+Note that the abbreviation is case sensitive and if the unit contains special symbols they are displayed correctly:
 {| class="wikitable"
 |+ Various units.
@@ Line 58: / Line 80: @@
 == Modules ==
 This template is using the following Modules:
 *[[Module:Sandbox/Demian/Unit]]
-== Documentation ==
-<templatedata>
-{
- "params": {
- "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",
- "required": true
- }
- },
- "description": "Adds a tooltip to an abbreviation of a unit of measure showing the actual name of the unit.",
- "format": "inline",
- "paramOrder": [
- "abbr"
- ]
-}
-</templatedata>
 {{doc/end}}