Template:Item: Difference between revisions

From Paw Borough Wiki
m (Removing Item/Sandbox)
(Added documentation template.)
 
Line 129: Line 129:
|synthetic=[[Category:Synthetic]]}}
|synthetic=[[Category:Synthetic]]}}
| #default = }}</includeonly><noinclude>
| #default = }}</includeonly><noinclude>
 
{{Documentation}}
==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.
 
Maintenance Categories:
* If <code>|flavor_text=</code> is empty then [[:Category:Missing Description]]
* 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:
* <code>|item=</code>
** [[:Category:Accessories]]
** [[:Category:Backdrops]]
** [[:Category:Combat Items]]
** [[:Category:Crests]]
** [[:Category:Decor]]
** [[:Category:Dyes]]
** [[:Category:Fauna]]
** [[:Category:Foods]]
** [[:Category:Formulas]]
** [[:Category:Incenses]]
** [[:Category:Metamorphics]]
** [[:Category:Pelts]]
** [[:Category:Pouches]]
* <code>|taxonomy=</code>
** [[:Category:Aquatic]]
** [[:Category:Avian]]
** [[:Category:Insectoid]]
** [[:Category:Mammalian]]
** [[:Category:Quartz]]
** [[:Category:Saurian]]
** [[:Category:Synthetic]]
* <code>|position=</code>
** [[:Category:Back]]
** [[:Category:Back Legs]]
** [[:Category:Back Paws]]
** [[:Category:Body]]
** [[:Category:Crown]]
** [[:Category:Ears]]
** [[:Category:Face]]
** [[:Category:Front Legs]]
** [[:Category:Front Paws]]
** [[:Category:Full Body]]
** [[:Category:Head]]
** [[:Category:Legs]]
** [[:Category:Lower Torso]]
** [[:Category:Neck]]
** [[:Category:Shoulders]]
** [[:Category:Tail]]
** [[:Category:Upper Torso]]
** [[:Category:Position Other]]
* <code>|rarity=</code>
** [[:Category:Rarity 0]]
** [[:Category:Rarity 1]]
** [[:Category:Rarity 2]]
** [[:Category:Rarity 3]]
** [[:Category:Rarity 4]]
** [[:Category:Rarity 5]]
** [[:Category:Rarity 6]]
 
==Syntax==
<pre>
{{Item
|name=
|img=
|capt1=
|smallimg=
|capt2=
|flavor_text=
|type=
|gets=
|price=
|curr=
|sell=
|flavor=
|nature=
|position=
|taxonomy=
|stam=
|rarity=
|debut=
}}
</pre>
 
==Examples==
{{Item
|name=
|img=
|capt1=
|smallimg=
|capt2=
|flavor_text=
|type=
|gets=
|price=
|curr=
|sell=
|flavor=
|nature=
|position=
|taxonomy=
|stam=
|rarity=
|debut=
}}
<pre>{{Item
|name=
|img=
|capt1=
|smallimg=
|capt2=
|flavor_text=
|type=
|gets=
|price=
|curr=
|sell=
|flavor=
|nature=
|position=
|taxonomy=
|stam=
|rarity=
|debut=
}}</pre>
{{-}}
 
{{Item
|name=Northern Lunasagi
|img=Lunasagi.png
|capt1=The Lunasagi
|smallimg=Placeholder.png
|capt2=Caption Two
|flavor_text=Hello world.
|type=Fauna
|gets=[[Errands]]
|price=500
|curr=silver
|sell=1000
|flavor={{f|Savory}}
|nature={{n|Nervous}}
|position=Back Legs
|taxonomy=Mammalian
|stam=20
|rarity=6
|debut=Date Here
}}
<pre>{{Item
|name=Northern Lunasagi
|img=Lunasagi.png
|capt1=The Lunasagi
|smallimg=Placeholder.png
|capt2=Caption Two
|flavor_text=Hello world.
|type=Fauna
|gets=[[Errands]]
|price=500
|curr=silver
|sell=1000
|flavor={{f|Savory}}
|nature={{n|Nervous}}
|position=Back Legs
|taxonomy=Mammalian
|stam=20
|rarity=6
|debut=Date Here
}}</pre>
{{-}}
 
