This template invokes the Lua module Module:Wares.

Template:Wares

From Zelda Wiki, the Zelda encyclopedia
Jump to navigation Jump to search


Purpose

Lists items sold by Merchants and Shops.

Usage

Simplified SyntaxExtended SyntaxMultiple Prices (Simplified Syntax)Multiple Prices (Extended Syntax)
{{Wares
|game= 
|-
| <item>
| <price>
| <description>
|-
| <item>
| <price>
| <description>
|- 
| <item>
| <price>
| <description>
}}
{{Wares
|game= 
|showQuantityColumn=
|collapse= 
|-
|{{Wares/Item
 |item= 
 |price= 
 |display= 
 |quantity= 
 |stock= 
 |restocks= 
 |description= 
 }}
|-
|{{Wares/Item
 |item= 
 |price= 
 |display= 
 |quantity= 
 |stock= 
 |restocks= 
 |description= 
 }}
}}
{{Wares|game= |prices= <priceName1>, <priceName2>
|-
| <item>
| <price1>
| <price2>
| <description>
|-
| <item>
| <price1>
| <price2>
| <description>
|- 
| <item>
| <price1>
| <price2>
| <description>
}}
{{Wares|game= |prices= <priceName1>, <priceName2>
|-
|{{Wares/Item
 |item= 
 |price1= 
 |price2= 
 |display= 
 |quantity= 
 |restocks= 
 |stock= 
 |description= 
 }}
|-
|{{Wares/Item
 |item= 
 |price1= 
 |price2= 
 |display= 
 |quantity= 
 |stock= 
 |restocks= 
 |description= 
 }}
|-
|{{Wares/Item
 |item= 
 |price1= 
 |price2= 
 |display= 
 |quantity= 
 |stock= 
 |restocks= 
 |description= 
 }}
}}
ParameterRequired?Description
game
RequiredA game code.
showQuantityColumn
OptionalSet to true to display a Quantity column in the price table. Usually not required as quantity values are normally shown in the item's displayed name (see #Display Format below).
prices
OptionalA comma-separated list of price names to display as columns in the price table.
collapse
OptionalIf set to true, the table is collapsed such that only a small preview of the data is shown, with a "show more" button that reveals the full table when clicked. This functionality depends on MediaWiki:Gadget-Collapse.js.
fileType
OptionalThe type of files to show. Defaults to Sprite for 2D games, Model for most 3D games, and Icon for Breath of the Wild, Tears of the Kingdom, Age of Calamity, and Age of Imprisonment.
1 to N
(items)
RequiredA tuple of 1-arity to N+2-arity where N is the number of prices listed.
  • For 1-arity, each item is defined using the extended syntax of {{Wares/Item}}, which allows more information about the items to be specified.
  • For a single price with simple syntax, the tuple is 2- or 3-arity:
    1. The item for sale written in the format quantity item-name, where quantity is a number and item-name is singular and refers to a page on the wiki. Omit quantity for items sold as singles.
    2. The item's price written in the format amount item-name. amount can be omitted for unique items used in bartering, such as Star-Shaped Ore.
    3. The description shown when the store item is selected, if applicable.
  • For multiple prices with simple syntax, the tuple is 3- to N+2-arity
    • 1. The item for sale written in the format quantity item-name. Omit quantity for items sold as singles.
    • 2 to N+1. The prices for the item corresponding to the 1st to Nth prices named in the prices parameter above.
    • N+2. The description shown when the store item is selected, if applicable.

No description.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
gamegame

A [[:Category:Game codes|game code]].

Contentoptional
showQuantityColumnshowQuantityColumn

Set to <code>true</code> to display a <kbd>Quantity</kbd> column in the price table. Usually not required as quantity values are normally shown in the item's displayed name (see [[#Display Format]] below).

Contentoptional
pricesprices

A [[ZW:COMMALIST|comma-separated list]] of price names to display as columns in the price table.

Contentoptional
collapsecollapse

If set to <code>true</code>, the table is collapsed such that only a small preview of the data is shown, with a "show more" button that reveals the full table when clicked. This functionality depends on [[MediaWiki:Gadget-Collapse.js]].

Contentoptional
fileTypefileType

The type of files to show. Defaults to <code>Sprite</code> for 2D games, <code>Model</code> for most 3D games, and <code>Icon</code> for ''[[The Legend of Zelda: Breath of the Wild|Breath of the Wild]]'', ''[[The Legend of Zelda: Tears of the Kingdom|Tears of the Kingdom]]'', ''[[Hyrule Warriors: Age of Calamity|Age of Calamity]]'', and ''[[Hyrule Warriors: Age of Imprisonment|Age of Imprisonment]]''.

Contentoptional

Display Format

Name

