Template:GearList/doc

From SpiralKnights

Revision as of 16:26, 21 December 2014 by Novaster (Talk | contribs)

Jump to: navigation, search

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.

Personal tools