User:Piripuwa/Sandbox/Template:Purchasable rewards page/doc
From YPPedia
- This is a usage of the Template:Purchasable rewards page.
Usage
These usage notes will not be included in articles bearing this template.
This template can display a basic text and image for medals and pins. This template should be used like following :
{{User:Piripuwa/Sandbox/Template:Purchasable rewards page
| trinket = Name of the trinket
| PoE = Cost of the trinket by PoE
| doubloons = Cost of the trinket by doubloons
| custom = Additional text or wiki mark up
| prize-only = yes / no
| gold = yes / no
| silver = yes / no
| bronze = yes / no
| image = File name of the trinket colors' image
| type = pin / medal
| prulal = yes / no
}}Please see Template:Purchasable rewards page/doc#Fileds and Template:Purchasable rewards page/doc#Sample for more details.
Fields
| name | number | default value | note |
|---|---|---|---|
| trinket | 1 | Required. A trinket's name as it would appear in-game. If you don't set this field, this template will not display anything. | |
| PoE | 2 | Cost of the trinket. (optional) If you set something to this field, this template will show the text of "for sale in the Palace Shoppe". | |
| doubloons | 3 | Doubloon cost of the trinket. (optional) If you don't set "PoE" field, this field will be unavailable. | |
| custom | 4 | If you set something to this field, this template will show it between opening paragraph and color section. (optional) | |
| prize-only | 5 | no | If the trinket is only awarded by Ocean Masters, or as a prize in official tournaments, set "prize-only=yes". (optional) |
| gold | 6 | If you set "gold=yes", this template will show the Image:Colors-trinket-image (gold). (optional) | |
| silver | 7 | If you set "silver=yes", this template will show the Image:Colors-trinket-image (silver). (optional) | |
| bronze | 8 | If you set "bronze=yes", this template will show the Image:Colors-trinket-image (bronze). (optional) | |
| image | 9 | trinket field's value | File name of the image that display trinket color patterns. (optional) For use, please see Category:Trinket images and find proper image for the trinket. |
| type | 10 | If you set "type=medal", this template will display Template:Navigation Medals. Also, if you set "type=pin", this template will display Template:Navigation Pins. If you set "navigation=no", this parameter doesn't work. (optional) | |
| plural | 11 | no | If the trinket has a pluralised name, set yes to this field like "plural=yes". (optional) |
| navigation | yes | If you need hide the navigation box, set "no" to this field. (optional) |
Sample
For the pins
.png)
.png)
.png)
For the medals
| Code | |||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |{{User:Piripuwa/Sandbox/Template:Purchasable rewards page | trinket = plain medal | PoE = 4,000 | doubloons = 4 | prize-only = no | image=Plain medal | type = medal }} | |||||||||||||||||||||||||||||||||||||
| Display | |||||||||||||||||||||||||||||||||||||
The plain medal is a trinket, which can be obtained through the palace shoppe. The plain medal can be purchased for 4,000 PoE (and 4 doubloons, on doubloon oceans). ColorsThey are permitted to have two different colors per trinket.
| |||||||||||||||||||||||||||||||||||||
For the prize-only trinkets
| Code | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |{{User:Piripuwa/Sandbox/Template:Purchasable rewards page | trinket = Jolly Roger medal | prize-only = yes | image = Jolly Roger medal | gold = yes | type = medal }} | |||||||||||||||||||||||||
| Display | |||||||||||||||||||||||||
The Jolly Roger medal is a type of trinket. It is only awarded by Ocean Masters, or as a prize in official tournaments.
ColorsGold.png)
| |||||||||||||||||||||||||
Categorization
When the article include this template, it will be categorized into Category:Trinkets.
Note : If you don't need to categorize, you can set "no" to an additional filed named "categorize" (e.g., "categorize=no"), and this template will not categorize the article.
To Edit/Modify this template
- If you need edit usage of this template, or if you need categorize this template, please edit Template:Purchasable rewards page/doc.
See also
- {{Trinket basic paragraph}} (Usage) — This template implements Template:Trinket basic paragraph.
