Template:Wares/Documentation

Purpose
Lists items sold by Merchants and Shops.

Name
By default, an item's displayed name is automatically generated based on the,  , and   parameters. This is done to accurately reflect the in-game presentation of the item. For example, store menus present 10 Arrows as , whereas  displays. Template:Term or Template:Plural is applied to the  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  parameter. 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 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  parameter.

If the  parameter contains a link (e.g.  ), then the wikitext in that parameter is displayed as-is. No image is shown for that item unless the  parameter is used.

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

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

A  parameter also exists and can be set to   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.

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  parameter to specify this name.

When a shop sells items at alternative prices and each price has its own description, do not use the "Multiple Prices" syntax. Instead, enter each price as a separate item and use the  parameter to create tabs for each price. For an example, see Beedle's Airshop.

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.