Gswiki:Style guide/Spells: Difference between revisions

The official GemStone IV encyclopedia.
< Gswiki:Style guide
Jump to navigation Jump to search
m (3 revisions: Krakiipedia Import)
(Updated to include the common Messaging section.)
Line 1: Line 1:
All spell entries are required to include a spell template inclusion at the top of the article. Additionally, all spell entries should include one or more the following:
All spell entries are required to include a spell template inclusion at the top of the article. Additionally, all spell entries should include one or more the following:


* a blurb about the spell, describing its visual effects in simple english.
* a blurb about the spell, describing its visual effects in simple English.
* a sub-section named '''Factors that affect <spell name>''' listing what skills, lores, attributes, etc. factor into and in what manner they do so.
* a '''Factors that affect <spell name>''' section listing what skills, lores, attributes, etc. factor into and in what manner they do so.
* an '''Effects''' section describing the mechanical effects of the spell, such as bonuses confered. This section is expected in defense and utility spell articles.
* an '''Effects''' section describing the mechanical effects of the spell, such as bonuses conferred, if they are not fully described in the blurb.
* a '''Using <spell name>''' section, describing how the spell is used and the mechanics underlying its effects. This section is expected in attack and utility spell articles.
* a '''Using <spell name>''' section describing how the spell is used and the mechanics underlying its effects. This section is expected in attack and utility spell articles.
* a '''Messaging''' section showing the in-game text when the spell is cast and when its effect expires (if applicable).


== The Spell Template ==
== The Spell Template ==

Revision as of 14:51, 30 September 2015

All spell entries are required to include a spell template inclusion at the top of the article. Additionally, all spell entries should include one or more the following:

  • a blurb about the spell, describing its visual effects in simple English.
  • a Factors that affect <spell name> section listing what skills, lores, attributes, etc. factor into and in what manner they do so.
  • an Effects section describing the mechanical effects of the spell, such as bonuses conferred, if they are not fully described in the blurb.
  • a Using <spell name> section describing how the spell is used and the mechanics underlying its effects. This section is expected in attack and utility spell articles.
  • a Messaging section showing the in-game text when the spell is cast and when its effect expires (if applicable).

The Spell Template

Each spell entry should begin with a spell template inclusion.

For example, this would be the spell template for Minor Shock (901):

{{spell | mnemonic = MINORSHOCK | duration = Instantaneous | type = Attack ([[bolt]]) }}

Which results in the following table being added to the article page:

Minor Shock (901)
Mnemonic [MINORSHOCK]
Duration Instantaneous
Type Attack (bolt)

This table will float along the right-hand side of the article, and article content will attempt to flow around it as best as possible. Please keep this in mind when writing articles and preview articles before saving to make sure the table flows well with the rest of the article's content.

The template inclusion should be kept as a single line as illustrated above, unless the spell has a particularily long or complex duration, in which case an inclusion in the following form is prefered:

{{spell
  | mnemonic = MSUMMON
  | base_dur = 600 sec 
  | add_dur = +20 sec per [[Sorcerer Base|rank]] <br>+30 sec per [[Sorcerous Lore, Demonology|Demonology]] rank
  | span = [[Refreshable]]
  | type = Utility
 }}
  • Mnemonic should be typed in all capital letters.
  • Duration should be one of the following: instantaneous, permenant, special or the duration formula.
    • Time units should be abbreviated as follows: sec (seconds), min (minutes), hr (hours)
  • Type should be any of the following, as appropriate: attack, defense, offense, or utility.
    • Attack type should include an internally linked sub-type. The list of sub-types includes but is not limited to: bolt, warding and maneuver.

Advanced Functions

The spell template has many, many more functions than those listed here. For more information, see Template:Spell.