Template:Item/doc: Difference between revisions

From Paw Borough Wiki
(Doc page)
 
(Updates to hopefully make this more understandable.)
Line 1: Line 1:
==Usage==
==Usage==
An infobox template for items pages. All article pages that transclude this template are put into [[:Category:Items]]. Additional categories are added if parameters meet certain criteria. See the list of automatic categories below.
An {{wp|infobox}} template for item pages. This template summarizes item information, and should be used in tandem with rather than replace a pages contents.


Maintenance Categories:
===Automatic Categories===
* If <code>|flavor_text=</code> is empty then [[:Category:Missing Description]]
All pages in the Main namespace that call upon this template are put into [[:Category:Items]]. Additional categories are added if parameters meet certain criteria.
* If <code>|type=</code> is empty then [[:Category:Missing Type]]
* If <code>|img=</code> is empty then [[:Category:Missing Image]]
* If <code>|gets=</code> is empty then [[:Category:Missing Obtainment]]
* If <code>|rarity=</code> is empty then [[:Category:Missing Rarity]]


General Categories:
The following maintenance categories are added if the following parameters are omitted:
* If <code>|flavor_text=</code> is empty then [[:Category:Missing Description]] is added
* If <code>|type=</code> is empty then [[:Category:Missing Type]] is added
* If <code>|img=</code> is empty then [[:Category:Missing Image]] is added
* If <code>|gets=</code> is empty then [[:Category:Missing Obtainment]] is added
* If <code>|rarity=</code> is empty then [[:Category:Missing Rarity]] is added
* If <code>|debut=</code> is empty then [[:Category:Missing Debut]] is added
Maintenace categories are removed the moment the above parameters contain text.
 
 
The following categories are added if a parameter matches the following text:
* <code>|item=</code>
* <code>|item=</code>
** [[:Category:Accessories]]
** If "Accessory" then [[:Category:Accessories]]
** [[:Category:Backdrops]]
** If "Backdrop" then [[:Category:Backdrops]]
** [[:Category:Combat Items]]
** If "Combat" then [[:Category:Combat Items]]
** [[:Category:Crests]]
** If "Crest" then [[:Category:Crests]]
** [[:Category:Decor]]
** If "Decor" then [[:Category:Decor]]
** [[:Category:Dyes]]
** If "Dye" then [[:Category:Dyes]]
** [[:Category:Fauna]]
** If "Fauna" then [[:Category:Fauna]]
** [[:Category:Foods]]
** If "Food" then [[:Category:Foods]]
** [[:Category:Formulas]]
** If "Formula" then [[:Category:Formulas]]
** [[:Category:Incenses]]
** If "Incense" then [[:Category:Incenses]]
** [[:Category:Metamorphics]]
** If "Metamorphic" then [[:Category:Metamorphics]]
** [[:Category:Pelts]]
** If "Pelt" then [[:Category:Pelts]]
** [[:Category:Pouches]]
** If "Pouch" then [[:Category:Pouches]]
* <code>|taxonomy=</code>
* <code>|taxonomy=</code>
** [[:Category:Aquatic]]
** If "Aquatic" then [[:Category:Aquatic]]
** [[:Category:Avian]]
** If "Avian" then [[:Category:Avian]]
** [[:Category:Insectoid]]
** If "Insectoid" then [[:Category:Insectoid]]
** [[:Category:Mammalian]]
** If "Mammalian" then [[:Category:Mammalian]]
** [[:Category:Quartz]]
** If "Quartz" then [[:Category:Quartz]]
** [[:Category:Saurian]]
** If "Saurian" then [[:Category:Saurian]]
** [[:Category:Synthetic]]
** If "Synthetic" then [[:Category:Synthetic]]
* <code>|position=</code>
* <code>|position=</code> (note: categories are only added if parameter text is an exact match, in other words an accessory that falls under two or more position categories must have the categories added manually)
** [[:Category:Back]]
** If "Back" then [[:Category:Back]]
** [[:Category:Back Legs]]
** If "Back Legs" then [[:Category:Back Legs]]
** [[:Category:Back Paws]]
** If "Back Paws" then [[:Category:Back Paws]]
** [[:Category:Body]]
** If "Body" then [[:Category:Body]]
** [[:Category:Crown]]
** If "Crown" then [[:Category:Crown]]
** [[:Category:Ears]]
** If "Ears" then [[:Category:Ears]]
** [[:Category:Face]]
** If "Face" then [[:Category:Face]]
** [[:Category:Front Legs]]
** If "Front Legs" then [[:Category:Front Legs]]
** [[:Category:Front Paws]]
** If "Front Paws" then [[:Category:Front Paws]]
** [[:Category:Full Body]]
** If "Full Body" then [[:Category:Full Body]]
** [[:Category:Head]]
** If "Head" then [[:Category:Head]]
** [[:Category:Legs]]
** If "Legs" then [[:Category:Legs]]
** [[:Category:Lower Torso]]
** If "Lower Torso" then [[:Category:Lower Torso]]
** [[:Category:Neck]]
** If "Neck" then [[:Category:Neck]]
** [[:Category:Shoulders]]
** If "Shoulders" then [[:Category:Shoulders]]
** [[:Category:Tail]]
** If "Tail" then [[:Category:Tail]]
** [[:Category:Upper Torso]]
** If "Upper Torso" then [[:Category:Upper Torso]]
** [[:Category:Position Other]]
** If "Other" then [[:Category:Position Other]]
* <code>|rarity=</code>
* <code>|rarity=</code>
** [[:Category:Rarity 0]]
** If "0" then [[:Category:Rarity 0]]
** [[:Category:Rarity 1]]
** If "1" then [[:Category:Rarity 1]]
** [[:Category:Rarity 2]]
** If "2" then [[:Category:Rarity 2]]
** [[:Category:Rarity 3]]
** If "3" then [[:Category:Rarity 3]]
** [[:Category:Rarity 4]]
** If "4" then [[:Category:Rarity 4]]
** [[:Category:Rarity 5]]
** If "5" then [[:Category:Rarity 5]]
** [[:Category:Rarity 6]]
** If "6" then [[:Category:Rarity 6]]


