Template:Convert/doc/parameter list: Difference between revisions
From Zoophilia Wiki
< Template:Convert | doc
meta>DePiep add abbr=mos |
meta>DePiep add topical grouping |
||
| Line 1: | Line 1: | ||
{| class="wikitable sortable collapsible {{{state|uncollapsed}}}" style="width:100%;" | {| class="wikitable sortable collapsible {{{state|uncollapsed}}}" style="width:100%;" | ||
! colspan= | ! colspan=3 style="background:#eee" | {{navbar-collapsible|'''Parameter options for <nowiki>{{convert}}</nowiki>'''|Convert/doc/parameter list}} | ||
|- | |- | ||
! Option | ! Option | ||
! Description | ! Description | ||
! Note | |||
|- | |- | ||
|<code>|abbr=in</code> || Use symbol for first (left-hand side) unit | |<code>|abbr=in</code> || Use symbol for first (left-hand side) unit || Abbr (symbol) | ||
|- | |- | ||
|<code>|abbr=off</code> | |<code>|abbr=off</code> | ||
| rowspan=2 | Use name for all units | | rowspan=2 | Use name for all units | ||
| rowspan=2 | Abbr (symbol) | |||
|- | |- | ||
|<code>|abbr=none</code> | |<code>|abbr=none</code> | ||
|- | |- | ||
|<code>|abbr=on</code> || Use symbol for all units | |<code>|abbr=on</code> || Use symbol for all units || Abbr (symbol) | ||
|- | |- | ||
|<code>|abbr=out</code> || Use symbol for right-hand side unit (default) | |<code>|abbr=out</code> || Use symbol for right-hand side unit (default) || Abbr (symbol) | ||
|- | |- | ||
|<code>|abbr=values</code> || Show only input and output numbers, not units | |<code>|abbr=values</code> || Show only input and output numbers, not units || Parts only | ||
|- | |- | ||
|<code>|adj=1</code> || Unit name is singular when value is 1 or less, but not zero | |<code>|adj=1</code> || Unit name is singular when value is 1 or less, but not zero || Grammar, plural | ||
|- | |- | ||
|<code>|adj=j</code> || Join value and unit name using "&nbsp;" instead of a space | |<code>|adj=j</code> || Join value and unit name using "&nbsp;" instead of a space || Join values | ||
|- | |- | ||
|<code>|adj=mid</code> || Same as <code>adj=on</code> with user-specified text after input unit | |<code>|adj=mid</code> || Same as <code>adj=on</code> with user-specified text after input unit || Word adding | ||
|- | |- | ||
|<code>|adj=on</code> || Unit name is singular and hyphenated (adjective) | |<code>|adj=on</code> || Unit name is singular and hyphenated (adjective) || Grammar, adjective | ||
|- | |- | ||
|<code>|adj=pre</code> || User-specified text before input unit | |<code>|adj=pre</code> || User-specified text before input unit || Word adding | ||
|- | |- | ||
|<code>|adj=ri0</code> || Round input with precision 0 | |<code>|adj=ri0</code> || Round input with precision 0 || Rounding and sigfig | ||
|- | |- | ||
|<code>|adj=ri1</code> || Round input with precision 1 | |<code>|adj=ri1</code> || Round input with precision 1 || Rounding and sigfig | ||
|- | |- | ||
|<code>|adj=ri2</code> || Round input with precision 2 | |<code>|adj=ri2</code> || Round input with precision 2 || Rounding and sigfig | ||
|- | |- | ||
|<code>|adj=ri3</code> || Round input with precision 3 | |<code>|adj=ri3</code> || Round input with precision 3 || Rounding and sigfig | ||
|- | |- | ||
|<code>|disp=b</code> || Join input and output using " (...)" (default) | |<code>|disp=b</code> || Join input and output using " (...)" (default) || Join values | ||
|- | |- | ||
|<code>|disp=sqbr</code> || Join input and output using " [...]" | |<code>|disp=sqbr</code> || Join input and output using " [...]" || Join values | ||
|- | |- | ||
|<code>|disp=br</code> || Join input and output using "<br/>" | |<code>|disp=br</code> || Join input and output using "<br/>" || Join values | ||
|- | |- | ||
|<code>|disp=comma</code> || Join input and output using ", " | |<code>|disp=comma</code> || Join input and output using ", " || Join values | ||
|- | |- | ||
|<code>|disp=or</code> || Join input and output using " or " | |<code>|disp=or</code> || Join input and output using " or " || Join values | ||
|- | |- | ||
|<code>|disp=nocomma</code> || No comma in input or output numbers | |<code>|disp=nocomma</code> || No comma in input or output numbers || Number format | ||
|- | |- | ||
|<code>|disp=number</code> | |<code>|disp=number</code> | ||
| rowspan=2 | Display output value only | | rowspan=2 | Display output value only | ||
| rowspan=2 | Parts only | |||
|- | |- | ||
|<code>|disp=output number only</code> | |<code>|disp=output number only</code> | ||
| Line 55: | Line 58: | ||
|<code>|disp=out</code> | |<code>|disp=out</code> | ||
| rowspan=2 | Display only output value and name/symbol | | rowspan=2 | Display only output value and name/symbol | ||
| rowspan=2 | Parts only | |||
|- | |- | ||
|<code>|disp=output only</code> | |<code>|disp=output only</code> | ||
|- | |- | ||
|<code>|disp=preunit</code> || User-specified text before input and output units | |<code>|disp=preunit</code> || User-specified text before input and output units || Word adding | ||
|- | |- | ||
|<code>|disp=table</code> || Output is suitable for a table cell with align="right" | |<code>|disp=table</code> || Output is suitable for a table cell with align="right" || Table columns | ||
|- | |- | ||
|<code>|disp=tablecen</code> || Output is suitable for a table cell with align="center" | |<code>|disp=tablecen</code> || Output is suitable for a table cell with align="center" || Table columns | ||
|- | |- | ||
|<code>|disp=unit</code> || Display input name/symbol only (not output; not input value) | |<code>|disp=unit</code> || Display input name/symbol only (not output; not input value) || Parts only | ||
|- | |- | ||
|<code>|disp=unit2</code> | |<code>|disp=unit2</code> | ||
| Display output name/symbol only (not input; not output value) | | Display output name/symbol only (not input; not output value) || Parts only | ||
|- | |- | ||
|<code>|disp=x|...</code> || Join input and output using user-specified text | |<code>|disp=x|...</code> || Join input and output using user-specified text || Word adding | ||
|- | |- | ||
|<code>|comma=5</code> || Only use comma for thousands separator if 5 or more digits | |<code>|comma=5</code> || Only use comma for thousands separator if 5 or more digits || Number format | ||
|- | |- | ||
|<code>|comma=gaps</code> || Use gaps (space), not comma, for thousands separator | |<code>|comma=gaps</code> || Use gaps (space), not comma, for thousands separator || Number format | ||
|- | |- | ||
|<code>|comma=gaps5</code> || Use gaps (space), but only if 5 or more digits | |<code>|comma=gaps5</code> || Use gaps (space), but only if 5 or more digits || Number format | ||
|- | |- | ||
|<code>|adj=nocomma</code> | |<code>|adj=nocomma</code> | ||
| No thousands separator (comma) in input and output numbers | | No thousands separator (comma) in input and output numbers || Number format | ||
|- | |- | ||
|<code>|frac=''N''</code> || Show imperial number in fractions, denominator=''N'' | |<code>|frac=''N''</code> || Show imperial number in fractions, denominator=''N'' || Number format, fraction | ||
|- | |- | ||
|<code>|lk=in</code> || Link left-hand side unit name or symbol | |<code>|lk=in</code> || Link left-hand side unit name or symbol || Unit link | ||
|- | |- | ||
|<code>|lk=on</code> || Link all unit names or symbols (but not twice for the same unit) | |<code>|lk=on</code> || Link all unit names or symbols (but not twice for the same unit) || Unit link | ||
|- | |- | ||
|<code>|lk=out</code> || Link right-hand side unit name or symbol | |<code>|lk=out</code> || Link right-hand side unit name or symbol || Unit link | ||
|- | |- | ||
|<code>|order=flip</code> || Inverts order of input, output measurements (conversion first) | |<code>|order=flip</code> || Inverts order of input, output measurements (conversion first) || Order | ||
|- | |- | ||
|<code>|round=5</code> || Rounds calculation to the nearest multiple of 5 | |<code>|round=5</code> || Rounds calculation to the nearest multiple of 5 || Rounding and sigfig | ||
|- | |- | ||
|<code>|round=25</code> || Rounds calculation to the nearest multiple of 25 | |<code>|round=25</code> || Rounds calculation to the nearest multiple of 25 || Rounding and sigfig | ||
|- | |- | ||
|<code>|round=each</code> || In a range, each value is rounded by the default rounding | |<code>|round=each</code> || In a range, each value is rounded by the default rounding || Rounding and sigfig | ||
|- | |- | ||
|<code>|sigfig=''N''</code> || Round output value to ''N'' significant figures (''N'' is a positive integer) | |<code>|sigfig=''N''</code> || Round output value to ''N'' significant figures (''N'' is a positive integer) || Rounding and sigfig | ||
|- | |- | ||
|<code>|sortable=in</code> | |<code>|sortable=in</code> | ||
| rowspan=2 | Output numeric hidden sort field for use in a sortable table (based on input) | | rowspan=2 | Output numeric hidden sort field for use in a sortable table (based on input) | ||
| rowspan=2 | Table sort | |||
|- | |- | ||
|<code>|sortable=on</code> | |<code>|sortable=on</code> | ||
|- | |- | ||
|<code>|sortable=out</code> || Output numeric hidden sort field for use in a sortable table (based on output) | |<code>|sortable=out</code> || Output numeric hidden sort field for use in a sortable table (based on output) || Table sort | ||
|- | |- | ||
|<code>|sp=us</code> || Use U.S. spelling (like "meter" instead of default "metre") | |<code>|sp=us</code> || Use U.S. spelling (like "meter" instead of default "metre") || Spelling | ||
|- | |- | ||
|<code>|spell=in</code> || Spell input value in words | |<code>|spell=in</code> || Spell input value in words || Number spelling | ||
|- | |- | ||
|<code>|spell=In</code> || Spell input value in words with first letter uppercase | |<code>|spell=In</code> || Spell input value in words with first letter uppercase || Number spelling | ||
|- | |- | ||
|<code>|spell=on</code> || Spell input and output values in words | |<code>|spell=on</code> || Spell input and output values in words || Number spelling | ||
|- | |- | ||
|<code>|spell=On</code> || Spell input and output values in words with first letter uppercase | |<code>|spell=On</code> || Spell input and output values in words with first letter uppercase || Number spelling | ||
|- | |- | ||
|<code>|debug=yes</code> || '''Debugging only'''. In a sortable table: show the normally hidden sort key | |<code>|debug=yes</code> || '''Debugging only'''. In a sortable table: show the normally hidden sort key || Table sort | ||
|- | |- | ||
|<code>{{!xt|1=|abbr=mos}}</code> || '''Deprecated'''. Use {{xt|1=|x|}} ''or'' {{xt|1=|by|}} | |<code>{{!xt|1=|abbr=mos}}</code> || '''Deprecated'''. Use {{xt|1=|x|}} ''or'' {{xt|1=|by|}} || Range format | ||
|- | |- | ||
|<code>{{!xt|1=|abbr=comma}}</code> || '''Deprecated'''. Use {{xt|1=|adj=nocomma}} | |<code>{{!xt|1=|abbr=comma}}</code> || '''Deprecated'''. Use {{xt|1=|adj=nocomma}} || Number format | ||
|- | |- | ||
|<code>{{!xt|1=|adj=flip}}</code> || '''Deprecated'''. Use {{xt|1=|order=flip}} | |<code>{{!xt|1=|adj=flip}}</code> || '''Deprecated'''. Use {{xt|1=|order=flip}} || Order | ||
|- | |- | ||
|<code>{{!xt|1=|disp=flip}}</code> || '''Deprecated'''. Use {{xt|1=|order=flip}} | |<code>{{!xt|1=|disp=flip}}</code> || '''Deprecated'''. Use {{xt|1=|order=flip}} || Order | ||
|- | |- | ||
|<code>{{!xt|1=|disp=flip5}}</code> || '''Deprecated'''. Use {{xt|1=|order=flip |round=5}} | |<code>{{!xt|1=|disp=flip5}}</code> || '''Deprecated'''. Use {{xt|1=|order=flip |round=5}} || Order, rounding | ||
|- | |- | ||
|<code>{{!xt|1=|disp=5}}</code> || '''Deprecated'''. Use {{xt|1=|round=5}} | |<code>{{!xt|1=|disp=5}}</code> || '''Deprecated'''. Use {{xt|1=|round=5}} || Rounding, sigfig | ||
|- | |- | ||
|<code>{{!xt|1=|disp=2}}</code> || '''Deprecated'''. Use {{xt|1=|disp=output only}} | |<code>{{!xt|1=|disp=2}}</code> || '''Deprecated'''. Use {{xt|1=|disp=output only}} || Parts only | ||
|- | |- | ||
|<code>{{!xt|1=|disp=u2}}</code> || '''Deprecated'''. Use {{xt|1=|disp=unit2}} | |<code>{{!xt|1=|disp=u2}}</code> || '''Deprecated'''. Use {{xt|1=|disp=unit2}} || Parts only | ||
|- | |- | ||
|<code>{{!xt|1=|near=5}}</code> || '''Deprecated'''. Use {{xt|1=|round=5}} | |<code>{{!xt|1=|near=5}}</code> || '''Deprecated'''. Use {{xt|1=|round=5}} || Rounding and sigfig | ||
|}<noinclude> | |}<noinclude> | ||
{{documentation}} | {{documentation}} | ||
</noinclude> | </noinclude> | ||
Revision as of 17:00, 5 November 2014
| Option | Description | Note |
|---|---|---|
|abbr=in |
Use symbol for first (left-hand side) unit | Abbr (symbol) |
|abbr=off
|
Use name for all units | Abbr (symbol) |
|abbr=none
| ||
|abbr=on |
Use symbol for all units | Abbr (symbol) |
|abbr=out |
Use symbol for right-hand side unit (default) | Abbr (symbol) |
|abbr=values |
Show only input and output numbers, not units | Parts only |
|adj=1 |
Unit name is singular when value is 1 or less, but not zero | Grammar, plural |
|adj=j |
Join value and unit name using " " instead of a space | Join values |
|adj=mid |
Same as adj=on with user-specified text after input unit |
Word adding |
|adj=on |
Unit name is singular and hyphenated (adjective) | Grammar, adjective |
|adj=pre |
User-specified text before input unit | Word adding |
|adj=ri0 |
Round input with precision 0 | Rounding and sigfig |
|adj=ri1 |
Round input with precision 1 | Rounding and sigfig |
|adj=ri2 |
Round input with precision 2 | Rounding and sigfig |
|adj=ri3 |
Round input with precision 3 | Rounding and sigfig |
|disp=b |
Join input and output using " (...)" (default) | Join values |
|disp=sqbr |
Join input and output using " [...]" | Join values |
|disp=br |
Join input and output using "<br/>" | Join values |
|disp=comma |
Join input and output using ", " | Join values |
|disp=or |
Join input and output using " or " | Join values |
|disp=nocomma |
No comma in input or output numbers | Number format |
|disp=number
|
Display output value only | Parts only |
|disp=output number only
| ||
|disp=out
|
Display only output value and name/symbol | Parts only |
|disp=output only
| ||
|disp=preunit |
User-specified text before input and output units | Word adding |
|disp=table |
Output is suitable for a table cell with align="right" | Table columns |
|disp=tablecen |
Output is suitable for a table cell with align="center" | Table columns |
|disp=unit |
Display input name/symbol only (not output; not input value) | Parts only |
|disp=unit2
|
Display output name/symbol only (not input; not output value) | Parts only |
|disp=x|... |
Join input and output using user-specified text | Word adding |
|comma=5 |
Only use comma for thousands separator if 5 or more digits | Number format |
|comma=gaps |
Use gaps (space), not comma, for thousands separator | Number format |
|comma=gaps5 |
Use gaps (space), but only if 5 or more digits | Number format |
|adj=nocomma
|
No thousands separator (comma) in input and output numbers | Number format |
|frac=N |
Show imperial number in fractions, denominator=N | Number format, fraction |
|lk=in |
Link left-hand side unit name or symbol | Unit link |
|lk=on |
Link all unit names or symbols (but not twice for the same unit) | Unit link |
|lk=out |
Link right-hand side unit name or symbol | Unit link |
|order=flip |
Inverts order of input, output measurements (conversion first) | Order |
|round=5 |
Rounds calculation to the nearest multiple of 5 | Rounding and sigfig |
|round=25 |
Rounds calculation to the nearest multiple of 25 | Rounding and sigfig |
|round=each |
In a range, each value is rounded by the default rounding | Rounding and sigfig |
|sigfig=N |
Round output value to N significant figures (N is a positive integer) | Rounding and sigfig |
|sortable=in
|
Output numeric hidden sort field for use in a sortable table (based on input) | Table sort |
|sortable=on
| ||
|sortable=out |
Output numeric hidden sort field for use in a sortable table (based on output) | Table sort |
|sp=us |
Use U.S. spelling (like "meter" instead of default "metre") | Spelling |
|spell=in |
Spell input value in words | Number spelling |
|spell=In |
Spell input value in words with first letter uppercase | Number spelling |
|spell=on |
Spell input and output values in words | Number spelling |
|spell=On |
Spell input and output values in words with first letter uppercase | Number spelling |
|debug=yes |
Debugging only. In a sortable table: show the normally hidden sort key | Table sort |
|abbr=mos |
Deprecated. Use |x| or |by| | Range format |
|abbr=comma |
Deprecated. Use |adj=nocomma | Number format |
|adj=flip |
Deprecated. Use |order=flip | Order |
|disp=flip |
Deprecated. Use |order=flip | Order |
|disp=flip5 |
Deprecated. Use |order=flip |round=5 | Order, rounding |
|disp=5 |
Deprecated. Use |round=5 | Rounding, sigfig |
|disp=2 |
Deprecated. Use |disp=output only | Parts only |
|disp=u2 |
Deprecated. Use |disp=unit2 | Parts only |
|near=5 |
Deprecated. Use |round=5 | Rounding and sigfig |
