Guild Wars 2 Wiki:Item formatting
From Guild Wars 2 Wiki
Jump to navigationJump to search
This article will explain the formatting practices and processes with regards to the documentation of items. While this article will go fairly in-depth, you are not expected to conform to every rule. These are merely recommended guidelines, and you are encouraged to cherry-pick. More experienced editors will come along to fill in the blanks or clean up any mistakes you make.
Copy-paste layouts for various types of item pages can be found at the bottom of this article; use the table of contents on the right to skip directly to them.
Item infobox[edit]
- Primary article: Template:Item infobox
Items are described using the {{Item infobox}}. Basic parameters are outlined below; please refer to the template for a more detailed guide.
{{Item infobox
| name = <!-- Optional. Use if article name differs from the name of the item. Defaults to {{PAGENAME}}. -->
| icon = <!-- Optional. Use if the map icon of the object differs from the name of the item. Defaults to {{PAGENAME}}.png -->
| description = <!-- Description of the item, copied verbatim from the game, including errors. -->
| hint =
| type =
| rarity =
| value =
| bound =
| salvage = <!-- Optional. Use if the item can be salvaged. Possible parameters: standard, research, ascended, compost-->
| id =
| requires =
| status =
}}
Other templates[edit]
The following templates are also commonly used on item articles:
- {{Achievement list}} — Generates a list of achievements, for the items use the 'reward' parameter. This information comes from {{Achievement table row}} used on achievement category pages.
- {{Contained in}} — Automatically lists all container items that drop the item. This information comes from other item articles that have used the {{Contains}} template.
- {{Contained in reward track}} — Automatically lists all reward tracks (together with the number and the quantity) that drop the item. This information is gathered with the {{Reward Track}} template.
- {{Contains}} — Used to document items received upon double-clicking the container item. Will cause other articles using the {{Contained in}} template to automatically update.
- {{Dropped by}} — Automatically lists all foes that drop the item. This information comes from NPC articles that have used the {{Drops table row}} template.
- {{Gathered from}} — Automatically lists all objects that the item may be gathered from. This information comes from object articles that have used the {{Gather}} template.
- {{Recipe}} — Used to document the recipe that creates this item.
- {{Rewarded by}} — Automatically lists all adventures, events, stories and strike missions that reward the item. This information comes from other item articles that have used the {{Rewards item}} template or in the case of adventures it's automatically set by the template {{adventure rewards}} itself.
- {{Rewards item}} — Used to document items received upon completeing an event, story or strike mission. Will cause other articles using the {{Rewarded by}} template to automatically update.
- {{Salvaged from}} — Automatically lists all salvage items that salvage into this item. This information comes from other item articles that have used the {{Salvages into}} template.
- {{Salvages into}} — Used to document items received upon salvaging the item. Will cause other articles using the {{Salvaged from}} template to automatically update.
- {{Sold by}} — Automatically lists all vendors that sell the item. This information comes from vendor articles that have used the {{Vendor table row}} template.
- {{Teaches recipe}} — Automatically lists all recipes that are taught by the recipe sheet. This information comes from item articles that have used the {{Recipe}} template.
- {{Vendor query table}} — Generates tables for vendors that accept this currency or token. This information comes from vendor articles that have used the {{Vendor table row}} template.
Copy-paste layouts[edit]
These are suggested layouts for various types of item pages, based on current conventions. Editors should feel free to alter them as they see fit.
If you're unsure about how to include certain sections, it's okay to leave them out or put {{Section-stub|item}} in place of any text. Documenting on the wiki is an iterative process; we don't expect the first versions to be perfect nor complete.
General[edit]
{{Item infobox
| name =
| icon =
| description =
| hint =
| type =
| rarity =
| value =
| bound =
| salvage =
| id =
| requires =
}}
<!-- lead-in descriptive text, unnecessary if the item has a description -->
<text>
<!-- If more than one acquisition source, use level 3 headers to split acquisition by methods, the order is as follows -->
== Acquisition ==
<!-- for items that can either be gathered from resource nodes, or are found in chests and such -->
=== Gathered from ===
{{Gathered from}}
<!-- for items that are dropped by enemies -->
=== Dropped by ===
{{Dropped by}}
<!-- for items that are sold by NPCs -->
=== Sold by ===
{{Sold by}}
<!-- for items that are found in containers -->
=== Contained in ===
{{Contained in}}
<!-- for items that are obtained from salvaging -->
=== Salvaged from ===
{{Salvaged from}}
<!-- for items that are obtained through PvP/WvW reward tracks; always use plural -->
=== Reward tracks ===
{{Contained in reward track}}
<!-- for items that can be crafted; use singular if it's only one recipe, and plural if there is more than one -->
=== Recipe(s) ===
{{Recipe
| source =
| sheet =
| type =
| rating =
| disciplines =
| ingredient1 =
| ingredient2 =
| ingredient3 =
| ingredient4 =
| id =
}}
<!-- for items that can be acquired through achievements; always use plural for these sections -->
=== Achievements ===
{{Achievement list|reward={{subst:pagename subst}}}}
<!-- for items that are rewarded by content such as story rewards, level rewards, event reward, etc -->
=== Rewarded by ===
{{Rewarded by}}
<!-- for upgrade components that can be extracted via the Black Lion Salvage Kits or Upgrade Extractors -->
=== Extracted from ===
{{contains upgrade component}}
<!-- anything that doesn't fit the acquisition methods listed above, such as items obtained by talking to NPCs -->
=== Other ===
* <text>
<!-- for named exotic weapons -->
{{exotic weapon text}}
<!-- for things like tonics and bundles -->
== Skills ==
{| {{STDT|item}}
{{Environmental skill table header}}
{{Environmental skill table row|<skill name>}}
|}
<!-- for containers, use asteriks followed by the contains template -->
== Contents ==
* Choose one of the following: <!-- only if the container allows player a selection, remove if not -->
** {{Contains|item}}
<!-- for items that are collected and used in renown heart tasks -->
== Heart involvement ==
: {{Heart|heart name}}
<!-- for items that are used in events -->
== Event involvement ==
: {{Event|event name}}
<!-- for items that are used in crafting, guild upgrades or as a currency for vendors -->
== Used in ==
{{Recipe list}} <!-- use when the item is only used in one discipline or source e.g. Mystic Forge or artificer -->
{{Recipe list by discipline}} <!-- used when the item is used in more than one discipline or source; automatically creates level 3 headers -->
<!-- for items that are used in guild upgrades -->
=== Guild upgrades ===
{{Guild upgrade list}}
<!-- for items that are used as a currency for other goods -->
== Currency for ==
<!-- if necessary use the parameter "outline = vendor" to group into vendor subsections -->
{{Vendor query table|currency={{subst:pagename subst}}}}
<!-- for salvage items, uses the {{Salvage into}} template -->
== Salvage results ==
* {{Salvages into|item}}
<!-- for recipe sheets; use singular if only one recipe is taught, and plural if there is more than one -->
== Teaches recipe(s) ==
{{Teaches recipe}}
<!-- only used for items not directly in a collection -->
== Related achievements ==
* {{achievement|<achievement name>}}
<!-- optional; always plural -->
== Notes ==
* <text>
<!-- optional; always plural -->
== Trivia ==
* <text>
<!-- optional; 'also' is always lowercase, list anything related to the item. Use {{Item icon}} when linking to other items, and a plain bullet point otherwise -->
== See also ==
* {{Item icon|item}}
* [[page]]
Gem Store items[edit]
For the gallery section use Widget:Gem Store catalogue for icon and banner images. Promo screenshot usually comes from the official blogpost or video.
{{Item infobox
| name =
| icon =
| description =
| hint =
| type =
| mount type = <!-- only for mount skins -->
| mount name = <!-- only for mount skins -->
| mount theme = <!-- only for mount skins -->
| mount-id = <!-- only for mount skins -->
| rarity =
| value =
| bound =
| id =
| requires =
}}
<!-- lead-in descriptive text, unnecessary if the item has a description -->
<text>
<!-- If more than one acquisition source, use level 3 headers to split acquisition by methods, the order is as follows -->
== Acquisition ==
<!-- for items that are sold by NPCs -->
=== Sold by ===
{{Sold by}}
<!-- for items that are found in containers -->
=== Contained in ===
{{Contained in}}
<!-- for items that can be acquired through achievements; always use plural for these sections -->
=== Achievements ===
{{Achievement list|reward={{subst:pagename subst}}}}
<!-- for items that are rewarded by content such as story rewards, level rewards, event reward, etc -->
=== Rewarded by ===
{{Rewarded by}}
<!-- anything that doesn't fit the acquisition methods listed above, such as items obtained by talking to NPCs -->
=== Other ===
* <text>
<!-- for containers, use asteriks followed by the contains template -->
== Contents ==
* Choose one of the following: <!-- only if the container allows player a selection, remove if not -->
** {{Contains|item}}
<!-- Icon and banner can be found on the Widget:Gem Store catalogue wiki page. Promo screenshot usually comes from official blogpost or video. -->
== Gallery ==
<gallery>
<Item Name> icon.png|Gem Store icon.
<Item Name> banner.jpg|Gem Store banner.
<Item Name> promo.jpg|Promo screenshot.
</gallery>
<!-- only used for items not directly in a collection -->
== Related achievements ==
* {{achievement|<achievement name>}}
<!-- optional; always plural -->
== Notes ==
* <text>
<!-- optional; always plural -->
== Trivia ==
* <text>
<!-- Add known Gem Store history of availability -->
== Gem Store history ==
{{Gem Store history table header}}
{{Gem Store history table row|2023-12-26|2024-01-30}}
* New
|}
<!-- optional; 'also' is always lowercase, list anything related to the item. Use {{Item icon}} when linking to other items, and a plain bullet point otherwise -->
== See also ==
* {{Item icon|item}}
* [[page]]
