Difference between revisions of "Template:GearList/doc"

From SpiralKnights

Jump to: navigation, search
m (→‎See Also)
m (→‎See Also)
Line 126: Line 126:
 
[http://forums.spiralknights.com/en/node/105837 Forum Node 105837]  contains feedback and other user contributions for this enormous project. Thank you all for your time and effort.
 
[http://forums.spiralknights.com/en/node/105837 Forum Node 105837]  contains feedback and other user contributions for this enormous project. Thank you all for your time and effort.
  
−
{{Showhide|All templates Used in this "Template System"|content=  
+
{{Showhide|All templates Used in this "Gearlist Template System"|content=
−
*[[Template:ShowhideGear|<nowiki>ShowhideGear</nowiki>]]
+
'''Standard Wiki Templates''':
 +
----
 +
:[[Template:SKWindow/NewRow]]
 +
:[[Template:Table/end]]
 +
 
 +
'''Structural Templates (universal in the system)''':
 +
----
 +
These templates are used in every GearList in the system:
 +
:[[Template:ShowhideGear|ShowhideGear]]
 +
 
 +
'''Structural Templates (specific per item type)''':
 +
----
 +
These templates are very structural, but not universally used in every GearList:
 +
:[[Template:ListAbilities|ListAbilities]] - for Armor, Helmet, Shield item lists
 +
 
 +
'''List Templates''':
 +
----
 +
:[[Template:ArmorList]]
 +
::[[Template:ArmorList/start]]
 +
:::[[Template:ListAbilities/Armor]] - uses specific Armor icons
 +
:::[[Template:ListDefense/normal/armor]] - uses specific Armor icons
 +
:::[[Template:ListDefense/elemental/armor]] - uses specific Armor icons
 +
:::[[Template:ListDefense/piercing/armor]] - uses specific Armor icons
 +
:::[[Template:ListDefense/shadow/armor]] - uses specific Armor icons
 +
:::[[Template:ListStatus/Curse/armor]] - uses specific Armor icons
 +
:::[[Template:ListStatus/Fire/armor]] - uses specific Armor icons
 +
:::[[Template:ListStatus/Freeze/armor]] - uses specific Armor icons
 +
:::[[Template:ListStatus/Poison/armor]] - uses specific Armor icons
 +
:::[[Template:ListStatus/Shock/armor]] - uses specific Armor icons
 +
:::[[Template:ListStatus/Sleep/armor]] - uses specific Armor icons
 +
:::[[Template:ListStatus/Stun/armor]] - uses specific Armor icons
 +
::::Editors: I'd love to be able to merge these into two templates: ListDefense and ListStatus for all items, but I can't seem to get the "switch of a switch of a switch" to work correctly. Implementing this merge would be a snap, cause all you'd have to do is edit the relevant Gearlist template's <nowiki>{{{ListDefense|type}}}</nowiki> fields...
 +
'''Associated Templates''':
 +
----
 +
These templates support this template system, but are not directly part of the template system:
 +
:[[Template:Note-GearList]]
 +
:[[Template:Clearleft]]
  
 
}}
 
}}

Revision as of 16:43, 21 December 2014

Usage

To organize combat items for searching, comparison, and general knowledge. This template is part of a large system of templates - so read this documentation carefully before making changes. There is a template for Armor, Helmets, Shields, Trinkets, Bombs, Handguns, and Swords. These are all related to each other with icon symbolism, several #switch templates, and header-sortable table behavior. I consider the total usage (using and editing) difficulty of this "template system" to be in three levels - the first being the easiest, and the last being the "hardest" in that it is "risky" and can "break" the system. But an editor should be able to use this template and change it easily after reading this documentation. I hope. Grab some popcorn and settle in, because it's a big read!



Level 1: Understanding the Templates

The following Note is on every page that uses one of these lists (implemented by placing {{Note-GearList}} in the page code). It explains the general behavior of the template for users who may be unfamiliar with it:

The following logic explanations describe icons, their inspiration, and how they are designed.





Level 2: Populating the Templates

The game has suddenly updated with new armor items, or something. We need to add them to the appropriate list. Here's what the values mean, and where they should go:





Level 3: Updating the Templates with New Values

The game has suddenly updated with new helmet items, or something. They have stat values and intensity levels of abilities that we've never seen before. Here's how to get them into the template smoothly, so they can be sorted in with the older items:





See Also

Forum Node 105837 contains feedback and other user contributions for this enormous project. Thank you all for your time and effort.

Retrieved from "https://wiki.spiralknights.com/index.php?title=Template:GearList/doc&oldid=181861"
Personal tools