User:Piripuwa/Sandbox/Template:Trinket basic paragraph/doc

From YPPedia
This is a usage of the Template:Trinket basic paragraph.

Usage

These usage notes will not be included in articles bearing this template.

This template can display a basic text and image for trinkets. This template should be used like following :

{{:User:Piripuwa/Sandbox/Template:Trinket basic paragraph
| trinket = Name of the trinket
| player-designed = yes / no
| designer = Designer's name
| season = Spring / Summer / Fall / Winter
| Atlantis = yes / no
| CI = yes / no
| HS = yes / no
| IO = yes / no
| BM = yes / no
| release = Released date
| month = The month when the trinket was released
| year = The year when the trinket was released
| prize-only = yes / no
| PoE = Cost of the trinket by PoE
| doubloons = Cost of the trinket by doubloons 
| multi-colors = yes / no
| use-compact-display = yes / no
| image = File name of the trinket colors' image
| inscribed = yes / no
| ad-text = Advertizement message
| custom = Additional text or wiki mark up
| color-range = Range of colors
| color-text = Sentence about colors
| prulal = yes / no
}}

Please see Template:Trinket basic paragraph/doc#Fileds and Template:Trinket basic paragraph/doc#Sample for more details.

Fields

name number default value note
trinket 1 A trinket's name as it would appear in-game. If you don't set this field, this template will display the page name as the trinket name.
player-designed 2 no If the trinket is a player-designed trinket, set "player-designed=yes". (optional)
designer 3 if the trinket is a player-designed trinket, set designer's name to this field. (optional)
If you don't set "player-designed" field, this field will be unavailable.
season 4 Set the season when the trinket is purchasable to this field. (optional)
e.g., if the trinket is spring trinket, set "season=spring".
Atlantis 5 no If the trinket is an Atlantian trinket, set "Atlantis =yes". (optional)
CI 6 no If the trinket is a Cursed Isles trinket, set "CI=yes". (optional)
HS 7 no If the trinket is a Haunted Seas trinket, set "HS=yes". (optional)
IO 8 no If the trinket is a Imperial outpost trinket, set "IO=yes". (optional)
BM 9 no If the trinket is a Black market trinket, set "BM=yes". (optional)
release 10 Set the date of the release note to this field. (optional)
e.g, if the trinket was released on 5 Feb, 2008, set "release=2008-02-05" and this template will link to release_2008-02-05.
month 11 Month when the trinket first appeared for sale. (optional)
If you don't set "year" field, this field will be unavailable.
year 12 Year when the trinket first appeared for sale. (optional)
prize-only 13 no If the trinket is only awarded by Ocean Masters, or as a prize in official tournaments, set "prize-only=yes". (optional)
PoE 14 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 15 Doubloon cost of the trinket. (optional)
If you don't set "PoE" field, this field will be unavailable.
multi-colors 16 no If the trinket comes in a range of colours, set "multi-colors=yes". (optional)
use-compact-display 17 no If the trinket comes in a range of colours, and the trinket has only one changeable color, set "use-compact-display=yes". (optional)
If you don't set "multi-colors" and "image" field or set "multi-colors=no", this field will be unavailable.
image 18 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.
inscribed 19 If the trinket inscribed with a message, set "inscribed-yes". (optional)
If you set "player-designed=yes", this template will set "inscribed=yes" automaticaly.
ad-text 20 Text of advertizement displayed in palace shoppe. (optional)
custom 21 If you set something to this field, this template will show it between opening paragraph and color section. (optional)
color-range 22 a range of If you set this field, this template will show a sentence of "Each trinket name comes in color-range colors."
This field is only available when you set "use-compact-display=yes", and set "image" field and don't set "color-text" field. (optional)
color-text 23 Each trinket name comes in color-range colors. / They are permitted to have two different colors per trinket. If you set this field, this template will display it in the color section.
If you don't set "image" field, this template will not be available. (optional)
plural 24 no If the trinket has a pluralised name, set yes to this field like "plural=yes". (optional)
imagewidth 25 755px If the trinket is a two-color trinket which does not have the enamel or cloth palette as the primary color, the default width will be too wide - use this to constrain the image to normal size. (optional)

Sample

