Difference between revisions of "Template:ArmorList/doc"
From SpiralKnights
m (save point) |
m (→Required) |
||
| Line 1: | Line 1: | ||
This template is a very compressed way to find and compare gear items via sorting. It utilizes visual icons, sorting cells, tooltips, and show/hide coding in a way that hasn't been seen on the wiki until now, so take careful note of the following documentation, as the template is touchy, sensitive, and requires lots of love! | This template is a very compressed way to find and compare gear items via sorting. It utilizes visual icons, sorting cells, tooltips, and show/hide coding in a way that hasn't been seen on the wiki until now, so take careful note of the following documentation, as the template is touchy, sensitive, and requires lots of love! | ||
| − | ==Required== | + | ==Parameters== |
| + | ===Required=== | ||
'''<nowiki>{{List/Window/NoHeader</nowiki><br/><nowiki> | '''<nowiki>{{List/Window/NoHeader</nowiki><br/><nowiki> | ||
|width=100%</nowiki><br/><nowiki> | |width=100%</nowiki><br/><nowiki> | ||
| Line 24: | Line 25: | ||
</nowiki>''' | </nowiki>''' | ||
| − | :ends the template (yes, for the encompassing background cell that keeps everything in line, the '''}}''' in addition to the '''<nowiki>{{Table/end}}</nowiki>''' is needed. | + | :ends the template (yes, for the encompassing background cell that keeps everything in line, the '''}}''' in addition to the '''<nowiki>{{Table/end}}</nowiki>''' is needed). |
:Editors: Feel free to tidy this part up if you can, I tried, but it's a very sensitive template. Best of luck if you take on this endeavor! | :Editors: Feel free to tidy this part up if you can, I tried, but it's a very sensitive template. Best of luck if you take on this endeavor! | ||
| Line 63: | Line 64: | ||
:a line of text as appropriate | :a line of text as appropriate | ||
;penalty = | ;penalty = | ||
| − | :a line of text as appropriate | + | :a line of text as appropriate |
== Usage == | == Usage == | ||
Revision as of 04:43, 15 December 2014
This template is a very compressed way to find and compare gear items via sorting. It utilizes visual icons, sorting cells, tooltips, and show/hide coding in a way that hasn't been seen on the wiki until now, so take careful note of the following documentation, as the template is touchy, sensitive, and requires lots of love!
Parameters
Required
{{List/Window/NoHeader
|width=100%
|body=
{{ArmorList/start}}
- starts the template
{{ArmorList
| name =
- body segment of template
}}
{{Table/End}}
- ends the template (yes, for the encompassing background cell that keeps everything in line, the }} in addition to the {{Table/end}} is needed).
- Editors: Feel free to tidy this part up if you can, I tried, but it's a very sensitive template. Best of luck if you take on this endeavor!
Optional
The following all have "blank" as an option - in other words, you type in nothing. And I don't mean the word "nothing" haha! Actually nothing. Zip. Nada.
In fact, if the armor doesn't have one of these variables, it's best not to include it at all. You can, but the sheer number of items makes for very long pages, and empty parameters just means more data, even if they are empty. See examples in the usage section below.
To see all options for these parameters, I've made a show/hide list below. In general, you'll be able to see what's available and how to word things based on this template's published presence in other pages, but for the sake of documentation done properly, I've put them here too.
- normal
- a value above 0, but no greater than 9.
- elemental
- a value above 0, but no greater than 9.
- piercing
- a value above 0, but no greater than 9.
- shadow
- a value above 0, but no greater than 9.
- curse=
- a value at or above -4, but no greater than +4.
- fire=
- a value at or above -4, but no greater than +4.
- freeze=
- a value at or above -4, but no greater than +4.
- poison=
- a value at or above -4, but no greater than +4.
- shock=
- a value at or above -4, but no greater than +4.
- sleep=
- a value at or above -4, but no greater than +4.
- stun=
- a value at or above -4, but no greater than +4.
- ability 1 =
- a line of text as appropriate
- ability 2 =
- a line of text as appropriate
- ability 3 =
- a line of text as appropriate
- penalty =
- a line of text as appropriate
Usage
To organize gear into a sortable table so players old and new can find and compare item statistics regarding the following variables:
- Defenses (normal, elemental, piercing, shadow)
- Status Resistances and Weaknesses
- Abilities
- Penalties
Additional information (such as recipe, where to get, and so on) can be found on individual pages of linked-to items.
See "templates used on this page" to modify entries for the following:
General Data Entry
Future
I've tried to design this template to be flexible, because Spiral Knights is a dynamic game that is somewhat like biology - it has rules, and then it breaks its own patterns. And we editors have a fun time dealing with that, don't we! To change variables, use the "replace" function in a simple program such as notepad - like icon size? Just REPLACE 36px with #px, and so on. This can be applied with varying levels of complexity (like with file names, replace "liquifier" with "slime killer" or whatever, just an example) as needed without breaking the numbering system of the template, so long as you don't forget those pesky brackets.
If more numbers than the following are ever seen (So far, the only defense (normal, elemental, piercing, shadow) bar values we see after quantifying via pixel counting are):
00.05
00.07
00.10
00.12
01.07
01.11
01.12
01.14
02.00
02.02
04.00
04.04
04.05
04.06
05.01
05.05
05.07
05.08
06.05
06.13
07.11
08.13
0 should never be entered and remain a blank space.
9 is used as a noteholder about how the stats image might not be fully informative about the item's performance, if the bar is completely full.
I have number values in this template and associated templates in a decimal place-holding system, so editors can add in new values without disrupting an entire numerically ordered column. Sometimes we get new stat bar values, so this flexibility is needed. But having the flexibility actively taking up space in the template all the time is not.
Remember that the class="sortable" type of table puts the least value near the top, unless specified with a <span> function like we've done. I worked with several other editors, namely Icytea, to get this table under control for both new and old player use. If looking at that wad of text in the template doesn't make sense and needs updating, take a gander at Wikipedia's Help Page for Sortable Coding.
If more abilities show up, add them to Template:ListAbilities as well as the GEARTYPEList template - one is a text value translated into an icon (listabilities), the other is a text value translated into a sortable number (gearlist).
