Difference between revisions of "Template:FurnitureList/doc"

From SpiralKnights

Jump to: navigation, search
(new documentation, now that changes seem to be in place and running smoothly.)
m (update)
Line 1: Line 1:
 +
==Code==
 +
<pre>
 +
{{FurnitureList
 +
|example name =
 +
|general name =
 +
|group        =
 +
|type        =
 +
|image        =
 +
|link        =
 +
}}
 +
</pre>
 +
 
==Parameters==
 
==Parameters==
 
===Required===
 
===Required===
'''<nowiki>{{FurnitureList/start}}</nowiki>''' - starts template.
+
'''<nowiki>{{FurnitureList/Start}}</nowiki>''' - starts template.
  
 
'''example name''' = pick an item that you feel best represents a small group of items that look, behave, and are named in a similar way to each other.
 
'''example name''' = pick an item that you feel best represents a small group of items that look, behave, and are named in a similar way to each other.
Line 25: Line 37:
 
:''tooltip'' - shows a tooltip image of the item. This is generally preferable because it shows dimensions and scale of the item.
 
:''tooltip'' - shows a tooltip image of the item. This is generally preferable because it shows dimensions and scale of the item.
  
'''page linked to''' = the page that the general name, icon, and image links to. Useful for getting around Disambiguation issues, as with the [[Royal Jelly Crown]] and several others.
+
'''link''' = the page that the general name, icon, and image links to. Useful for getting around Disambiguation issues, as with the [[Royal Jelly Crown]] and several others.
  
'''<nowiki>{{Table/end}}</nowiki>''' - ends template.
+
'''<nowiki>{{Table/End}}</nowiki>''' - ends template.
  
 
===Optional===
 
===Optional===
Line 35: Line 47:
 
For the main furniture list. Keeps things neat, concise, and easy to plug-n-chug for new items.
 
For the main furniture list. Keeps things neat, concise, and easy to plug-n-chug for new items.
  
