Template:Endurance/doc

This template is designed to provide easier-to-read unit conversions for endurance figures, which are often given as distance @ speed, by using Template:Convert for the unit conversions.

Usage

• {{endurance|distance|from_unit1|to_unit1|speed|from_unit2|to_unit2|[optional note]}}

where:

• distance and speed are unformatted numbers (no commas)
• from_units and to_units are unit abbreviations that are used by Template:Convert. (See Template:Convert/list of units/length and Template:Convert/list of units/speed for units and abbreviations.)
• optional note is a notation (like submerged or surfaced) to appear in the conversion

Optional parameters

There are optional parameters that control the appearance of the output:

• abbr: when abbr is set to "on", the input units are abbreviated, which can be useful within infoboxes; the output units are already abbreviated
• sp: when sp is set to "us", the American spelling of metric units, i.e. meter vs. metre

(Both of these parameters behave the same as they do in Template:Convert

• sep: a value in the parameter sep overrides the default @ symbol

Units supported

The template currently supports the following units (in any combination or conversion direction):

Distance:

• nmi: nautical miles
• m: metres
• km: kilometres

Speed:

• knots: knots
• km/h: kilometres per hour

Please add requests for additional units to the talk page

Examples

• {{endurance|450|nmi|km|5|knots|km/h}} → 450 nautical miles @ 5 knots (830 km @ 9.3 km/h)
• {{endurance|100|km|nmi|35|km/h|knots}} → 100 kilometres @ 35 kilometres per hour (54 nmi @ 19 kn)

Optional note

• {{endurance|450|nmi|km|5|knots|km/h|submerged}} → 450 nautical miles @ 5 knots, submerged (830 km @ 9.3 km/h)

Abbreviated output

• {{endurance|450|nmi|km|5|knots|km/h|abbr=on}} → 450 nmi @ 5 kn (830 km @ 9.3 km/h)

US spelling of metric units

• {{endurance|100|km|nmi|35|km/h|knots|sp=us}} → 100 kilometers @ 35 kilometers per hour (54 nmi @ 19 kn)

Optional separator

• {{endurance|2100|nmi|km|16|knots|km/h|sep=at}} → 2,100 nautical miles at 16 knots (3,900 km at 30 km/h)

See also

• Template:Convert