View source for Template:ClassSpellTable/doc

= Documentation =
Welcome to the Smart Spell Table Templates.
These templates consist of the following pages:
* [[Template:ClassSpellTable]] (this page)
** [[Template:Spellpagesmart]]
*** [[Template:ClassSpellTableRow]]
*** [[Template:spellpage]]
** [[Template:SpellSlotRowSmart]]
*** [[Template:SpellSlotRow]]

These sets of templates have been designed for two purposes
# Make the spell tables look pretty
# Remove duplication of data between Class Pages and spell pages
'''Outstanding Tasks'''
# Fix the last "Mana" cell from top-alignment... Many things have been tried, for some reason the data is  being put before the <p></p> not inside it. don't know why!
# Reduce number of template calls to reduce load on server
# Add flag to SpellSlotRowSmart to "hide" line from the Main Page, which usually duplicate information for the table view

== Usage ==
ClassSpellTable is used to embed the spells/songs - this creates a table with the correct Column headings.
Each Spell/Song is then included in the table - all of these require Table=(1|2|3) to tell it which table to use (Spell/SpellNew/Song). Because the same spell can be used on different classes, each having a different level when it is achieved, the level for that spell is passed in during the include into the table. '''NB: parameters are case sensitive'''
<pre>
{{ClassSpellTable| Table = 3 |
{{:Chant of Battle | TableLevel = 1 | Table = 3 }}
{{:Chords of Dissonance | TableLevel = 2 | Table = 3 }}
{{:Jaxan's Jig o' Vigor | TableLevel = 3 | Table = 3 }}
{{:Lyssa's Locating Lyric | TableLevel = 4 | Table = 3 }}
{{:Selo's Accelerando | TableLevel = 5 | Table = 3 }}
{{:Hymn of Restoration | TableLevel = 6 | Table = 3 }}
{{:Jonthan's Whistling Warsong | TableLevel = 7 | Table = 3 }}
{{:Kelin's Lugubrious Lament | TableLevel = 8 | Table = 3 }}
{{:Elemental Rhythms | TableLevel = 9 | Table = 3 }}
{{:Anthem De Arms | TableLevel = 10 | Table = 3 }}
}}
</pre>

Differences between TableTypes
*Spell/SpellNew/Song
*Class/Class/Instrument
*Type/TableType/Type
*Mana/Mana/Empty

== Migration ==
Before Spells/Songs can be put into a table they first need to be changed from using the Spellpage template to using to Spellpagesmart template.
To do this follow the process below.<br/>
* 1. Edit the spell page<br/>
* 2. Put the following text in the Summary box "Upgrading to Spellpagesmart"<br/>
* 3. Check the "This is a minor edit" box<br/>
* 4.1 Replace Spellpage with  Spellpagesmart
* 4.2 make sure that all tags above Spellpage are put inside noinclude tags eg.<pre><noinclude>{{Velious Era}}</noinclude></pre>
* 5.1 After description = "some long text goes here describing the spell" put in the following text: this passes through Table and TableLevel parameters from the include in the table through to the template. '''NB: parameters are case sensitive'''<pre>| Table = {{{Table|0}}}</pre>
* 5.2 After the newly added Table parameter, add in <pre>| TableLevel = {{{TableLevel|}}}</pre>
* 6.1 For each SpellSlotRow, change the template to SpellSlotRowSmart and add the following code to the end (before the final }} brackets) <pre>| simple = {{#ifeq:{{{Table|0}}}|0|0|1}}</pre>
* 6.2 The finished SpellSlotRowSmart should look like the following <pre>{{SpellSlotRowSmart | 2 | Decrease Hitpoints by 1 @L1 to 3 @L4 per tick | simple = {{#ifeq:{{{Table|0}}}|0|0|1}} }}</pre>
* 7.1 Add in extra SpellSlotRowSmart records for abnormalities (eg: "Requires: [[Fire Beetle Eye]]" or "Requires: 800 Mana" for bard songs)
* 7.2 To hide duplicate information you can add <code>| HideFromMainPage = 1</code> to the end of <code>SpellSlotRowSmart</code> to hide it on the main page but show it on the table.
* 8. For the SpellsNew template Table = 2 (NB:this is used for Necromances; the new data can be obtained from the old table): add in <pre>| target_table = _____</pre> after <pre>| target_type = _____</pre>
* 9. After the where_to_obtain table, add the following, adding in br tags to create new lines - please try to keep Locations to fit on to 3 or 4 lines max - do not put in duplications present in where_to_obtain.<pre>| TableLocations = Ak'Anon/Freeport<br/>Neriak/Paineel<br/>Qeynos/Cabilis</pre>
* 10.1 Add in Era after TableLocations, defaulted to it's original implementation, with an override for classes which had the spell added in later expansions. <pre>| TableEra = {{{TableEra|Classic}}}</pre>
* 11. Press "Save Page" button
* 12. Verify you have not broken the main page
* 13. Include the spell/song on in a table on a test area page to make sure it works properly.
* 14. Put spell/song in the main table
* 14.1 If there are spells that were classic, but later added to a class in velious then add the following to the spell in the ClassSpellTable <pre>| TableEra = Velious</pre>

== Examples ==
All the bard songs have been completed
===Songs (Bard) - Table Type 3 ===
{{ClassSpellTable| Table = 3 |
{{:Chant of Battle | TableLevel = 1 | Table = 3 }}
{{:Chords of Dissonance | TableLevel = 2 | Table = 3 }}
{{:Jaxan's Jig o' Vigor | TableLevel = 3 | Table = 3 }}
}}
===Spells (Druid) - Table Type 1 ===
{{ClassSpellTable| Table = 1 |
{{:Flame Lick | TableLevel = 1 | Table = 1 }}
}}
===Spells (Ranger) - Table Type 1 ===
{{ClassSpellTable| Table = 1 |
{{:Flame Lick | TableLevel = 9 | Table = 1 }}
}}
===Spells (Necro) - Table Type 2 ===
The necro "Type" field is pulled out of a "special" type field that was added into the main spell table.
This "special" type field will be added into all the necromancer spells as a custom field and pulled into the table template instead of the standard type data; but only for the necromancer spell listing.
For the example below the type data would normally come from "|target_type = Self" but instead comes from "|target_table = Summon" which was added specially to the spell data.
{{ClassSpellTable| Table = 2 |
{{:Cavorting Bones | TableLevel = 1 | Table = 2 }}
}}
----