For the player-created trinnkets, please see below 
For rewards trinkets, please see below 
For purchasable trinkts except player-created trinkts, please see below 

For unpurchasable trinkets

Code
{{:User:Piripuwa/Sandbox/Template:Trinket basic paragraph
| trinket = Spiky coral
| multi-colors = yes
| use-compact-display = yes
| custom = This is one of the [[Trinket#Beachcomber trinkets|beachcomber trinkets]].
| color-text = Each one may come in any of the standard colors and atlantean.
| image = Colors-trinket-Spiky coral.png
}}
Display
The Spiky coral is a trinket. This is one of the beachcomber trinkets.

Colors

Each one may come in any of the standard colors and atlantean.
Colors-trinket-Spiky coral.png
Colors-trinket-Spiky coral.png
Colors-trinket-Spiky coral.png
Colors-trinket-Spiky coral.png
Colors-trinket-Spiky coral.png


For unpurchasable pluralised trinkets

Code
{{:User:Piripuwa/Sandbox/Template:Trinket basic paragraph
| trinket = Daisies
| multi-colors = yes
| use-compact-display = yes
| custom = They may also come as trinkets [[Daisy|with just one]].
| image = Colors-trinket-Daisies.png
| plural = yes
}}
Display
The Daisies are a trinket. They may also come as trinkets with just one.

Colors

Each Daisies comes in a range of colors.
Colors-trinket-Daisies.png
Colors-trinket-Daisies.png
Colors-trinket-Daisies.png
Colors-trinket-Daisies.png
Colors-trinket-Daisies.png


For non-player-designed purchasable trinkets

Code
{{:User:Piripuwa/Sandbox/Template:Trinket basic paragraph
| trinket = Candy cane
| season = Winter
| month = December
| year = 2008
| PoE = 1,000
| doubloons = 1
| ad-text = Tie a note for yer hearty around this tasty treat.
}}
Display
Candy cane

Tie a note for yer hearty around this tasty treat.
PoE 1,000 Doubloons 1

The Candy cane is a winter trinket, which first appeared for sale in the palace shoppe in December 2008. The Candy cane can be purchased for 1,000 PoE (and 1 doubloon, on doubloon oceans).

For prize-only trinkets

Code
{{:User:Piripuwa/Sandbox/Template:Trinket basic paragraph | trinket = Winter ornament (sphere) | prize-only = yes}}
Display
The Winter ornament (sphere) is a trinket. It is only awarded by Ocean Masters, or as a prize in official tournaments

Simple setting

Code Display Note
{{:User:Piripuwa/Sandbox/Template:Trinket basic paragraph
| trinket = Candy cane
| season = Winter
| month = December
| year = 2008
| PoE = 1,000
| doubloons = 1
}}
The Candy cane is a winter trinket, which first appeared for sale in the palace shoppe in December 2008. The Candy cane can be purchased for 1,000 PoE (and 1 doubloon, on doubloon oceans). If you don't set ad-text field, this template will not display the infobox.

Most simple setting

Code Display Note
{{:User:Piripuwa/Sandbox/Template:Trinket basic paragraph}} The Piripuwa/Sandbox/Template:Trinket basic paragraph/doc is a trinket. If you don't set trinket field, this template will display the page name as the trinket name.

Wrong settings

Code Display Note
{{:User:Piripuwa/Sandbox/Template:Trinket basic paragraph | trinket= }} If you set the empty/blank to trinket field, this template doesn't work enough.
{{:User:Piripuwa/Sandbox/Template:Trinket basic paragraph
| trinket=Candy cane
| month = March
}}
The Candy cane is a trinket. If you don't set or set the empty to year field, this template doesn't show about the month.
{{:User:Piripuwa/Sandbox/Template:Trinket basic paragraph
| trinket=Candy cane
| designer = Samplepirate }}
The Candy cane is a trinket. If you don't set "yes" or set the empty to player-designed field, this template doesn't show designer's name.
{{:User:Piripuwa/Sandbox/Template:Trinket basic paragraph
| trinket=Candy cane
| doubloon = 999 }}
The Candy cane is a trinket. If you don't set or set the empty to PoE field, this template doesn't show about doubloon cost.

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

See also

This template is used by below templates :

This template includes below :