'''Example''': general example...
+
See [http://wiki.spiralknights.com/index.php?title=Special%3AWhatLinksHere&limit=500&target=Template%3AFurnitureList&namespace=0 What Links Here] for examples of this template in action.
 
+
<nowiki>
+
{{FurnitureList/start}}</nowiki><br/><nowiki>
+
</nowiki><br/><nowiki>
+
{{FurnitureList</nowiki><br/><nowiki>
+
|example name = Spiral Blue Bed</nowiki><br/><nowiki>
+
|general name = Bed</nowiki><br/><nowiki>
+
|group = [[Birdsong Emporium Furniture|Birdsong Emporium]]</nowiki><br/><nowiki>
+
|type = Bed</nowiki><br/><nowiki>
+
|image = tooltip</nowiki><br/><nowiki>
+
|page linked to = Spiral Blue Bed</nowiki><br/><nowiki>
+
}}</nowiki><br/><nowiki>
+
</nowiki><br/><nowiki>
+
{{Table/end}}
+
</nowiki>
+
{{clearleft}}
+
 
+
 
+
'''Produces''':
+
{{FurnitureList/start}}
+
 
+
{{FurnitureList
+
|example name = Spiral Blue Bed
+
|general name = Bed
+
|group = [[Birdsong Emporium Furniture|Birdsong Emporium]]
+
|type = Bed
+
|image = tooltip
+
|page linked to = Spiral Blue Bed
+
}}
+
 
+
{{Table/end}}
+
 
+
{{clearleft}}
+
----
+
'''Example''': emphasis on disambiguation workaround...
+
 
+
<nowiki>
+
{{FurnitureList/start}}</nowiki><br/><nowiki>
+
</nowiki><br/><nowiki>
+
{{FurnitureList</nowiki><br/><nowiki>
+
|example name = Frumious Fang </nowiki><br/><nowiki>
+
|general name = Frumious Fang</nowiki><br/><nowiki>
+
|group = [[Trophy Furniture|Boss Trophy (Armero)]]</nowiki><br/><nowiki>
+
|type = Stand</nowiki><br/><nowiki>
+
|image = tooltip</nowiki><br/><nowiki>
+
|page linked to = Frumious Fang (Furniture)</nowiki><br/><nowiki>
+
}}</nowiki><br/><nowiki>
+
</nowiki><br/><nowiki>
+
{{Table/end}}</nowiki><br/><nowiki>
+
</nowiki>
+
{{clearleft}}
+
 
+
'''Produces''':
+
 
+
{{FurnitureList/start}}
+
 
+
{{FurnitureList
+
|example name = Frumious Fang
+
|general name = Frumious Fang
+
|group = [[Trophy Furniture|Boss Trophy (Armero)]]
+
|type = Stand
+
|image = tooltip
+
|page linked to = Frumious Fang (Furniture)
+
}}
+
 
+
{{Table/end}}
+
 
+
{{clearleft}}
+
----
+
'''Example''': emphasis on overworld image...
+
 
+
<nowiki>
+
{{FurnitureList/start}}</nowiki><br/><nowiki>
+
</nowiki><br/><nowiki>
+
{{FurnitureList</nowiki><br/><nowiki>
+
|example name = Curious Mewkat</nowiki><br/><nowiki>
+
|general name = Curious Mewkat</nowiki><br/><nowiki>
+
|group = [[Moorcroft Furniture|Moorcroft]]</nowiki><br/><nowiki>
+
|type = Creature</nowiki><br/><nowiki>
+
|image = overworld</nowiki><br/><nowiki>
+
|page linked to = Curious Mewkat</nowiki><br/><nowiki>
+
}}</nowiki><br/><nowiki>
+
</nowiki><br/><nowiki>
+
{{Table/end}}
+
</nowiki>
+
{{clearleft}}
+
 
+
 
+
'''Produces''':
+
 
+
{{FurnitureList/start}}
+
 
+
{{FurnitureList
+
|example name = Curious Mewkat
+
|general name = Curious Mewkat
+
|group = [[Moorcroft Furniture|Moorcroft]]
+
|type = Creature
+
|image = overworld
+
|page linked to = Curious Mewkat
+
}}
+
 
+
{{Table/end}}
+
 
+
{{clearleft}}
+
 
+
 
+
And so on.
+

Revision as of 17:35, 4 July 2015

Code

{{FurnitureList
|example name = 
|general name = 
|group        = 
|type         = 
|image        = 
|link         = 
}}

Parameters

Required

{{FurnitureList/Start}} - starts template.

example name = pick an item that you feel best represents a small group of items that look, behave, and are named in a similar way to each other.

general name = the name the community uses and/or the simplest version of a name. We have Bolted Vees, and then we have Toasty Bolted Vees, Regal Bolted Vees, etc. "Bolted Vee" would be the choice.

group = the group or family the item belongs to. This is almost always very obvious, since furniture items are almost always released together.

type =

Bed - any furniture item that the knight can interact with to lie down on.
Creature - any furniture entity that comes in a cage
Doodad - a general term used in many games to describe a miscellaneous, non-interactive, perhaps animated, decorative entity. This term is arbitrarily and unofficially used for understanding of item types on this wiki. Tables, Piles, and other misc. things are of this type.
Light - any item that has the primary function of providing light. Some items glow, like the Energy Well, these are clearly not meant to be thought of as lights.
Mat - any furniture item that is flat and placed on the ground that doesn't hinder movement. Carpets, Rugs, etc.
Plant - any furniture item that is a plant.
Seat - any furniture item that the knight can interact with to sit down on.
Special - any furniture item that does not fall into the other types, usually brings up a special interface.
Stand - any furniture item that is clearly on display, or has "stand" in its name.
Wall- any furniture item that is tall and wide, typically with a blank/empty backside. So far, Shelves and Wardrobes have this type.

image =

overworld - shows an overworld image of the item. This is preferred for Creature type furniture items, because their tooltip image is a cage.
tooltip - shows a tooltip image of the item. This is generally preferable because it shows dimensions and scale of the item.

link = the page that the general name, icon, and image links to. Useful for getting around Disambiguation issues, as with the Royal Jelly Crown and several others.

{{Table/End}} - ends template.

Optional

{{{clearleft}}} - put this after {{Table/end}} to fix any page organization/squishing issues.

Usage

For the main furniture list. Keeps things neat, concise, and easy to plug-n-chug for new items.

See What Links Here for examples of this template in action.

Personal tools