Difference between revisions of "Template:WeaponInfo/doc"

From SpiralKnights

Jump to: navigation, search
m (Add promotional item code)
m (→‎Notes)
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
<noinclude>{{documentation subpage}}</noinclude>
+
==Usage==
−
Use this template to display quick stats of a weapon on its page.
+
This places an infobox about the weapon on the upper right corner of an article.  
  
−
== Usage ==
+
It also places the weapon in relevant categories, some of which are "special" categories that use numeric organization.
−
Example:
+
 
 +
It uses a few other templates to get the job done. Full documentation for individual templates used can be found by entering this template's code into the edit field of the page you wish to update, clicking "preview," and navigating through "templates used on this page" below the edit field box.
 +
 
 +
==Code==
 
<pre>
 
<pre>
 
{{WeaponInfo
 
{{WeaponInfo
−
| name = {{PAGENAME}}
+
| name     = {{PAGENAME}}  
−
| type = bomb, handgun, or sword
+
| type     =  
−
| star = Number 0-5
+
| star     =
−
| abilities = Abilities
+
| damage 1  =
 +
| damage 2  =  
 +
| abilities =  
 +
| status    =
 +
| set      =
 
}}
 
}}
 
</pre>
 
</pre>
  
−
Optional variables:
+
==Parameters==
 +
===Required===
 +
;name
 +
:The confirmed name of the item as seen in-game. '''<nowiki>{{PAGENAME}}</nowiki>''' should be used for easier copypasting and reduction of mistakes, unless there are disambiguation issues.
  
−
<pre>
+
;type
−
| promotional = yes (optional)
+
:either bomb, handgun, or sword. We are using lowercase because I forgot about '''<nowiki>{{lcfirst:}}</nowiki>'''.
−
</pre>
+
  
−
Optional image fixing variables:
+
;star
 +
:either 0, 1, 2, 3, 4, or 5.
 +
 
 +
;damage 1
 +
:either Normal, Elemental, Piercing, or Shadow. Please use uppercase. Automatically places item in a relevant category.
 +
 
 +
===Optional===
 +
;damage 2
 +
:no input: no change
 +
:Use only if the item has two offensive damage types. "damage 1" is usually "normal" if there are two damage types - several swords are like this. Either Elemental, Piercing, or Shadow. Please use uppercase. Automatically places item in a relevant category.
 +
 
 +
;abilities
 +
:no input: defaults to "this item doesn't have any special abilities."
 +
:just enter "yes" If the item has any [[abilities]] at all. This makes the template have a slot for the ability image. The "yes" should be lowercase because it is not an entity.
 +
 
 +
;status
 +
:no input: no change
 +
:one of the [[status]] conditions. Please use uppercase. Automatically places item in a relevant category.
 +
 
 +
;set
 +
:no input: defaults to the item's icon and "isn't in a set."
 +
:Use only if the item is confirmed to be in a [[set]]. Other groupings are listed in [[collection]]s and don't belong in this field. If the item qualifies to be in a set, use the code like so:
  
−
Use an incremental number (i.e. 2, 3, 4) to add to the image file name using this variable then upload the new version of the icon or equipped image at that name.
 
 
<pre>
 
<pre>
−
| fixicon = 2 (optional)
+
{{WeaponInfo
−
| fiximg = 2 (optional)
+
| name    = {{PAGENAME}}
 +
| type    = handgun
 +
| star    = 5
 +
| damage 1 = Shadow
 +
| set      = {{SetLinks
 +
| item 1 = Gorgofist
 +
| item 2 = Gorgomega
 +
}}
 +
}}
 
</pre>
 
</pre>
 +
 +
==Notes==
 +
This infobox is different from previous infoboxes. The star info and item icon have been moved into the body of the box. The title text font size has been shrunk to fit into a single line in the infobox window - this size is determined by the current longest known item name in the game (one of the "gunner" items, [[Sacred Snakebite Pathfinder Armor]]).
 +
 +
Discussion about this template can be found on the wiki editors' forums:
 +
:[http://forums.spiralknights.com/en/node/107506 Infoboxes in general]
 +
:[http://forums.spiralknights.com/en/node/108709 Weapon page format]
 +
:[http://forums.spiralknights.com/en/node/108681 "Special" category usage]

Latest revision as of 12:45, 31 March 2015

Usage

This places an infobox about the weapon on the upper right corner of an article.

It also places the weapon in relevant categories, some of which are "special" categories that use numeric organization.

It uses a few other templates to get the job done. Full documentation for individual templates used can be found by entering this template's code into the edit field of the page you wish to update, clicking "preview," and navigating through "templates used on this page" below the edit field box.

Code

{{WeaponInfo
| name      = {{PAGENAME}} 
| type      = 
| star      = 
| damage 1  = 
| damage 2  = 
| abilities = 
| status    =
| set       = 
}}

Parameters

Required

name
The confirmed name of the item as seen in-game. {{PAGENAME}} should be used for easier copypasting and reduction of mistakes, unless there are disambiguation issues.
type
either bomb, handgun, or sword. We are using lowercase because I forgot about {{lcfirst:}}.
star
either 0, 1, 2, 3, 4, or 5.
damage 1
either Normal, Elemental, Piercing, or Shadow. Please use uppercase. Automatically places item in a relevant category.

Optional

damage 2
no input: no change
Use only if the item has two offensive damage types. "damage 1" is usually "normal" if there are two damage types - several swords are like this. Either Elemental, Piercing, or Shadow. Please use uppercase. Automatically places item in a relevant category.
abilities
no input: defaults to "this item doesn't have any special abilities."
just enter "yes" If the item has any abilities at all. This makes the template have a slot for the ability image. The "yes" should be lowercase because it is not an entity.
status
no input: no change
one of the status conditions. Please use uppercase. Automatically places item in a relevant category.
set
no input: defaults to the item's icon and "isn't in a set."
Use only if the item is confirmed to be in a set. Other groupings are listed in collections and don't belong in this field. If the item qualifies to be in a set, use the code like so: 
{{WeaponInfo
| name     = {{PAGENAME}}
| type     = handgun
| star     = 5
| damage 1 = Shadow
| set      = {{SetLinks
| item 1 = Gorgofist
| item 2 = Gorgomega
}}
}}

Notes

This infobox is different from previous infoboxes. The star info and item icon have been moved into the body of the box. The title text font size has been shrunk to fit into a single line in the infobox window - this size is determined by the current longest known item name in the game (one of the "gunner" items, Sacred Snakebite Pathfinder Armor).

Discussion about this template can be found on the wiki editors' forums:

Infoboxes in general
Weapon page format
"Special" category usage
Retrieved from "https://wiki.spiralknights.com/index.php?title=Template:WeaponInfo/doc&oldid=200629"
Personal tools