Template:Currency/doc: Difference between revisions

No edit summary
(Decimal examples)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Documentation}}
{{Documentation}}


The '''currency'''template formats currency using the in-game icons.
The '''currency''' template formats currency using the in-game icons.


==Usage==
==Usage==
{| class="wikitable"
{| class="wikitable"
|+
!Code
!Code
!Visible result
!Visible result
|-
|-
|<nowiki>{{Currency|100}}</nowiki>
|{{T|Currency|0}}
|{{Currency|0}}
|-
|{{T|Currency|100}}
|{{Currency|100}}
|{{Currency|100}}
|-
|-
|<nowiki>{{Currency|100100}}</nowiki>
|{{T|Currency|200100}}
|{{Currency|100100}}
|{{Currency|200100}}
|-
|{{T|Currency|300200100}}
|{{Currency|300200100}}
|-
|{{T|Currency|400300200100}}
|{{Currency|400300200100}}
|-
|{{T|Currency|400000000000}}
|{{Currency|400000000000}}
|-
|{{T|Currency|300000100}}
|{{Currency|300000100}}
|-
|{{T|Currency|400000200000}}
|{{Currency|400300200100}}
|-
|{{T|Currency|-1}}
|{{Currency|-1}}
|-
|{{T|Currency|-4,003,002,001,000}}
|{{Currency|-4,003,002,001,000}}
|-
|{{T|Currency|2*(8/4)}}
|{{Currency|2*(8/4)}}
|-
| {{T|Currency|0.5}}
| {{Currency|0.5}}
|-
| {{T|Currency|1/3 round 2}}
| {{Currency|1/3 round 2}}
|}

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

{{T|Currency|200100|force_sign=yes}}: {{Currency|200100|force_sign=yes}}

{{T|Currency|-200100|force_sign=yes}}: {{Currency|-200100|force_sign=yes}} (no effect)

{{T|Currency|0|force_sign=yes}}: {{Currency|0|force_sign=yes}}

===all_signs===
Show the sign on all denominations

{{T|Currency|-200100|all_signs=yes}}: {{Currency|-200100|all_signs=yes}}

{{T|Currency|200100|all_signs=yes|force_sign=yes}}: {{Currency|200100|all_signs=yes|force_sign=yes}}

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

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



Latest revision as of 16:58, 20 November 2024

This is a documentation subpage for Template:Currency.
It contains usage information, categories, and other content that is not part of the original template page.
Template:Currency invokes function main in Module:Currency using Lua.

The currency template formats currency using the in-game icons.

Usage

Code Visible result
{{Currency|0}} Copper
{{Currency|100}} 100 Copper
{{Currency|200100}} 200 Silver 100 Copper
{{Currency|300200100}} 300 Gold 200 Silver 100 Copper
{{Currency|400300200100}} 400 Platinum 300 Gold 200 Silver 100 Copper
{{Currency|400000000000}} 400 Platinum
{{Currency|300000100}} 300 Gold 0 Silver 100 Copper
{{Currency|400000200000}} 400 Platinum 300 Gold 200 Silver 100 Copper
{{Currency|-1}} -1 Copper
{{Currency|-4,003,002,001,000}} -4003 Platinum 2 Gold 1 Silver
{{Currency|2*(8/4)}} Copper
{{Currency|0.5}} 0.5 Copper
{{Currency|1/3 round 2}} 0.33 Copper

force_sign

Force a sign in front of the currency.

{{Currency|200100|force_sign=yes}}: +200 Silver 100 Copper

{{Currency|-200100|force_sign=yes}}: -200 Silver 100 Copper (no effect)

{{Currency|0|force_sign=yes}}: ±0 Copper

all_signs

Show the sign on all denominations

{{Currency|-200100|all_signs=yes}}: -200 Silver -100 Copper

{{Currency|200100|force_sign=yes|all_signs=yes}}: +200 Silver +100 Copper

show_zeros

Three options:

  • show_zeros=some (default): show the zero valued denominations between the biggest and smallest denomination
  • show_zeros=all: show all zeros after the first denomination up to copper
  • show_zeros=none: hide all denominations with zero value
Amount show_zeros=some show_zeros=all show_zeros=none
0 Copper Copper Copper
1 Copper Copper Copper
2,000 Silver Silver 0 Copper Silver
2,001 Silver 1 Copper Silver 1 Copper Silver 1 Copper
3,002,000 Gold 2 Silver Gold 2 Silver 0 Copper Gold 2 Silver
4,000,002,000 Platinum 0 Gold 2 Silver Platinum 0 Gold 2 Silver 0 Copper Platinum 2 Silver