Difference between revisions of "Template:FurnitureList/doc"

From SpiralKnights

Jump to: navigation, search
(Documentation)
 
m (→‎Parameters)
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
==Code==
 +
<pre>
 +
{{FurnitureList
 +
|icon        =
 +
|example name =
 +
|general name =
 +
|group        =
 +
|type        =
 +
|image        =
 +
|link        =
 +
}}
 +
</pre>
 +
 
==Parameters==
 
==Parameters==
 
===Required===
 
===Required===
−
'''page link''' = allows cleaner linking to specific pages. Often goes through a redirect for furniture that is simplistic, having no recipe or other special properties.
+
'''<nowiki>{{FurnitureList/Start}}</nowiki>''' - starts template.
  
−
'''group link''' = allows cleaner linking to ideal pages of lists.
+
'''icon''' = either "one" or "multiple." Enter "one" if the item only comes in one color, or is otherwise "unique."
  
−
'''example icon''' = the filename of the item's icon image
+
'''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 image''' = the filename of the item's tooltip or overworld image
+
'''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.
  
−
'''general name''' = the simplest form of a name. We have bolted vees, and then we have regal bolted vees, toasty bolted vees, and so on. Furniture items have recolors too.
+
'''group''' = the group or family the item belongs to. This is almost always very obvious, since furniture items are almost always released together.
  
−
'''group''' = the community/slang term used to describe the collection, usually named after the box they come from.
+
'''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.
  
−
'''type''' = unofficial terminology used to describe the furniture.
+
'''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.
  
−
{{showhide|List of Types|content=
+
'''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.
−
'''Bed''': any furniture item that a knight can lie down on.
+
  
−
'''Creature''': any entity that comes in a cage. Most "Creature" type furniture can be walked through (intangible) - but a knight will cause a wandering entity to change its travel path.
+
'''<nowiki>{{Table/End}}</nowiki>''' - ends template.
  
−
'''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.
+
===Optional===
−
 
+
'''<nowiki>{{{clearleft}}}</nowiki>''' - put this after <nowiki>{{Table/end}}</nowiki> to fix any page organization/squishing issues.
−
'''Light:''' any furniture item whose primary function is to provide illumination. Other glowing or luminous furniture items, such as the Energy Well, don't fall into this category.
+
−
 
+
−
'''Mat''': any furniture item that looks like a carpet, rug, or similar item. They do not block or alter knight movement. Currently, these items take up space, and other furniture items cannot be placed on top, though wandering creatures can certainly walk over them.
+
−
 
+
−
'''Plant''': any furniture item that is a plant.
+
−
 
+
−
'''Seat''': any furniture item that can be sat upon. Currently, all types of seats (benches, chairs) can only be interacted with by one knight at a time.
+
−
 
+
−
'''Special''': any furniture item that does not fall into the other types, due to some special property, such as opening an exclusive interface.
+
−
 
+
−
'''Stand''': any furniture item that puts something special on display. Typically has a base colored dark yellow and black.
+
−
 
+
−
'''Wall''': any furniture item that is tall and wide. Shelves and Wardrobes fall into this category.
+
−
}}
+
  
 
==Usage==
 
==Usage==
−
For the main furniture page. Keeps things neat, organized, and informative. The number of variable plug-n-chug aspects is due to the large number of disambiguation pages in relation to furniture and other token/gear/etc. items, as well as whether or not the editor wishes to show a tooltip or overworld view, officially. There will seem to be many unneeded repeats, but considering every furniture item (especially boss trophies and creatures like Snipes) their use becomes clear.
+
For the main furniture list. Keeps things neat, concise, and easy to plug-n-chug for new items.
−
 
+
−
 
+
−
 
+
−
Example:
+
−
 
+
−
 
+
−
 
+
−
<nowiki>
+
−
{{FurnitureList/start}}
+
−
{{FurnitureList
+
−
|page link = Spiral Blue Bed
+
−
|group link = Birdsong Emporium Furniture
+
−
|example icon = Spiral Blue Bed
+
−
|example image = Spiral Blue Bed
+
−
|general name = Spiral Bed
+
−
|group = Birdsong Emporium
+
−
|type = Bed
+
−
}}
+
−
{{Table/end}}
+
−
</nowiki>
+
−
 
+
−
 
+
−
 
+
−
Produces:
+
−
 
+
−
 
+
−
 
+
−
{{FurnitureList/start}}
+
−
 
+
−
{{FurnitureList
+
−
|page link = Spiral Blue Bed
+
−
|group link = Birdsong Emporium Furniture
+
−
|example icon = Spiral Blue Bed
+
−
|example image = Spiral Blue Bed
+
−
|general name = Spiral Bed
+
−
|group = Birdsong Emporium
+
−
|type = Bed
+
−
}}
+
−
 
+
−
{{Table/end}}
+
−
 
+
−
{{clearleft}}
+
−
 
+
−
 
+
−
 
+
−
Example:
+
−
 
+
−
 
+
−
 
+
−
<nowiki>
+
−
{{FurnitureList/start}}
+
−
{{FurnitureList
+
−
|page link = Blue Flying Snipe
+
−
|group link = Snipe (Furniture)
+
−
|example icon = Blue Flying Snipe
+
−
|example image = Blue Flying Snipe-Placed
+
−
|general name = Flying Snipe
+
−
|group = Snipe (Haven)
+
−
|type = Creature
+
−
}}
+
−
{{Table/end}}
+
−
</nowiki>
+
−
 
+
−
 
+
−
 
+
−
Produces:
+
−
 
+
−
 
+
−
 
+
−
{{FurnitureList/start}}
+
−
 
+
−
{{FurnitureList
+
−
|page link = Blue Flying Snipe
+
−
|group link = Snipe (Furniture)
+
−
|example icon = Blue Flying Snipe
+
−
|example image = Blue Flying Snipe-Placed
+
−
|general name = Flying Snipe
+
−
|group = Snipe (Haven)
+
−
|type = Creature
+
−
}}
+
−
 
+
−
{{Table/end}}
+
−
 
+
−
{{clearleft}}
+
  
−
==Template==
+
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.
−
</noinclude>
+

Latest revision as of 18:39, 4 July 2015

Code

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

Parameters

Required

{{FurnitureList/Start}} - starts template.

icon = either "one" or "multiple." Enter "one" if the item only comes in one color, or is otherwise "unique."

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.

Retrieved from "https://wiki.spiralknights.com/index.php?title=Template:FurnitureList/doc&oldid=208171"
Personal tools