Template:Convert/doc/parameter list: Difference between revisions
From Zoophilia Wiki
< Template:Convert | doc
meta>Quondum italic when parameter is not a literal |
meta>Quondum towards a more coherent and concise description |
||
| Line 9: | Line 9: | ||
|<code>|abbr=in</code> || data-sort-value="in" | <code>in</code> | |<code>|abbr=in</code> || data-sort-value="in" | <code>in</code> | ||
| Use symbol for first (left-hand side) unit | | Use symbol for first (left-hand side) unit | ||
| | | Unit display | ||
|- | |- | ||
|<code>|abbr=off</code> || data-sort-value="off" | <code>off</code> | |<code>|abbr=off</code> || data-sort-value="off" | <code>off</code> | ||
| rowspan=2 | Use name for all units | | rowspan=2 | Use name for all units | ||
| rowspan=2 | | | rowspan=2 | Unit display | ||
|- | |- | ||
|<code>|abbr=none</code> || data-sort-value="none" | <code>none</code> | |<code>|abbr=none</code> || data-sort-value="none" | <code>none</code> | ||
| Line 19: | Line 19: | ||
|<code>|abbr=on</code> || data-sort-value="on" | <code>on</code> | |<code>|abbr=on</code> || data-sort-value="on" | <code>on</code> | ||
| Use symbol for all units | | Use symbol for all units | ||
| | | Unit display | ||
|- | |- | ||
|<code>|abbr=out</code> || data-sort-value="out" | <code>out</code> | |<code>|abbr=out</code> || data-sort-value="out" | <code>out</code> | ||
| Use symbol for right-hand side unit (default) | | Use symbol for right-hand side unit (default) | ||
| | | Unit display | ||
|- | |- | ||
|<code>|abbr=unit</code> || data-sort-value="unit" | <code>unit</code> | |<code>|abbr=unit</code> || data-sort-value="unit" | <code>unit</code> | ||
| Use symbol for all units when using scientific notation | | Use symbol for all units when using scientific notation | ||
| | | Unit display | ||
|- | |- | ||
|<code>|abbr=values</code> || data-sort-value="values" | <code>values</code> | |<code>|abbr=values</code> || data-sort-value="values" | <code>values</code> | ||
| | | Omit both the input and output units: show only the numbers | ||
| | | Unit display | ||
|- | |- | ||
|<code>|abbr=~</code> || data-sort-value="~" | <code>~</code> | |<code>|abbr=~</code> || data-sort-value="~" | <code>~</code> | ||
| Shows both unit name and symbol | | Shows both unit name and symbol | ||
| | | Unit display | ||
|- | |- | ||
|<code>|adj=mid|…</code> || data-sort-value="mid" | <code>mid</code> | |<code>|adj=mid|…</code> || data-sort-value="mid" | <code>mid</code> | ||
| Line 51: | Line 51: | ||
|<code>|adj=ri0</code> || data-sort-value="ri0" | <code>ri0</code> | |<code>|adj=ri0</code> || data-sort-value="ri0" | <code>ri0</code> | ||
| Round input with precision 0 | | Round input with precision 0 | ||
| | | Output precision | ||
|- | |- | ||
|<code>|adj=ri1</code> || data-sort-value="ri1" | <code>ri1</code> | |<code>|adj=ri1</code> || data-sort-value="ri1" | <code>ri1</code> | ||
| Round input with precision 1 | | Round input with precision 1 | ||
| | | Output precision | ||
|- | |- | ||
|<code>|adj=ri2</code> || data-sort-value="ri2" | <code>ri2</code> | |<code>|adj=ri2</code> || data-sort-value="ri2" | <code>ri2</code> | ||
| Round input with precision 2 | | Round input with precision 2 | ||
| | | Output precision | ||
|- | |- | ||
|<code>|adj=ri3</code> || data-sort-value="ri3" | <code>ri3</code> | |<code>|adj=ri3</code> || data-sort-value="ri3" | <code>ri3</code> | ||
| Round input with precision 3 | | Round input with precision 3 | ||
| | | Output precision | ||
|- | |- | ||
|<code>|comma=5</code> || data-sort-value="05" | <code>5</code> | |<code>|comma=5</code> || data-sort-value="05" | <code>5</code> | ||
| Line 163: | Line 163: | ||
|<code>|round=5</code> || data-sort-value="05" | <code>5</code> | |<code>|round=5</code> || data-sort-value="05" | <code>5</code> | ||
| Rounds calculation to the nearest multiple of 5 | | Rounds calculation to the nearest multiple of 5 | ||
| | | Output precision | ||
|- | |- | ||
|<code>|round=25</code> || data-sort-value="25" | <code>25</code> | |<code>|round=25</code> || data-sort-value="25" | <code>25</code> | ||
| Rounds calculation to the nearest multiple of 25 | | Rounds calculation to the nearest multiple of 25 | ||
| | | Output precision | ||
|- | |- | ||
|<code>|round=each</code> || data-sort-value="each" | <code>each</code> | |<code>|round=each</code> || data-sort-value="each" | <code>each</code> | ||
| In a range, each number is rounded by the default rounding | | In a range, each number is rounded by the default rounding | ||
| | | Output precision | ||
|- | |- | ||
|<code>|sigfig=''N''</code> || data-sort-value="N" | <code>''N''</code> | |<code>|sigfig=''N''</code> || data-sort-value="N" | <code>''N''</code> | ||
| Round output number to ''N'' significant figures (''N'' is a positive integer) | | Round output number to ''N'' significant figures (''N'' is a positive integer) | ||
| | | Output precision | ||
|- | |- | ||
|<code>|sortable=on</code> || data-sort-value="on" | <code>on</code> | |<code>|sortable=on</code> || data-sort-value="on" | <code>on</code> | ||
Revision as of 15:17, 24 February 2018
| Parameter | Value | Description | Note |
|---|---|---|---|
|abbr=in |
in
|
Use symbol for first (left-hand side) unit | Unit display |
|abbr=off |
off
|
Use name for all units | Unit display |
|abbr=none |
none
| ||
|abbr=on |
on
|
Use symbol for all units | Unit display |
|abbr=out |
out
|
Use symbol for right-hand side unit (default) | Unit display |
|abbr=unit |
unit
|
Use symbol for all units when using scientific notation | Unit display |
|abbr=values |
values
|
Omit both the input and output units: show only the numbers | Unit display |
|abbr=~ |
~
|
Shows both unit name and symbol | Unit display |
|adj=mid|… |
mid
|
User-specified text after the input unit; sets adj=on (adjective). Expects 1 unnamed parameter.
|
Word adding, adjective |
|adj=on |
on
|
Unit name is adjective (singular and hyphenated) | Grammar, adjective |
|adj=pre|… |
pre
|
User-specified text before input unit. Expects 1 unnamed parameter. | Word adding |
|adj=ri0 |
ri0
|
Round input with precision 0 | Output precision |
|adj=ri1 |
ri1
|
Round input with precision 1 | Output precision |
|adj=ri2 |
ri2
|
Round input with precision 2 | Output precision |
|adj=ri3 |
ri3
|
Round input with precision 3 | Output precision |
|comma=5 |
5
|
Only use comma for thousands separator if 5 or more digits | Number format |
|comma=gaps |
gaps
|
Use gaps (space), not comma, for thousands separator | Number format |
|comma=off |
off
|
No thousands separator | Number format |
|disp=b |
b
|
Join input and output using " (...)" (default) | Join values |
|disp=sqbr |
sqbr
|
Join input and output using " [...]" | Join values |
|disp=br |
br
|
Join input and output using "<br/>" | Join values |
|disp=comma |
comma
|
Join input and output using ", " | Join values |
|disp=or |
or
|
Join input and output using " or " | Join values |
|disp=number |
number
|
Display output number only | Parts only |
|disp=output number only |
output number only
| ||
|disp=out |
out
|
Display only output number and name/symbol | Parts only |
|disp=output only |
output only
| ||
|disp=preunit|…[|…] |
preunit
|
Text to be inserted after value and before units, for both input and output, with optionally different text for output. Expects 1 or 2 unnamed parameters. | Word adding |
|disp=table |
table
|
Output is suitable for a table cell with align="right" | Table columns |
|disp=tablecen |
tablecen
|
Output is suitable for a table cell with align="center" | Table columns |
|disp=unit |
unit
|
Display input name/symbol only (not input number, not output) | Parts only |
|disp=unit2 |
unit2
|
Display output name/symbol only (not input; not output number) | Parts only |
|disp=x|… |
x
|
Join input and output using user-specified text | Word adding |
|frac=N |
N
|
Show imperial number in fractions, denominator=N | Number format, fraction |
|input=P2048 |
P2048 (e.g.)
|
Reads and converts Wikidata property | Inside template |
|lk=in |
in
|
Link left-hand side unit name or symbol | Unit link |
|lk=on |
on
|
Link all unit names or symbols (but not twice for the same unit) | Unit link |
|lk=out |
out
|
Link right-hand side unit name or symbol | Unit link |
|order=flip |
flip
|
Inverts order of input, output measurements (conversion first) | Order |
|qid=Q1056131 |
Q1056131 (e.g.)
|
Reads Wikidata property from Wikidata item | Inside template; testing |
|round=5 |
5
|
Rounds calculation to the nearest multiple of 5 | Output precision |
|round=25 |
25
|
Rounds calculation to the nearest multiple of 25 | Output precision |
|round=each |
each
|
In a range, each number is rounded by the default rounding | Output precision |
|sigfig=N |
N
|
Round output number to N significant figures (N is a positive integer) | Output precision |
|sortable=on |
on
|
Adds invisible sort key | Table sort |
|sp=us |
us
|
Use U.S. spelling ("meter" instead of default "metre") | Spelling U.S. names |
|spell=in |
in
|
Spell input number in words | Spelling numbers |
|spell=In |
In
|
Spell input number in words with first letter uppercase | Spelling numbers |
|spell=on |
on
|
Spell input and output numbers in words | Spelling numbers |
|spell=On |
On
|
Spell input and output numbers in words with first letter uppercase | Spelling numbers |
|$=€ |
€
|
Replace $-sign with a currency sign, for example in $/acre (no currency conversion happens)
|
Cost per unit |
|debug=yes |
yes
|
Debugging only. In a sortable table: show the normally hidden sort key | Table sort |
|disp=flip |
flip
|
Deprecated. Use |order=flip | Order |
|sing= |
Deprecated. Use |adj= | Plurals | |
