Guild Wars 2 Wiki:Item formatting

From Guild Wars 2 Wiki
Jump to: navigation, 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 =       
| id =          
| requires =     
| status =      
}}

Other templates[edit]

The following templates are also commonly used on item articles:

  • {{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.
  • {{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.
  • {{Recipe}} — Used to document the recipe that creates this item.
  • {{Vendor list}} — Automatically lists all vendors that sell the item. 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 = 
| id = 
| requires = 
}}
<!-- lead in descriptive text, unnecessary if the item has a description -->

<!-- acquisition should be listed for most, if not all items -->
== Acquisition ==
<!-- If more than one acquisition source, use level 3 headers to split acquisition by methods, the order is as follows -->

=== Gathered from ===
<!-- for items that can either be gathered from resource nodes, or are found in chests and such -->
{{gathered from}}

=== Dropped by ===
<!-- for items that are dropped by enemies -->
{{dropped by}}

=== Sold by ===
<!-- for items that are sold by NPCs -->
{{vendor list}}

=== Contained in ===
<!-- for items that are found in containers -->
{{contained in}}

=== Salvaged from ===
<!-- for items that are obtained from salvaging -->
{{salvaged from}}

=== Reward tracks ===
<!-- for items that are obtained through PvP/WvW reward tracks; always use plural -->
{{contained in reward track}}

=== Recipe(s) ===
<!-- for items that can be crafted; use singular if it's only one recipe, and plural if there is more than one -->
{{recipe
| source = 
| sheet = 
| type = 
| rating = 
| disciplines = 
| ingredient1 = 
| ingredient2 = 
| ingredient3 = 
| ingredient4 = 
| id = 
}}

=== Achievements ===
<!-- for items that can be acquired through achievements; always use plural for these sections -->
{{achievement list|reward={{subst:PAGENAME}}}}

=== Rewarded by ===
<!-- for items that are rewarded by content such as story rewards, level rewards, event reward, etc -->

=== Other ===
<!-- anything that doesn't fit the acquisition methods listed above, such as items obtained by talking to NPCs -->
* <text>

=== Skills ===
<!-- for things like tonics and bundles -->
== Skills ==
{| {{STDT|item}}
{{Environmental skill table header}}
{{Environmental skill table row|<skill name>}}
|}

== Contents ==
<!-- for containers, use asteriks followed by the contains template -->
* Choose one of the following: <!-- only if the container allows player a selection, remove if not -->
** {{contains|item}}

== Heart involvement ==
<!-- for items that are collected and used in renown heart tasks -->
: {{heart|heart name}}

== Event involvement ==
<!-- for items that are used in events -->
: {{event|event name}}

== Used in ==
<!-- for items that are used in crafting, guild upgrades or as a currency for vendors -->
{{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 -->

=== Guild upgrades ===
<!-- for items that are used in guild upgrades -->
{{guild upgrade list}}

== Vendors ==
<!-- for items that are used as a currency for vendors -->
{{vendor table|currency={{subst:PAGENAME}}}}

== Salvage results ==
<!-- for salvage items, uses the {{salvage into}} template -->
* {{salvages into|item}}

== Notes ==
<!-- optional; always plural -->

== Trivia ==
<!-- optional; always plural -->

== See also ==
<!-- 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 -->
* {{item icon|item}}