Editing Template:Currency cell/doc

{{Documentation}}

Creates a table cell with a currency. These cells will always span 10 columns.

==Usage==

<syntaxhighlight lang="wikitext">{| class="wikitable sortable"
! colspan="10" | Header
|-
| {{Currency cell|0}}
|-
| {{Currency cell|1000}}
|-
| {{Currency cell|1001}}
|-
| {{Currency cell|1}}
|-
| {{Currency cell|-1}}
|-
| {{Currency cell|0.5}}
|-
| {{Currency cell|1/3 round 2}}
|}</syntaxhighlight>

{| class="wikitable sortable"
! colspan="10" | Header
|-
| {{Currency cell|0}}
|-
| {{Currency cell|1000}}
|-
| {{Currency cell|1001}}
|-
| {{Currency cell|1}}
|-
| {{Currency cell|-1}}
|-
| {{Currency cell|0.5}}
|-
| {{Currency cell|1/3 round 2}}
|}

===1===
The first positional argument, the amount of currency (in copper coins).

This is either a comma-seperated number (like <code>1,000,000</code> for 1 gold) or an expression (like <code>6 * 10^6 / 3</code> for 2 gold)

===show_zeros===
Three options:
* <code>show_zeros=all</code> (default): show all zeros after the first denomination up to copper
* <code>show_zeros=some</code>: show the zero valued denominations between the biggest and smallest denomination
* <code>show_zeros=none</code>: hide all denominations with zero value

{| class="wikitable"
! Amount
! colspan="10" | <code>show_zeros=all</code>
! colspan="10" | <code>show_zeros=some</code>
! colspan="10" | <code>show_zeros=none</code>
|-
| 0 || {{Currency cell|0|show_zeros=all}} || {{Currency cell|0|show_zeros=some}} || {{Currency cell|0|show_zeros=none}}
|-
| 1 || {{Currency cell|1|show_zeros=all}} || {{Currency cell|1|show_zeros=some}} || {{Currency cell|1|show_zeros=none}}
|-
| 2,000 || {{Currency cell|2000|show_zeros=all}} || {{Currency cell|2000|show_zeros=some}} || {{Currency cell|2000|show_zeros=none}}
|-
| 2,001 || {{Currency cell|2001|show_zeros=all}} || {{Currency cell|2001|show_zeros=some}} || {{Currency cell|2001|show_zeros=none}}
|-
| 3,002,000 || {{Currency cell|3002000|show_zeros=all}} || {{Currency cell|3002000|show_zeros=some}} || {{Currency cell|3002000|show_zeros=none}}
|-
| 4,000,002,000 || {{Currency cell|4000002000|show_zeros=all}} || {{Currency cell|4000002000|show_zeros=some}} || {{Currency cell|4000002000|show_zeros=none}}
|-
| 4,003,002,000 || {{Currency cell|4003002000|show_zeros=all}} || {{Currency cell|4003002000|show_zeros=some}} || {{Currency cell|4003002000|show_zeros=none}}
|}

===force_sign===
Force a sign in front of the currency.

{| class="wikitable"
! Wikitext
! colspan="10" | Output
|-
| {{T|Currency cell|200100|force_sign=yes}}
| {{Currency cell|200100|force_sign=yes}}
|-
| {{T|Currency cell|-200100|force_sign=yes}}
| {{Currency cell|-200100|force_sign=yes}}
|-
| {{T|Currency cell|0|force_sign=yes}}
| {{Currency cell|0|force_sign=yes}}
|}

===sign===
Three options:
* <code>sign=first</code> (default): Put any sign on the first denomination only.
* <code>sign=all</code>: Put the sign on all denominations.
* <code>sign=leading</code>: Have a seperate aligned cell for any sign.

{| class="wikitable"
! Amount
! colspan="10" | <code>sign=first</code>
! colspan="10" | <code>sign=all</code>
! colspan="10" | <code>sign=leading</code>
|-
| 1 || {{Currency cell|1|sign=first}} || {{Currency cell|1|sign=all}} || {{Currency cell|1|sign=leading}}
|-
| -1 || {{Currency cell|-1|sign=first}} || {{Currency cell|-1|sign=all}} || {{Currency cell|-1|sign=leading}}
|-
| -2,000 || {{Currency cell|-2000|sign=first}} || {{Currency cell|-2000|sign=all}} || {{Currency cell|-2000|sign=leading}}
|-
| -2,001 || {{Currency cell|-2001|sign=first}} || {{Currency cell|-2001|sign=all}} || {{Currency cell|-2001|sign=leading}}
|-
| -3,002,001 || {{Currency cell|-3002001|sign=first}} || {{Currency cell|-3002001|sign=all}} || {{Currency cell|-3002001|sign=leading}}
|}

===extra_class===
An arbitrary string to add as an extra class to all <syntaxhighlight lang="html" inline><td></syntaxhighlight> cells.

===html===
With <code>|html=yes</code>, output html tags instead of wikitext.

For example,

<syntaxhighlight lang="wikitext">
{| class="wikitable"
! Head1
! colspan="10" | Head2
|-
| Text
| {{Currency cell|1,000|html=no}}
|}

<table class="wikitable"><!--
  --><tr><!--
    --><th>Head1</th><!--
    --><th colspan="10">Head2</th><!--
  --></tr><!--
  --><tr><!--
    --><td>Text</td><!--
    -->{{Currency cell|1,000|html=yes}}<!-- Will output some text starting "<td" and ending "</td>"
  --></tr><!--
--></table>
</syntaxhighlight>

{| class="wikitable"
! Head1
! colspan="10" | Head2
|-
| Text
| {{Currency cell|1,000|html=no}}
|}

<table class="wikitable"><!--
  --><tr><!--
    --><th>Head1</th><!--
    --><th colspan="10">Head2</th><!--
  --></tr><!--
  --><tr><!--
    --><td>Text</td><!--
    -->{{Currency cell|1,000|html=yes}}<!-- Will output some text starting "<td" and ending "</td>"
  --></tr><!--
--></table>

==rowspan==
Each cell will have rowspan="rowspan". Defaults to 1.

==left_colspan==
The 10 columns with the currency cell will be merged with (blank) cells to the left of this amount.

==right_colspan==
Similar to left_colspan but with cells to the right.

<syntaxhighlight lang="wikitext">{| class="wikitable"
! Left
! colspan="10" | Currency
! Right
|-
| {{Currency cell|1|left_colspan=1}}
| A
|-
| B
| {{Currency cell|2|right_colspan=1}}
|-
| D
| {{Currency cell|3|rowspan=2}}
| E
|-
| F
| G
|}</syntaxhighlight>

{| class="wikitable sortable"
! Left
! colspan="10" | Currency
! Right
|-
| {{Currency cell|1|left_colspan=1}}
| A
|-
| B
| {{Currency cell|2|right_colspan=1}}
|-
| D
| {{Currency cell|3|rowspan=2}}
| E
|-
| F
| G
|}