Gswiki:Style guide/Spells: Difference between revisions

The official GemStone IV encyclopedia.
< Gswiki:Style guide
Jump to navigation Jump to search
No edit summary
(Made some minor corrections and removed the instances where the name and number of the spells are instanced within the template, as with using {{PAGENAME}} it isn't necessary.)
Line 4: Line 4:
* 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 sub-section named '''Factors that affect <spell name>''' 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 confered. This section is expected in defense and utility spell articles.
* a '''Using <spell name>''' section, describing how the spell is used and the mechanics underlying its effects. This spell 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.


== The Spell Template ==
== The Spell Template ==
Line 11: Line 11:
For example, this would be the spell template for [[Minor Shock (901)]]:
For example, this would be the spell template for [[Minor Shock (901)]]:


<nowiki>{{spell | name = Minor Shock | number = 901 | mnemonic = MINORSHOCK | duration = Instantaneous | type = Attack ([[bolt]]) }}</nowiki>
<nowiki>{{spell | mnemonic = MINORSHOCK | duration = Instantaneous | type = Attack ([[bolt]]) }}</nowiki>


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


{| style="margin-left: 20px; margin-bottom: 5px;"
{| style="width: 23em; margin: 10px 0 10px 10px; clear:both;"
|-
|-
|
|
{| style="width: 100%; font-size: 95%; text-align: left; background: #FFF; margin: 0 0 0 0; border: 1px #aaa solid;"
{| {{prettytable}}
|+ style="white-space: nowrap; font-size: larger; text-align: left;" | '''Minor Shock (901)'''
! colspan=2 style="background:#DDD; font-size: larger; text-align: center;" | '''Minor Shock (901)'''
|-
|-
! Mnemonic
|
{| style="width: 23em; font-size: 95%; text-align: left;"
| valign="top" style="white-space: nowrap; text-align: right;" | [MINORSHOCK]
|-
|-
! Duration
! Mnemonic
| valign="top" style="white-space: nowrap;" | [MINORSHOCK]
| valign="top" style="white-space: nowrap; text-align: right;" | Instantaneous
|-
|-
! Type
! Duration
| valign="top" style="white-space: nowrap;" | Instantaneous
| valign="top" style="white-space: nowrap; text-align: right;" | Attack ([[bolt]])
|-
|}
! Type
| valign="top" style="white-space: nowrap;" | Attack ([[bolt]])
|-
|}
|}
|}
|}


Line 41: Line 36:
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:
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:


<nowiki>
<nowiki>{{spell
| mnemonic = MSUMMON
{{spell |
| base_dur = 600 sec
| name = Minor Summoning
| add_dur = +20 sec per [[Sorcerer Base|rank]] <br>+30 sec per [[Sorcerous Lore, Demonology|Demonology]] rank
| number = 725
| span = [[Refreshable]]
| mnemonic = MSUMMON
| type = Utility
| duration = 600 sec + 20 sec per [[Sorcerer Base]] spell ranks + 30 sec per [[Sorcerous Lore, Demonology]] rank
}}</nowiki>
| type = Utility }}
</nowiki>


* Name should be in capital case, as all spell names are proper nouns.
* Number is the spell's number.
* Mnemonic should be typed in all capital letters.
* Mnemonic should be typed in all capital letters.
* Duration should be one of the following: ''instantaneous'', ''permenant'', ''special'' or the duration formula.
* 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)
** Time units should be abbreviated as follows: ''sec'' (seconds), ''min'' (minutes), ''hr'' (hours)
* Type should be a combination of any of the following as appropriate: ''attack'', ''defense'' or ''utility''.
* Type should be any of the following, as appropriate: ''attack'', ''defense'', ''offense'', or ''utility''.
** Attack type should include an internally linked sub-type in parentheses. The list of sub-types includes but is not limited to: ''[[bolt]]'', ''[[warding]]'' and ''[[maneuver]]''.
** 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]]'''.

Revision as of 17:20, 13 January 2007

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 sub-section named Factors that affect <spell name> 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.
  • 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.

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.