==Syntax==
==Syntax==
Line 126: Line 132:
}}</pre>
}}</pre>
{{-}}
{{-}}


{{Item
{{Item
Line 135: Line 142:
|flavor_text=Hello world.
|flavor_text=Hello world.
|type=Fauna
|type=Fauna
|gets=[[Errands]]
|gets={{i|Errands}}
|price=500
|price=500
|curr=silver
|curr=silver
|sell=1000
|sell=1,000
|flavor={{f|Savory}}
|flavor={{f|Savory}}
|nature={{n|Nervous}}
|nature={{n|Nervous}}
Line 145: Line 152:
|stam=20
|stam=20
|rarity=6
|rarity=6
|debut=Date Here
|debut=January 1, 1999
}}
}}
<pre>{{Item
<pre>{{Item
Line 155: Line 162:
|flavor_text=Hello world.
|flavor_text=Hello world.
|type=Fauna
|type=Fauna
|gets=[[Errands]]
|gets={{i|Errands}}
|price=500
|price=500
|curr=silver
|curr=silver
|sell=1000
|sell=1,000
|flavor={{f|Savory}}
|flavor={{f|Savory}}
|nature={{n|Nervous}}
|nature={{n|Nervous}}
Line 165: Line 172:
|stam=20
|stam=20
|rarity=6
|rarity=6
|debut=Date Here
|debut=January 1, 1999
}}</pre>
}}</pre>
{{-}}
{{-}}
Line 176: Line 183:
"default": "{{PAGENAME}}",
"default": "{{PAGENAME}}",
"description": "Name of the item, defaults to page name.",
"description": "Name of the item, defaults to page name.",
"required": true
"required": true,
"type": "wiki-page-name"
},
},
"img": {
"img": {
"description": "Full resolution image of item.",
"description": "Full resolution image of item.",
"example": "Placeholder.png",
"example": "Placeholder.png",
"required": true
"required": true,
"type": "wiki-file-name"
},
},
"capt1": {
"capt1": {
"description": "Caption for large image.",
"description": "Caption for large image.",
"example": "The [NAME] | [NAME] Item",
"example": "The [NAME] or [NAME] Item",
"required": true
"required": true
},
},
Line 191: Line 200:
"capt2": {},
"capt2": {},
"type": {
"type": {
"description": "Item category, associated icon and link are added automatically.",
"description": "Item category, uses template {{i}} to automatically add links and icons.",
"suggestedvalues": [
"suggestedvalues": [
"Accessory",
"Accessory",
Line 211: Line 220:
},
},
"gets": {
"gets": {
"description": "How the item is obtained. Obtainment methods should be linked, if there are multiple obtainment sources separate them with commas and order alphabetically.",
"description": "How the item is obtained. Wrap template {{i}} around each obtainment method. Multiple obtainment sources should be separated by a comma and ordered alphabetically.",
"required": true
"required": true
},
},
"price": {
"price": {
"description": "The Copper/Silver/USD price of the item if found in NPC shops or premium bundles. Default is \"N/A\" if left empty.",
"description": "The Copper/Silver/USD price of the item if found in NPC shops or premium bundles. Default is \"N/A\" if left empty. Use commas for thousands separator.",
"type": "number",
"required": true,
"required": true,
"default": "N/A"
"default": "N/A",
"example": "15,000"
},
},
"curr": {
"curr": {
Line 231: Line 240:
},
},
"sell": {
"sell": {
"description": "Sell price of the item, defaults to 0.",
"description": "Sell price of the item, defaults to 0. Use commas for thousands separator.",
"type": "number",
"type": "number",
"default": "0",
"default": "0",
"required": true
"required": true,
"example": "15,000"
},
},
"flavor": {
"flavor": {
Line 278: Line 288:
"Suarian",
"Suarian",
"Synthetic"
"Synthetic"
]
],
"suggested": true
},
},
"position": {
"position": {
"description": "For accessory items, the position of the accessory as seen in the Wardrobe. Adds associated category automatically.",
"description": "For accessory items, the position of the accessory as seen in the Wardrobe. Adds associated category automatically. In the case an accessory item falls under two or more position categories then categories must be added manually.",
"suggestedvalues": [
"suggestedvalues": [
"Back",
"Back",
Line 306: Line 317:
"rarity": {
"rarity": {
"description": "Star rarity of the item. Rarity 1 and above have associated star icons. Each rarity applies a category.",
"description": "Star rarity of the item. Rarity 1 and above have associated star icons. Each rarity applies a category.",
"suggested": true
"suggested": true,
"type": "number"
},
},
"debut": {
"debut": {
"description": "When the item was released.",
"description": "When the item was released. Format dates as 'Month Day, Year'.",
"suggested": true
"example": "January 1, 2026",
"required": true
},
},
"stam": {
"stam": {
"description": "If a food item, the amount of replenished stamina upon use in Errands as seen in the database.",
"description": "If a food item, the amount of replenished stamina upon use in Errands as seen in the database.",
"suggested": true
"suggested": true,
"example": "20",
"type": "number"
},
},
"flavor_text": {
"flavor_text": {

Revision as of 20:52, 9 May 2026

Usage

An infobox template for item pages. This template summarizes item information, and should be used in tandem with rather than replace a pages contents.

Automatic Categories

All pages in the Main namespace that call upon this template are put into Category:Items. Additional categories are added if parameters meet certain criteria.

The following maintenance categories are added if the following parameters are omitted:

Maintenace categories are removed the moment the above parameters contain text.


The following categories are added if a parameter matches the following text:

Syntax

{{Item
|name=
|img=
|capt1=
|smallimg=
|capt2=
|flavor_text=
|type=
|gets=
|price=
|curr=
|sell=
|flavor=
|nature=
|position=
|taxonomy=
|stam=
|rarity=
|debut=
}}

Examples

Item/doc
Missing Caption
[[File:|x100px]]
Missing Description
Type Missing Type
Obtainment Method Missing Obtainment
Cost N/A
Sell Price
Flavor
Nature
Position
Taxonomy Class
Stamina
Rarity Missing Rarity
Debut Date Missing Date
{{Item
|name=
|img=
|capt1=
|smallimg=
|capt2=
|flavor_text=
|type=
|gets=
|price=
|curr=
|sell=
|flavor=
|nature=
|position=
|taxonomy=
|stam=
|rarity=
|debut=
}}



Northern Lunasagi
The Lunasagi
Caption Two
Hello world.
Type  Fauna
Obtainment Method  Errands
Cost 500 
Sell Price 1,000 
Flavor  Savory
Nature  Nervous
Position
Taxonomy Class Mammalian
Stamina
Rarity
Debut Date January 1, 1999
{{Item
|name=Northern Lunasagi
|img=Lunasagi.png
|capt1=The Lunasagi
|smallimg=Placeholder.png
|capt2=Caption Two
|flavor_text=Hello world.
|type=Fauna
|gets={{i|Errands}}
|price=500
|curr=silver
|sell=1,000
|flavor={{f|Savory}}
|nature={{n|Nervous}}
|position=Back Legs
|taxonomy=Mammalian
|stam=20
|rarity=6
|debut=January 1, 1999
}}

Template Parameters

Infobox template for item pages.

Template parameters

ParameterDescriptionTypeStatus
namename

Name of the item, defaults to page name.

Default
{{PAGENAME}}
Page namerequired
imgimg

Full resolution image of item.

Example
Placeholder.png
Filerequired
capt1capt1

Caption for large image.

Example
The [NAME] or [NAME] Item
Unknownrequired
smallimgsmallimg

no description

Unknownoptional
capt2capt2

no description

Unknownoptional
flavor_textflavor_text

The item's description/flavor text as seen in the database.

Unknownrequired
typetype

Item category, uses template {{i}} to automatically add links and icons.

Suggested values
Accessory Backdrop Combat Crest Decor Dye Fauna Food Formula Incense Metamorphic Pelt Pouch Supply
Unknownrequired
getsgets

How the item is obtained. Wrap template {{i}} around each obtainment method. Multiple obtainment sources should be separated by a comma and ordered alphabetically.

Unknownrequired
priceprice

The Copper/Silver/USD price of the item if found in NPC shops or premium bundles. Default is "N/A" if left empty. Use commas for thousands separator.

Default
N/A
Example
15,000
Unknownrequired
currcurr

Adds {{c}} or {{s}} to the end of Price. Case insensitive.

Suggested values
copper silver c s
Unknownsuggested
sellsell

Sell price of the item, defaults to 0. Use commas for thousands separator.

Default
0
Example
15,000
Numberrequired
flavorflavor

Flavor of the item, if applicable. Wrap template {{f}} around each flavor.

Suggested values
bitter salty savory sour spiced sweet
Unknownsuggested
naturenature

Nature of the item, if applicable. Wrap template {{n}} around each nature.

Suggested values
assertive careful cranky gentle hardy headstrong heroic jolly lonely mischievous nervous protective relaxed timid
Unknownsuggested
positionposition

For accessory items, the position of the accessory as seen in the Wardrobe. Adds associated category automatically. In the case an accessory item falls under two or more position categories then categories must be added manually.

Suggested values
Back Back Legs Back Paws Body Crown Ears Face Front Legs Front Paws Full Body Head Legs Lower Torso Neck Shoulders Tail Upper Torso Other
Unknownsuggested
taxonomytaxonomy

For fauna items, the general taxonomy class as seen in the database. Adds associated category automatically.

Suggested values
Aquatic Avian Insectoid Mammilian Quartz Suarian Synthetic
Unknownsuggested
stamstam

If a food item, the amount of replenished stamina upon use in Errands as seen in the database.

Example
20
Numbersuggested
rarityrarity

Star rarity of the item. Rarity 1 and above have associated star icons. Each rarity applies a category.

Numbersuggested
debutdebut

When the item was released. Format dates as 'Month Day, Year'.

Example
January 1, 2026
Unknownrequired