By default, an item's displayed name is automatically generated based on the game, item, and quantity parameters (item is either the parameter of the same name in the extended syntax of {{Wares/Item}} or the first value of a tuple in the simplified syntax; quantity is from the extended syntax). This is done to accurately reflect the in-game presentation of the item. For example, Breath of the Wild store menus present 10 Arrows as Arrow x10, whereas Ocarina of Time 3D displays Arrows (10). Template:Term or Template:Plural is applied to the item parameter to generate the display name. The game-specific formats are configured at Module:Wares/Data.

If a particular shop in the game shows something different than what this template outputs by default, use the display parameter in the extended syntax. Include a link to the item's article as well as the item quantity if this is displayed as part of the item's name in the shop.

Because an item's quantity is normally shown in its displayed name, it is not necessary for the price table to have a Quantity column in most cases. There are exceptions—Malo Mart Castle Branch only mentions quantities in the descriptions, and A Link to the Past shop items aren't named at all as Link instantly buys them upon picking them up. In these cases, a Quantity column can be added using the showQuantityColumn parameter.

If the item parameter contains a link (e.g. [[Deku Stick]] upgrade), then the wikitext in that parameter is displayed as-is. No image is shown for that item unless the image parameter in the extended syntax is used.

Image

The image displayed for the item is also automatically generated based on the game, item, and quantity parameters. For example, A Link to the Past has for packs of 10 Bombs and for 30 Bombs, whereas The Wind Waker simply displays for all quantities. Most 3D games use models to display shop items but some newer games such as Breath of the Wild use icons. The game-specific image formats are configured at Module:Wares/Data as well.

While an image parameter does exist in the extended syntax, which can override the default file format with a custom image, using this parameter is generally discouraged for the sake of consistency.

A fileType parameter also exists and can be set to Icon to show icons instead of models. Using this parameter is, again, generally discouraged for the sake of consistency. See Curiosity Shop for a usage example.

Examples

