Template:Equipment/doc: Difference between revisions

From Dragon Quest Wiki
No edit summary
(updating to match reworked template)
Line 5: Line 5:
===Header===
===Header===
A header call to this template should be the first usage of this template on any page.
A header call to this template should be the first usage of this template on any page.
<pre>{{Equipment|header}}</pre>
<pre>{{Equipment|header|image=Broad_sword.png|name=Broad Sword|console=NES}}</pre>
*header: A required parameter which marks this as the start of a equipment table.
*'''header''': A required parameter which marks this as the start of a equipment table.
*'''console''': An optional parameter for specifying the console version of the game the equipment appears in.
*'''name''': The name of the equipment.  This should be the localization name used in the game in which this piece of equipment appears.
*'''image''': if there is an image of this piece of equipment, it should be included here.  Note this is the filename only, not a link to the image.
===Entry===
===Entry===
An entry call is made to designate equipment data for a specific console.  Note that pieces of equipment that have the exact same attributes across different consoles can be described in the same entry.
An entry call is made to designate equipment data for a specific console.  Note that pieces of equipment that have the exact same attributes across different consoles can be described in the same entry.
<pre>{{Equipment|entry
<pre>{{Equipment|stat|name=Attack|modified=+10}}</pre>
|console=NES,GBC
*'''stat''': A required parameter marking a stat entry.
|name=Copper sword
*'''name''': The name of the stat being modified by the equipment
|statModified=Attack
*'''modifier''': The value (+/-) the stat is being modified.  Should include a + or - in front of the value.
|statModifier=+10
|flavor=A long copper swordnotes=This weapon is cursed}}</pre>
*entry: A required parameter marking an entry.
*console: The console version of the game. This parameter should contain multiple console values separated by commas if the attribute parameters are the same. This is not a required parameter for games which have only one console version.
*name: The name of the piece of equipment.  Note that equipment with different localized names, can be combined if there other parameters are the same.  If this is the case, the most recent localization name should be used, with others following in parentheses (i.e. Steel Sword (Broad Sword)).
*image: if there is an image of this piece of equipment, it should be linked here. This parameter is optional.
*statModified: The stat being modified by the equipment
*statModifier: The value (+/-) the stat is being modified.  Should include a + or - in front of the value.
*sellPrice: The price of the equipment when sold to a shop.
*flavor: If there is specific flavor text used to describe this equipment in the game, it should be quoted here. This paramter is optional.
*notes: Any special notes about this particular piece of equipment (cursed, in-battle effects, etc.) This parameter is optional.
===Footer===
===Footer===
The footer call marks the end of the equipment table.
The footer call marks the end of the equipment table.
<pre>{{Equipment|footer}}</pre>
<pre>{{Equipment|footer|sellPrice=300|flavor=This is some flavor.|notes=These are notes.}}</pre>
*footer: A required parameter marking the template as the footer.
*'''footer''': A required parameter marking the template as the footer.
==Notes on condensing tables==
*'''buyPrice''': The price of the equipment when bought from a shop.  The 'G' for gold is added automatically.
It is common that many pieces of equipment have slight differences in different console versions of a game.  If only the name of the equipment has changed, the console versions may share a common subtable with the name detailed as instructed above. However, if there are changes to the equipment stats or notes parameters, each console version should have a separate subtable. This keeps the table more readable and requires less effort to comprehend.
*'''sellPrice''': The price of the equipment when sold to a shop. The 'G' for gold is added automatically.
*'''flavor''': If there is specific flavor text used to describe this equipment in the game, it should be quoted here. This paramter is optional.
*'''notes''': Any special notes about this particular piece of equipment (cursed, in-battle effects, etc.) This parameter is optional.
==Example==
==Example==
===Sample===
===Sample===
{{Equipment|header}}
{{Equipment|header|name=Giant Hammer|console=GBC}}
{{Equipment|entry
{{Equipment|stat|name=Attack|modifier=+8}}
|console=DS
{{Equipment|stat|name=Agility|modifier=-10}}
|name=Club
{{Equipment|footer|buyPrice=60|sellPrice=30|flavor=A giant hammer with destructive power.|notes=Casts Slow when used in battle.}}
|statModified=Attack
|statModifier=+8
|buyPrice=60g
|sellPrice=30g}}
{{Equipment|entry
|name=Club
|console=SNES
|statModified=Attack
|statModifier=+10
|buyPrice=60g
|sellPrice=30g
|notes=Casts Blaze in battle when used as an item}}
{{Equipment|footer}}
===Code===
===Code===
<pre>
<pre>
{{Equipment|header}}
{{Equipment|header|name=Giant Hammer|console=GBC}}
{{Equipment|entry
{{Equipment|stat|name=Attack|modifier=+8}}
|console=DS
{{Equipment|stat|name=Agility|modifier=-10}}
|name=Club
{{Equipment|footer|buyPrice=60|sellPrice=30|flavor=A giant hammer with destructive power.|notes=Casts Slow when used in battle.}}
|statModified=Attack
|statModifier=+8
|buyPrice=60g
|sellPrice=30g}}
{{Equipment|entry
|name=Club
|console=SNES
|statModified=Attack
|statModifier=+10
|buyPrice=60g
|sellPrice=30g
|notes=Casts Blaze in battle when used as an item}}
{{Equipment|footer}}
</pre>
</pre>

Revision as of 10:09, 28 July 2010

The Equipment template is used to display information for various pieces of equipment in Dragon Quest games. This template covers all types of equipment (weapons, armor, shields, helmets, accessories). This template describes a piece of equipment for a single game.

Usage

In almost all cases, using this template should be preceded by a heading of the game it comes from. This is because the template only covers a single item in a single game. Each game, therefore, should have its own instance of this template.

Header

A header call to this template should be the first usage of this template on any page. 

{{Equipment|header|image=Broad_sword.png|name=Broad Sword|console=NES}}
  • header: A required parameter which marks this as the start of a equipment table.
  • console: An optional parameter for specifying the console version of the game the equipment appears in.
  • name: The name of the equipment. This should be the localization name used in the game in which this piece of equipment appears.
  • image: if there is an image of this piece of equipment, it should be included here. Note this is the filename only, not a link to the image.

Entry

An entry call is made to designate equipment data for a specific console. Note that pieces of equipment that have the exact same attributes across different consoles can be described in the same entry. 

{{Equipment|stat|name=Attack|modified=+10}}
  • stat: A required parameter marking a stat entry.
  • name: The name of the stat being modified by the equipment
  • modifier: The value (+/-) the stat is being modified. Should include a + or - in front of the value.

Footer

The footer call marks the end of the equipment table. 

{{Equipment|footer|sellPrice=300|flavor=This is some flavor.|notes=These are notes.}}
  • footer: A required parameter marking the template as the footer.
  • buyPrice: The price of the equipment when bought from a shop. The 'G' for gold is added automatically.
  • sellPrice: The price of the equipment when sold to a shop. The 'G' for gold is added automatically.
  • flavor: If there is specific flavor text used to describe this equipment in the game, it should be quoted here. This paramter is optional.
  • notes: Any special notes about this particular piece of equipment (cursed, in-battle effects, etc.) This parameter is optional.

Example

Sample

 Giant Hammer  (GBC)
Attack +8
Agility -10
Equipable by
Buy Price 60
Sell Price 30
Flavor text A giant hammer with destructive power.
Notes Casts Slow when used in battle.

Code

{{Equipment|header|name=Giant Hammer|console=GBC}}
{{Equipment|stat|name=Attack|modifier=+8}}
{{Equipment|stat|name=Agility|modifier=-10}}
{{Equipment|footer|buyPrice=60|sellPrice=30|flavor=A giant hammer with destructive power.|notes=Casts Slow when used in battle.}}
Retrieved from "https://dragon-quest.org/w/index.php?title=Template:Equipment/doc&oldid=6283"