Difference between revisions of "Template:ArmorList/doc"

From SpiralKnights

Jump to: navigation, search
m (groundwork)
m (save point)
Line 1: Line 1:
This template is a very compressed way to compare gear items via sorting. Additional information (such as recipe, where to get, and so on) can be found on individual pages of linked-to items.
+
This template is a very compressed way to compare and find 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!
 
+
See "templates used on this page" to modify entries for the following:
+
  
 
==Required==
 
==Required==
Line 26: Line 24:
 
</nowiki>'''
 
</nowiki>'''
  
: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!
+
: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!
  
 
===Optional===
 
===Optional===
<nowiki>
+
;normal
{{ArmorList/start}}</nowiki><br/><nowiki>
+
;elemental
</nowiki><br/><nowiki>
+
;piercing
{{ArmorList</nowiki><br/><nowiki>
+
;shadow
| name = Ancient Plate Mail</nowiki><br/><nowiki>
+
;curse=  
| defense type 1 = normal 9</nowiki><br/><nowiki>
+
;fire=
| defense type 2 =</nowiki><br/><nowiki> 
+
;freeze=  
| curse= </nowiki><br/><nowiki>
+
;poison=
| fire= </nowiki><br/><nowiki>
+
;shock=  
| freeze= </nowiki><br/><nowiki>
+
;sleep=
| poison= </nowiki><br/><nowiki>
+
;stun=  
| shock= </nowiki><br/><nowiki>
+
;ability 1 =  
| sleep= Decreased Sleep Resistance: 4</nowiki><br/><nowiki>
+
;ability 2 =</nowiki><br/><nowiki>  
| stun= Increased Stun Resistance: 4</nowiki><br/><nowiki>
+
;ability 3
| ability 1 = Health Bonus: +3</nowiki><br/><nowiki>
+
;penalty = Attack Speed Decreased: Low and Movement Speed Decreased: Low</nowiki><br/><nowiki>
| ability 2 =</nowiki><br/><nowiki>  
+
| penalty = Attack Speed Decreased: Low and Movement Speed Decreased: Low</nowiki><br/><nowiki>
+
 
| star = 5</nowiki><br/><nowiki>
 
| star = 5</nowiki><br/><nowiki>
 
}}</nowiki><br/><nowiki>
 
}}</nowiki><br/><nowiki>
 
</nowiki><br/><nowiki>
 
</nowiki><br/><nowiki>
 
{{Table/End}}</nowiki><br/><nowiki>
 
{{Table/End}}</nowiki><br/><nowiki>
</nowiki><br/><nowiki>
+
</nowiki><br/>
 
+
  
 
== Usage ==
 
== 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:
 +
<br/>
 +
<br/>
 +
00.05<br/>
 +
00.07<br/>
 +
00.10<br/>
 +
00.12<br/><br/>
 +
01.07<br/>
 +
01.11<br/>
 +
01.12<br/>
 +
01.14<br/><br/>
 +
02.00<br/>
 +
02.02<br/><br/>
 +
04.00<br/>
 +
04.04<br/>
 +
04.05<br/>
 +
04.06<br/><br/>
 +
05.01<br/>
 +
05.05<br/>
 +
05.07<br/>
 +
05.08<br/><br/>
 +
06.05<br/>
 +
06.13<br/><br/>
 +
07.11<br/><br/>
 +
08.13<br/><br/>
 +
0 should never be entered and remain a blank space, though I have put in coding to take care of that, it's unneeded labor. Let's have 0 labor for 0.
 +
<br/><br/>
 +
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.
 +
<br/><br/>
 +
 +
I have these 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 <nowiki><span></nowiki> 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 [http://en.wikipedia.org/wiki/Help:Sorting Wikipedia's Help Page for Sortable Coding].

Revision as of 04:31, 15 December 2014

This template is a very compressed way to compare and find 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

{{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

normal
elemental
piercing
shadow
curse=
fire=
freeze=
poison=
shock=
sleep=
stun=
ability 1 =
ability 2 =</nowiki>
;ability 3 ;penalty = Attack Speed Decreased: Low and Movement Speed Decreased: Low
| star = 5
}}

{{Table/End}}

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, though I have put in coding to take care of that, it's unneeded labor. Let's have 0 labor for 0.

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 these 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.

Personal tools