InputOutputCategories added
Empty wares table, for stubs
{{Wares|game= ALBW}}
ItemPrice
Kokiri Shop wares, using the simplified syntax
{{Wares|game= OoT3D
|-
| 10 Arrow
| 20 Rupee
|-
| 30 Arrow
| 60 Rupee
|-
| 30 Deku Seed
| 30 Rupee
|-
| 5 Deku Nut
| 15 Rupee
|-
| 10 Deku Nut
| 30 Rupee
|-
| Deku Shield
| 40 Rupee
|-
| Deku Stick
| 10 Rupee
|-
| Recovery Heart
| 10 Rupee
}}
Item
Arrows (10)
Price
20 Rupees
Item
Arrows (30)
Price
Item
Price
Item
Price
Item
Price
Item
Price
Item
Price
Item
Price
The image used depends on the game, item, and quantity parameters
{{Wares|game= ALttP
|-
| 10 Bomb
| 50 Rupee
|-
| 30 Bomb
| 100 Rupee
}}
Item
Price
Item
Price
100 Rupees
ItemPrice
100 Rupees
Subrosia Market, using the extended syntax with the display parameter and non-Rupee prices
{{Wares|game= OoS
|-
|{{Wares/Item
 |item= Ribbon
 |display= A cute [[Ribbon]]
 |stock= 1
 |price= Star-Shaped Ore
 }}
|-
|{{Wares/Item
 |item= Rare Peach Stone
 |stock= 1
 |price= 20 Ore Chunk, 10 Ember Seed
 }}
|-
|{{Wares/Item
 |item= Member's Card
 |display= [[Member's Card|A cutting board?]]
 |stock= 1
 |price= 5 Ore Chunk
 }}
}}
Item
A cute Ribbon
Price
Stock
1
Item
Price
Stock
1
Item
Price
Stock
1
Business Scrub in Ocarina of Time, mixing the simplified and extended syntax so that the image parameter can be used for the entries that need it
{{Wares
|game= OoT3D
|collapse= true
|-
| Deku Stick
| 15 Rupee
|-
| Deku Shield
| 50 Rupee
|-
| Piece of Heart
| 10 Rupee
|-
|{{Wares/Item
 |item= [[Deku Stick]] upgrade
 |image= File:OoT3D Deku Stick Model.png
 |price= 40
 }}
|-
|{{Wares/Item
 |item= [[Deku Nut]] upgrade
 |image= File:OoT3D Deku Nut Model.png
 |price= 40
 }}
}}
{{List Notes}}
Item
Price
Item
Price
Item
Price
Item
Deku Stick upgrade
Price
Item
Deku Nut upgrade
Price
Malo Mart Castle Branch wares, using the display, showQuantityColumn, and collapse parameters
{{Wares
|game= TPHD
|showQuantityColumn= true
|collapse= true
|-
|{{Wares/Item
 |item= Bomb
 |display= {{Color TPHD|Gold|[[Bomb]]s}} {{Color TPHD|Red|!Blast Deal!}}
 |quantity= 30
 |price= 45
 |description= Made by Barnes Co. (set of 30)<br/>Only Malo Mart can deliver these savings!
 }}
|-
|{{Wares/Item
 |item= Water Bomb
 |display= {{Color TPHD|Gold|[[Water Bomb]]s}} {{Color TPHD|Red|!Big Deal!}}
 |quantity= 15
 |price= 45
 |description= For aquatic defense. (set of 15)<br/>No one can beat this price!
 }}
|-
|{{Wares/Item
 |item= Bombling
 |display= {{Color TPHD|Gold|[[Bombling]]}} {{Color TPHD|Red|!Boom Deal!}}
 |quantity= 10
 |price= 30
 |description= These endangered creatures have been successfully propagated!<br/>This is a special 10-Bombling set!
 }}
|-
|{{Wares/Item
 |item= Malo Mart Stamp
 |display= {{Color TPHD|Gold|[[Malo Mart Stamp|"Malo Mart" Stamp]]}} {{Color TPHD|Red|!Unique !}}
 |price= 50
 |description= With the Malo Mart logo! This one-of-a-kind commemorative piece is sure to leave an impression.
 }}
|-
|{{Wares/Item
 |item= Blue Potion
 |display= {{Color TPHD|Blue|[[Blue Potion]]}} {{Color TPHD|Red|!Act Now!}}
 |price= 50
 |description= A restorative elixir recommended for those who do not feel 100%.<br/>(Requires an empty bottle.)
 }}
|-
|{{Wares/Item
 |item= Red Potion
 |display= {{Color TPHD|Red|[[Red Potion]]}} {{Color TPHD|Gold|!Feature!}}
 |price= 15
 |description= Just one bottle is the perfect pick-me-up!<br/>(Requires an empty bottle.)
 }}
|-
|{{Wares/Item
 |item= Magic Armor
 |display= {{Color TPHD|Gold|[[Magic Armor]]}} {{Color TPHD|Red|!Special!}}
 |price= 598
 |description= This is quite a bargain when you think of how valuable your life is. What's a few Rupees to stay alive?
 }}
}}
Item
Bombs !Blast Deal!
Quantity
30
Price
Description

Made by Barnes Co. (set of 30)
Only Malo Mart can deliver these savings!

Item
Water Bombs !Big Deal!
Quantity
15
Price
Description

For aquatic defense. (set of 15)
No one can beat this price!

Item
Bombling !Boom Deal!
Quantity
10
Price
Description

These endangered creatures have been successfully propagated!
This is a special 10-Bombling set!

Item
Quantity
1
Price
Description

With the Malo Mart logo! This one-of-a-kind commemorative piece is sure to leave an impression.

Item
Blue Potion !Act Now!
Quantity
1
Price
Description

A restorative elixir recommended for those who do not feel 100%.
(Requires an empty bottle.)

Item
Red Potion !Feature!
Quantity
1
Price
Description

Just one bottle is the perfect pick-me-up!
(Requires an empty bottle.)

Item
Magic Armor !Special!
Quantity
1
Price
598 Rupees
Description

This is quite a bargain when you think of how valuable your life is. What's a few Rupees to stay alive?

ItemQuantityPriceDescription
Bombs !Blast Deal!
30

Made by Barnes Co. (set of 30)
Only Malo Mart can deliver these savings!

Water Bombs !Big Deal!
15

For aquatic defense. (set of 15)
No one can beat this price!

Bombling !Boom Deal!
10

These endangered creatures have been successfully propagated!
This is a special 10-Bombling set!

1

With the Malo Mart logo! This one-of-a-kind commemorative piece is sure to leave an impression.

Blue Potion !Act Now!
1

A restorative elixir recommended for those who do not feel 100%.
(Requires an empty bottle.)

Red Potion !Feature!
1

Just one bottle is the perfect pick-me-up!
(Requires an empty bottle.)

Magic Armor !Special!
1
598 Rupees

This is quite a bargain when you think of how valuable your life is. What's a few Rupees to stay alive?

Chumin's wares, using restocking information from Module:Wares/Data
{{Wares|game= BotW
|-
|{{Wares/Item
 |item= Palm Fruit
 |price= 16
 |stock= 5
 }}
|-
|{{Wares/Item
 |item= Bright-Eyed Crab
 |price= 40
 |stock= 3
 }}
|-
|{{Wares/Item
 |item= Hearty Blueshell Snail
 |price= 60
 |stock= 3
 }}
}}
Item
Price
Stock
5[a]
Item
Price
Stock
Item
Price
Stock
  1. 1.0 1.1 1.2 Restocks.[when?]
Beedle's Shop Ship, using the restocks parameter and the special Varies price value
{{Wares|game= PH
|-
|{{Wares/Item
 |item= Bomb Bag
 |price= 1,000
 |stock= 1
 }}
|-
|{{Wares/Item
 |item= Wisdom Gem
 |price= 500
 |stock= 1
 }}
|-
|{{Wares/Item
 |item= Ship Part
 |price= Varies
 |stock= 1
 |restocks= {{#vardefineecho:restock|Restocks daily.<ref>{{Cite|Ohh, I'm currently out of stock, but choice items are in transit! ...Would I lie?|Beedle|PH}}</ref>}}
 }}
|-
|{{Wares/Item
 |item= Treasure
 |price= Varies
 |stock= 1
 |restocks= {{#var:restock}}
 }}
}}
Item
Price
1,000 Rupees
Stock
1
Item
Price
500 Rupees
Stock
1
Item
Price
Varies
Stock
Item
Price
Varies
Stock
ItemPriceStock
1,000 Rupees
1
500 Rupees
1
Varies
Varies
  1. 1.0 1.1 Restocks daily.[1]
Witch's Hut in A Link Between Worlds with multiple prices (simplified syntax)
{{Wares|game= ALBW|prices= Rupees, Materials
|-
| Red Potion
| 50 Rupee
| N/A
| Restores eight hearts! This will definitely come in handy.
|- 
| Blue Potion
| 200 Rupee
| 10 Monster Tail
| Restores all of your hearts. You can't go wrong with one!
|- 
| Yellow Potion
| 100 Rupee
| 10 Monster Horn
| Drink it to make yourself invulnerable for a short time!
|- 
| Purple Potion
| 60 Rupee
| 10 Monster Guts
| Drink this to damage all surrounding enemies.
}}
Item
PricesRupees
Materials
Not Applicable
Description

Restores eight hearts! This will definitely come in handy.

Item
PricesRupees
200 Rupees
Materials
Description

Restores all of your hearts. You can't go wrong with one!

Item
PricesRupees
100 Rupees
Materials
Description

Drink it to make yourself invulnerable for a short time!

Item
PricesRupees
Materials
Description

Drink this to damage all surrounding enemies.

ItemPricesDescription
RupeesMaterials
Not Applicable

Restores eight hearts! This will definitely come in handy.

200 Rupees

Restores all of your hearts. You can't go wrong with one!

100 Rupees

Drink it to make yourself invulnerable for a short time!

Drink this to damage all surrounding enemies.

Beedle's Airshop wares table with multiple prices (extended syntax)
{{Wares|game= ST|prices= Full Price, Silver Membership, Gold Membership, Platinum Membership, Diamond Membership
|-
|{{Wares/Item
 |item= Treasure
 |price1= 300
 |price2= 270
 |price3= 240
 |price4= 210
 |price5= 150
 |stock= 1
 |restocks= Restocks daily.<ref>{{Cite|Ohhh, so sorry. We're sold out of those. You'll have to wait until tomorrow.|Beedle|ST}}</ref>
 }}
}}
Item
PricesFull Price
300 Rupees
Silver Membership
270 Rupees
Gold Membership
240 Rupees
Platinum Membership
210 Rupees
Diamond Membership
150 Rupees
Stock
ItemPricesStock
Full PriceSilver MembershipGold MembershipPlatinum MembershipDiamond Membership
300 Rupees
270 Rupees
240 Rupees
210 Rupees
150 Rupees
  1. Restocks daily.[2]
Error: Item missing prices when multiple prices are specified
{{Wares|game= TWW|prices= A, B
|-
| Bomb
| 10 Rupee
}}
Editor warning: Invalid arguments
The following table is incomplete. You can help Zelda Wiki by editing the page and filling in the empty cells.
Item
PricesA
B
ItemPrices
AB
Error: Item with multiple prices when prices parameter is not set
{{Wares|game= TWW
|-
|{{Wares/Item
 |item= Bomb 
 |price1= 10,000
 |price2= 20
 }}
}}
Editor warning: Invalid arguments
ItemPrice

Guidelines

The item image and text shown in the Wares tables should reflect what is displayed in-game. Module:Wares/Data must be kept up to date so that the template shows the correct image and text for each item. If a shop has its own specific name for an item, use the display parameter in the extended syntax of {{Wares/Item}} to specify this name.

This template is only to be used for listing items that a shop sells. For items that a shop buys (i.e. Link sells), use Template:Data Table. For an example, see Buyer.

The above documentation is transcluded from Template:Wares/Documentation. (edit | history)
  1. Ohh, I'm currently out of stock, but choice items are in transit! ...Would I lie? — Beedle (Phantom Hourglass)
  2. Ohhh, so sorry. We're sold out of those. You'll have to wait until tomorrow. — Beedle (Spirit Tracks)