User:Wikid77/Template:Convert/fmt/doc

{| width=585px style="background:transparent;"
 * The converter Template:Convert/fmt will convert an amount and display the amount with special formatting. To set the rounding precision, the output unit must be specified, or put "0" to default.
 * Usage:   {&#123;convert/fmt |100.51432|m|ft|r1=1}}
 * {&#123;convert/fmt |1,234|km|mi|comma=off}}
 * {&#123;convert/fmt |10.5|L|usgal|3|x3=exactly}}
 * {&#123;convert/fmt |7|km|mi|disp=x|long (|)}} - custom output

There are special options with Convert/fmt, such as r1=2 to round the input amount to 2 decimals, comma=out to show commas only in the output amount, near=25 (or 50) to round to nearest 25, and "x0=zz" to "x5=zz" to insert text before/after the unit names.  12,340 kilometres (7,670 miles) |    |          | |    |     |    x0    x1         x2 x3   x4   x5 While parameters x0 and x1 insert text before or after the first amount, x2 follows the input unit, x3 puts text before the output amount, x4 follows the output, and x5 follows the output unit name.

The template allows the same parameters as Template:Convert, and so it allows abbreviation abbr=in or abbr=out or abbr=off, wikilinks lk=in or lk=out, and adjective mode adj=on or adj=mid. The separator can also be a semicolon: disp=semi, disp=or, disp=comma, disp=x (customized), disp=sqbr (square brackets), disp=b (default as parentheses), disp=2 (or disp=out) and disp=# (or disp=number).

Examples
The examples show various options of conversions:
 * {&#123;convert/fmt |1|lb|g|x3=exactly}} &rarr;
 * {&#123;convert/fmt |1,234|km|mi|comma=off}} &rarr;
 * {&#123;convert/fmt |950|km|mi|abbr=~}}    &rarr;
 * {&#123;convert/fmt |3.1415926|km|mi|r1=2}}     &rarr;
 * {&#123;convert/fmt |9,564|km|mi|comma=out}}    &rarr;
 * {&#123;convert/fmt |9,564|km|mi|lk=in|near=5}}  &rarr;
 * {&#123;convert/fmt |9,564|km|mi|lk=out|near=50}} &rarr;
 * {&#123;convert/fmt |10.5|L|usgal|4|x3=exactly}} &rarr;
 * {&#123;convert/fmt |10.5|L|x3=nearly}}   &rarr;
 * {&#123;convert/fmt |10.5|L|x1=&lt;b&gt;|x2=&lt;/b&gt;}}   &rarr;

Display types: disp=comma, disp=semi, disp=or, disp=out, disp=number, disp=x and disp=b. The numeric results are identical to using Template:Convert to show a conversion.

The multi-unit outputs, such as for litres ("L") to both impgal and usgal, cannot handle near=n, so use Template:Convert/show2 (or Template:Convert/show3) to show multiple outputs rounded by near=n.

Common problems
Note the name of this template is "convert/fmt" and omitting the suffix "/fmt" will not show special formatting. Also, putting "fmt" as parameter 1 will cause the number to be treated as a template name "Convert/ " such as {&#123;convert|fmt|34|km}} will show "fmt 34".

The amount is followed by a unit-code (such as "|m") as the 2nd parameter. The output unit-code can be "0" as the 3rd parameter, to allow the default output unit to be triggered, while setting parameter 4 to a rounding precision (such as "|5") or use r=5 to set the rounding level.