== Template Parameters ==
<templatedata>
{
"params": {
"name": {
"default": "{{PAGENAME}}",
"description": "Name of the item, defaults to page name.",
"required": true
},
"img": {
"description": "Full resolution image of item.",
"example": "Placeholder.png",
"required": true
},
"capt1": {
"description": "Caption for large image.",
"example": "The [NAME] | [NAME] Item",
"required": true
},
"smallimg": {},
"capt2": {},
"type": {
"description": "Item category, associated icon and link are added automatically.",
"suggestedvalues": [
"Accessory",
"Backdrop",
"Combat",
"Crest",
"Decor",
"Dye",
"Fauna",
"Food",
"Formula",
"Incense",
"Metamorphic",
"Pelt",
"Pouch",
"Supply"
],
"required": true
},
"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.",
"required": true
},
"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.",
"type": "number",
"required": true,
"default": "N/A"
},
"curr": {
"description": "Adds {{c}} or {{s}} to the end of Price. Case insensitive.",
"suggestedvalues": [
"copper",
"silver",
"c",
"s"
],
"suggested": true
},
"sell": {
"description": "Sell price of the item, defaults to 0.",
"type": "number",
"default": "0",
"required": true
},
"flavor": {
"description": "Flavor of the item, if applicable. Wrap template {{f}} around each flavor.",
"suggestedvalues": [
"bitter",
"salty",
"savory",
"sour",
"spiced",
"sweet"
],
"suggested": true
},
"nature": {
"description": "Nature of the item, if applicable. Wrap template {{n}} around each nature. ",
"suggestedvalues": [
"assertive",
"careful",
"cranky",
"gentle",
"hardy",
"headstrong",
"heroic",
"jolly",
"lonely",
"mischievous",
"nervous",
"protective",
"relaxed",
"timid"
],
"suggested": true
},
"taxonomy": {
"description": "For fauna items, the general taxonomy class as seen in the database. Adds associated category automatically.",
"suggestedvalues": [
"Aquatic",
"Avian",
"Insectoid",
"Mammilian",
"Quartz",
"Suarian",
"Synthetic"
]
},
"position": {
"description": "For accessory items, the position of the accessory as seen in the Wardrobe. Adds associated category automatically.",
"suggestedvalues": [
"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"
],
"suggested": true
},
"rarity": {
"description": "Star rarity of the item. Rarity 1 and above have associated star icons. Each rarity applies a category.",
"suggested": true
},
"debut": {
"description": "When the item was released.",
"suggested": true
},
"stam": {
"description": "If a food item, the amount of replenished stamina upon use in Errands as seen in the database.",
"suggested": true
},
"flavor_text": {
"description": "The item's description/flavor text as seen in the database.",
"required": true
}
},
"description": "Infobox template for item pages.",
"paramOrder": [
"name",
"img",
"capt1",
"smallimg",
"capt2",
"flavor_text",
"type",
"gets",
"price",
"curr",
"sell",
"flavor",
"nature",
"position",
"taxonomy",
"stam",
"rarity",
"debut"
]
}
</templatedata>
[[Category:Templates]]
</noinclude>
</noinclude>

Latest revision as of 19:27, 1 May 2026

This template defines the table "Items". View table.


Template documentation follows
Visit Template:Item/doc to edit this documentation. (How does this work?)
Editors can experiment in this template's sandbox and test case pages.

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.

Maintenance Categories:

General Categories:

Syntax

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

Examples

Item
Missing Caption
[[File:|x100px]]
Missing Description
Type Missing Type
Obtainment Method Missing Obtainment
Cost N/A
Sell Price 0  
Flavor
Nature
Position
Taxonomy Class
Stamina +
Rarity Missing Rarity
Debut 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 1000  
Flavor  Savory
Nature  Nervous
Position Back Legs
Taxonomy Class Mammalian
Stamina +20
Rarity
Debut Date Date Here
{{Item
|name=Northern Lunasagi
|img=Lunasagi.png
|capt1=The Lunasagi
|smallimg=Placeholder.png
|capt2=Caption Two
|flavor_text=Hello world.
|type=Fauna
|gets=[[Errands]]
|price=500
|curr=silver
|sell=1000
|flavor={{f|Savory}}
|nature={{n|Nervous}}
|position=Back Legs
|taxonomy=Mammalian
|stam=20
|rarity=6
|debut=Date Here
}}

Template Parameters

Infobox template for item pages.

[Edit template data]

Template parameters

ParameterDescriptionTypeStatus
namename

Name of the item, defaults to page name.

Default
{{PAGENAME}}
Unknownrequired
imgimg

Full resolution image of item.

Example
Placeholder.png
Unknownrequired
capt1capt1

Caption for large image.

Example
The [NAME] | [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, associated icon and link are added automatically.

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

How the item is obtained. Obtainment methods should be linked, if there are multiple obtainment sources separate them with commas and order 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.

Default
N/A
Numberrequired
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.

Default
0
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.

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
Unknownoptional
stamstam

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

Unknownsuggested
rarityrarity

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

Unknownsuggested
debutdebut

When the item was released.

Unknownsuggested