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
where:
 * and  are unformatted numbers (no commas)
 * s and s 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.)
 * 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: (Both of these parameters behave the same as they do in Template:Convert
 * : when  is set to "on", the input units are abbreviated, which can be useful within infoboxes; the output units are already abbreviated
 * : when  is set to "us", the American spelling of metric units, i.e. meter vs. metre
 * : a value in the parameter  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



 * Optional note:


 * Abbreviated output:


 * US spelling of metric units:


 * Optional separator: