Template:Spell/doc: Difference between revisions

2,075 bytes removed ,  14:40, 28 July 2010
updated to align with rework
mNo edit summary
(updated to align with rework)
Line 1: Line 1:
The Spell template is used to display information for spells in Dragon Quest games. This template describes a single spell for a '''single game'''.  
The Spell template is used to display information for spells in Dragon Quest games. This template describes a '''single spell''' for a '''single game version'''.  


==Usage==
==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 spell in a single game.  Each game, therefore, should have its own instance of this template.
<pre>{{Spell
===Header===
|console=NES
A header call to this template should be the first usage of this template on any page.
<pre>{{Spell|header}}</pre>
*header: A required parameter which marks this as the start of an spell table.
===Entry===
An entry call is made to designate spell data for a specific console.  Note that spells that have the exact same attributes across different consoles can be described in the same entry.
<pre>{{Spell|entry
|console=NES,GBC
|name=Whack
|name=Whack
|flavor=Instantly kills a group of enemies
|flavor=Instantly kills a group of enemies
Line 16: Line 9:
|mp=8
|mp=8
|notes=This spell is only learned late in the game}}</pre>
|notes=This spell is only learned late in the game}}</pre>
*entry: A required parameter marking an entry.
*'''console''': The console version of the game.  
*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 spell.   
*name: The name of the spell.  Note that spells 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. Sizz (Blaze)).
*'''image''': if there is an image of this item, it should be referenced here. This parameter is optional. Note this should be just the filename, not a link.
*image: if there is an image of this item, it should be linked here. This parameter is optional.
*'''mp''': The mp cost to cast the spell
*mp: The mp cost to cast the spell
*'''flavor''': If there is specific flavor text used to describe this spell in the game, it should be quoted here. This paramter is optional.
*flavor: If there is specific flavor text used to describe this spell in the game, it should be quoted here. This paramter is optional.
*'''effect''': A general description of what the spell does.
*effect: A general description of what the spell does.
*'''notes''': Any special notes about this particular spell This parameter is optional.
*notes: Any special notes about this particular spell This parameter is optional.
===Footer===
The footer call marks the end of the spell table.
<pre>{{Spell|footer}}</pre>
*footer: A required parameter marking the template as the footer.
==Notes on condensing tables==
It is common that many spells have slight differences in different console versions of a game.  If only the name of the spell has changed, the console versions may share a common subtable with the name detailed as instructed above.  However, if there are changes to other aspects of the spell, each console version should have a separate subtable.  This keeps the table more readable and requires less effort to comprehend.
==Example==
==Example==
===Sample===
===Sample===
{{Spell|header}}
{{Spell
{{Spell|entry
|console=DS
|console=DS
|name=Sizz
|name=Sizz
Line 39: Line 24:
|flavor=Throws a fireball at the enemy
|flavor=Throws a fireball at the enemy
|effect=Causes 10-20 points of fire damage to a single enemy
|effect=Causes 10-20 points of fire damage to a single enemy
|notes=This spell is dumb}}
|note=This spell is dumb}}
{{Spell|entry
|name=Sizz
|console=SNES
|mp=4
|flavor=A large fireball engulfs the enemy
|effect=Causes 10-15 points of fire damage to a single enemy
|notes=A pretty cool spell}}
{{Spell|footer}}
===Code===
===Code===
<pre>
<pre>
{{Spell|header}}
{{Spell
{{Spell|entry
|console=DS
|console=DS
|name=Sizz
|name=Sizz
Line 57: Line 33:
|flavor=Throws a fireball at the enemy
|flavor=Throws a fireball at the enemy
|effect=Causes 10-20 points of fire damage to a single enemy
|effect=Causes 10-20 points of fire damage to a single enemy
|notes=This spell is dumb}}
|note=This spell is dumb}}
{{Spell|entry
|name=Sizz
|console=SNES
|mp=4
|flavor=A large fireball engulfs the enemy
|effect=Causes 10-15 points of fire damage to a single enemy
|notes=A pretty cool spell}}
{{Spell|footer}}
</pre>
</pre>