Template:Convert/doc/parameter list: Difference between revisions

Safer nicotine wiki Tobacco Harm Reduction
Jump to navigation Jump to search
VisualWikitext
m (1 revision imported: Wikipedia article on Nicotine modules needed)
m (1 revision imported)
 
(One intermediate revision by one other user not shown)
Line 7: Line 7:
! Note
! Note
|-
|-
| rowspan=15 | <code>&#124;abbr</code>
|<code>&#124;abbr=in</code> || data-sort-value="in" | <code>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
| Unit display
|-
|-
| data-sort-value="off" | <code>off</code>
|<code>&#124;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 | Unit display
| rowspan=2 | Unit display
|-
|-
| data-sort-value="none" | <code>none</code>
|<code>&#124;abbr=none</code> || data-sort-value="none" | <code>none</code>
|-
|-
| data-sort-value="on" | <code>on</code>
|<code>&#124;abbr=on</code> || data-sort-value="on" | <code>on</code>
| Use symbol for all units
| Use symbol for all units
| Unit display
| Unit display
|-
|-
| data-sort-value="out" | <code>out</code>
|<code>&#124;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
| Unit display
|-
|-
| data-sort-value="unit" | <code>unit</code>
|<code>&#124;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
| Unit display
|-
|-
| data-sort-value="values" | <code>values</code>
|<code>&#124;abbr=values</code> || data-sort-value="values" | <code>values</code>
| Omit both the input and output units: show only the numbers
| Omit both the input and output units: show only the numbers
| Unit display
| Unit display
|-
|-
| data-sort-value="~" | <code>~</code>
|<code>&#124;abbr=~</code> || data-sort-value="~" | <code>~</code>
| Shows both unit name and symbol
| Shows both unit name and symbol
| Unit display
| Unit display
|-
|-
| data-sort-value="mid" | <code>mid</code>
|<code>&#124;adj=mid&#124;…</code> || data-sort-value="mid" | <code>mid</code>
| User-specified text after the input unit; sets <code>adj=on</code> (adjective). Expects 1 unnamed parameter.
| User-specified text after the input unit; sets <code>adj=on</code> (adjective). Expects 1 unnamed parameter.
| Word adding, adjective
| Word adding, adjective
|-
|-
| data-sort-value="on" | <code>on</code>
|<code>&#124;adj=on</code> || data-sort-value="on" | <code>on</code>
| Unit name is adjective (singular and hyphenated)
| Unit name is adjective (singular and hyphenated)
| Grammar, adjective
| Grammar, adjective
|-
|-
| data-sort-value="pre" | <code>pre</code>
|<code>&#124;adj=pre&#124;…</code> || data-sort-value="pre" | <code>pre</code>
| User-specified text before input unit. Expects 1 unnamed parameter.
| User-specified text before input unit. Expects 1 unnamed parameter.
| Word adding
| Word adding
|-
|-
| data-sort-value="ri0" | <code>ri0</code>
|<code>&#124;adj=ri0</code> || data-sort-value="ri0" | <code>ri0</code>
| Round input with precision 0
| Round input with precision 0
| Input precision
| Input precision
|-
|-
| data-sort-value="ri1" | <code>ri1</code>
|<code>&#124;adj=ri1</code> || data-sort-value="ri1" | <code>ri1</code>
| Round input with precision 1
| Round input with precision 1
| Input precision
| Input precision
|-
|-
| data-sort-value="ri2" | <code>ri2</code>
|<code>&#124;adj=ri2</code> || data-sort-value="ri2" | <code>ri2</code>
| Round input with precision 2
| Round input with precision 2
| Input precision
| Input precision
|-
|-
| data-sort-value="ri3" | <code>ri3</code>
|<code>&#124;adj=ri3</code> || data-sort-value="ri3" | <code>ri3</code>
| Round input with precision 3
| Round input with precision 3
| Input precision
| Input precision
|-
|-
| rowspan=3 | <code>&#124;comma</code>
|<code>&#124;comma=5</code> || data-sort-value="05" | <code>5</code>
| data-sort-value="05" | <code>5</code>
| Only use comma for thousands separator if 5 or more digits
| Only use comma for thousands separator if 5 or more digits
| Number format
| Number format
|-
|-
| data-sort-value="gaps" | <code>gaps</code>
|<code>&#124;comma=gaps</code> || data-sort-value="gaps" | <code>gaps</code>
| Use gaps (space), not comma, for thousands separator
| Use gaps (space), not comma, for thousands separator
| Number format
| Number format
|-
|-
| data-sort-value="off" | <code>off</code>
|<code>&#124;comma=off</code> || data-sort-value="off" | <code>off</code>
| No thousands separator
| No thousands separator
| Number format
| Number format
|-
|-
| rowspan=15 | <code>&#124;disp</code>
|<code>&#124;disp=b</code> || data-sort-value="b" | <code>b</code>
| data-sort-value="b" | <code>b</code>
| Join input and output using "&nbsp;(...)" (default)
| Join input and output using "&nbsp;(...)" (default)
| Join values
| Join values
|-
|-
| data-sort-value="sqbr" | <code>sqbr</code>
|<code>&#124;disp=sqbr</code> || data-sort-value="sqbr" | <code>sqbr</code>
| Join input and output using "&nbsp;[...]"
| Join input and output using "&nbsp;[...]"
| Join values
| Join values
|-
|-
| data-sort-value="br" | <code>br</code>
|<code>&#124;disp=br</code> || data-sort-value="br" | <code>br</code>
| Join input and output using "&lt;br/>"
| Join input and output using "&lt;br/>"
| Join values
| Join values
|-
|-
| data-sort-value="comma" | <code>comma</code>
|<code>&#124;disp=comma</code> || data-sort-value="comma" | <code>comma</code>
| Join input and output using ",&nbsp;"
| Join input and output using ",&nbsp;"
| Join values
| Join values
|-
|-
| data-sort-value="or" | <code>or</code>
|<code>&#124;disp=or</code> || data-sort-value="or" | <code>or</code>
| Join input and output using "&nbsp;or&nbsp;"
| Join input and output using "&nbsp;or&nbsp;"
| Join values
| Join values
|-
|-
| data-sort-value="number" | <code>number</code>
|<code>&#124;disp=number</code> || data-sort-value="number" | <code>number</code>
| rowspan=2 | Display output number only
| rowspan=2 | Display output number only
| rowspan=2 | Parts only
| rowspan=2 | Parts only
|-
|-
| data-sort-value="output number only" | <code>output number only</code>
|<code>&#124;disp=output number only</code> || data-sort-value="output number only" | <code>output number only</code>
|-
|-
| data-sort-value="out" | <code>out</code>
|<code>&#124;disp=out</code> || data-sort-value="out" | <code>out</code>
| rowspan=2 | Display only output number and name/symbol
| rowspan=2 | Display only output number and name/symbol
| rowspan=2 | Parts only
| rowspan=2 | Parts only
|-
|-
| data-sort-value="output only" | <code>output only</code>
|<code>&#124;disp=output only</code> || data-sort-value="output only" | <code>output only</code>
|-
|-
| data-sort-value="preunit" | <code>preunit</code>
|<code>&#124;disp=preunit&#124;…[&#124;…]</code> || data-sort-value="preunit" | <code>preunit</code>
| 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.
| 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
| Word adding
|-
|-
| data-sort-value="table" | <code>table</code>
|<code>&#124;disp=table</code> || data-sort-value="table" | <code>table</code>
| Output is suitable for a table cell with align="right"
| Output is suitable for a table cell with align="right"
| Table columns
| Table columns
|-
|-
| data-sort-value="tablecen" | <code>tablecen</code>
|<code>&#124;disp=tablecen</code> || data-sort-value="tablecen" | <code>tablecen</code>
| Output is suitable for a table cell with align="center"  
| Output is suitable for a table cell with align="center"  
| Table columns
| Table columns
|-
|-
| data-sort-value="unit" | <code>unit</code>
|<code>&#124;disp=unit</code> || data-sort-value="unit" | <code>unit</code>
| Display input name/symbol only (not input number, not output)
| Display input name/symbol only (not input number, not output)
| Parts only
| Parts only
|-
|-
| data-sort-value="unit2" | <code>unit2</code>
|<code>&#124;disp=unit2</code> || data-sort-value="unit2" | <code>unit2</code>
| Display output name/symbol only (not input; not output number)
| Display output name/symbol only (not input; not output number)
| Parts only
| Parts only
|-
|-
| data-sort-value="x" | <code>x</code>
|<code>&#124;disp=x&#124;…</code> || data-sort-value="x" | <code>x</code>
| Join input and output using user-specified text
| Join input and output using user-specified text
| Word adding
| Word adding
|-
|-
| <code>&#124;frac</code>
|<code>&#124;frac=''N''</code> || data-sort-value="N" | <code>''N''</code>
| data-sort-value="N" | <code>''N''</code>
| Show imperial number in fractions, denominator=''N''
| Show imperial number in fractions, denominator=''N''
| Number format, fraction
| Number format, fraction
|-
|-
| <code>&#124;input</code>
|<code>&#124;input=P2048</code> || data-sort-value="property P2048" | <code>P2048</code> {{small|1=(e.g.)}}
| data-sort-value="property P2048" | <code>P2048</code> {{small|1=(e.g.)}}
| Reads and converts Wikidata property  
| Reads and converts Wikidata property
| Inside template
| Inside template
|-
|-
| rowspan=3 | <code>&#124;lk</code>
|<code>&#124;lk=in</code> || data-sort-value="in" | <code>in</code>
| data-sort-value="in" | <code>in</code>
| Link left-hand side unit name or symbol
| Link left-hand side unit name or symbol
| Unit link
| Unit link
|-
|-
| data-sort-value="on" | <code>on</code>
|<code>&#124;lk=on</code> || data-sort-value="on" | <code>on</code>
| Link all unit names or symbols (but not twice for the same unit)
| Link all unit names or symbols (but not twice for the same unit)
| Unit link
| Unit link
|-
|-
| data-sort-value="out" | <code>out</code>
|<code>&#124;lk=out</code> || data-sort-value="out" | <code>out</code>
| Link right-hand side unit name or symbol
| Link right-hand side unit name or symbol
| Unit link
| Unit link
|-
|-
| rowspan=2 | <code>&#124;order</code>
|<code>&#124;order=flip</code> || data-sort-value="flip" | <code>flip</code>
| data-sort-value="flip" | <code>flip</code>
| Inverts order of input, output measurements (conversion first)
| Inverts order of input, output measurements (conversion first)
| Order
| Order
|-
|-
| data-sort-value="out" | <code>out</code>
|<code>&#124;order=out</code> || data-sort-value="out" | <code>out</code>
| Displays output units in the order entered, skipping input unit
| Displays output units in the order entered, skipping input unit
| Order
| Order
|-
|-
| <code>&#124;qid</code>
|<code>&#124;qid=Q1056131</code> || data-sort-value="qid Q1056131" | <code>Q1056131</code> {{small|1=(e.g.)}}
| data-sort-value="qid Q1056131" | <code>Q1056131</code> {{small|1=(e.g.)}}
| Reads Wikidata property from Wikidata item
| Reads Wikidata property from Wikidata item
| Inside template; testing
| Inside template; testing
|-
|-
| <code>&#124;qual</code>
|<code>&#124;qual=Q613628</code> || data-sort-value="qual Q613628" | <code>Q613628</code> {{small|1=(e.g.)}}
| data-sort-value="qual Q613628" | <code>Q613628</code> {{small|1=(e.g.)}}
| Qualify Wikidata property
| Qualify Wikidata property
|  
|  
|-
|-
| rowspan=3 | <code>&#124;round</code>
|<code>&#124;round=5</code> || data-sort-value="05" | <code>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
| Output precision
|-
|-
| data-sort-value="25" | <code>25</code>
|<code>&#124;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
| Output precision
|-
|-
| data-sort-value="each" | <code>each</code>
|<code>&#124;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
| Output precision
|-
|-
| <code>&#124;sigfig</code>
|<code>&#124;sigfig=''N''</code> || data-sort-value="N" | <code>''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
| Output precision
|-
|-
| <code>&#124;sortable</code>
|<code>&#124;sortable=on</code> || data-sort-value="on" | <code>on</code>
| data-sort-value="on" | <code>on</code>
| Adds invisible sort key
| Adds invisible sort key
| Table sort
| Table sort
|-
|-
| <code>&#124;sp</code>
|<code>&#124;sp=us</code> || data-sort-value="us" | <code>us</code>
| data-sort-value="us" | <code>us</code>
| Use U.S. spelling ("meter" instead of default "metre")
| Use U.S. spelling ("meter" instead of default "metre")
| Spelling U.S.&nbsp;names
| Spelling U.S.&nbsp;names
|-
|-
| rowspan=4 | <code>&#124;spell</code>
|<code>&#124;spell=in</code> || data-sort-value="in" | <code>in</code>
| data-sort-value="in" | <code>in</code>
| Spell input number in words
| Spell input number in words
| Spelling numbers
| Spelling numbers
|-
|-
| data-sort-value="In" | <code>In</code>
|<code>&#124;spell=In</code> || data-sort-value="In" | <code>In</code>
| Spell input number in words with first letter uppercase
| Spell input number in words with first letter uppercase
| Spelling numbers
| Spelling numbers
|-
|-
| data-sort-value="on" | <code>on</code>
|<code>&#124;spell=on</code> || data-sort-value="on" | <code>on</code>
| Spell input and output numbers in words
| Spell input and output numbers in words
| Spelling numbers
| Spelling numbers
|-
|-
| data-sort-value="On" | <code>On</code>
|<code>&#124;spell=On</code> || data-sort-value="On" | <code>On</code>
| Spell input and output numbers in words with first letter uppercase
| Spell input and output numbers in words with first letter uppercase
| Spelling numbers
| Spelling numbers
|-
|-
| <code>&#124;$</code>
|<code>&#124;$=&euro;</code> || data-sort-value="&euro;" | <code>&euro;</code>
| data-sort-value="&euro;" | <code>&euro;</code>
| Replace $-sign with a currency sign, for example in <code>&euro;/hectare</code>
| Replace $-sign with a currency sign, for example in <code>$/acre</code> {{nowrap|(no currency conversion happens)}}
| Cost per unit<br /> {{nowrap|No currency conversion happens}}
| Cost per unit
|-
|-
| <code>&#124;debug</code>
|<code>&#124;debug=yes</code> || data-sort-value="yes" | <code>yes</code>
| data-sort-value="yes" | <code>yes</code>
| '''Debugging only'''. In a sortable table: show the normally hidden sort key
| '''Debugging only'''. In a sortable table: show the normally hidden sort key
| Table sort
| Table sort
|- <!-- ----------------- Deprecated options ------------------------- -->
|- <!-- ----------------- Deprecated options ------------------------- -->
| <code>{{!mxt|1=&#124;disp}}</code> || data-sort-value="flip" | <code>flip</code>
|<code>{{!mxt|1=&#124;disp=flip}}</code> || data-sort-value="flip" | <code>flip</code>
| '''Deprecated'''. Use {{mxt|1=&#x7c;order=flip}}
| '''Deprecated'''. Use {{mxt|1=&#x7c;order=flip}}
| Order
| Order

Latest revision as of 18:34, 2 January 2022

Parameter options for {{convert}}
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 Input precision
adj=ri1 ri1 Round input with precision 1 Input precision
adj=ri2 ri2 Round input with precision 2 Input precision
adj=ri3 ri3 Round input with precision 3 Input 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
order=out out Displays output units in the order entered, skipping input unit Order
qid=Q1056131 Q1056131 (e.g.) Reads Wikidata property from Wikidata item Inside template; testing
qual=Q613628 Q613628 (e.g.) Qualify Wikidata property
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 €/hectare Cost per unit
No currency conversion happens
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
Retrieved from ‘https://safernicotine.wiki/mediawiki/index.php?title=Template:Convert/doc/parameter_list&oldid=23067’