Difference between revisions of "Template:FurnitureList/doc"

From SpiralKnights

Jump to: navigation, search
m (Usage: copper yellow isn't spiral)
m (Replaced content with 'PENDING - this template is currently being worked one extensively. Parameters inconsistent until work finished.')
Line 1: Line 1:
==Parameters==
+
PENDING - this template is currently being worked one extensively. Parameters inconsistent until work finished.
===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).
+
 
+
'''group link''' = allows cleaner linking to ideal pages of lists.
+
 
+
'''example icon''' =  the filename of the item's icon image
+
 
+
'''example image''' = the filename of the item's tooltip or overworld image
+
 
+
'''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 community/slang term used to describe the collection, usually named after the box they come from.
+
 
+
'''type''' = unofficial terminology used to describe the furniture.
+
 
+
{{showhide|List of Types|content=
+
'''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.
+
 
+
'''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.
+
 
+
'''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==
+
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.
+
 
+
 
+
 
+
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 = 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 = 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}}
+

Revision as of 18:27, 20 November 2014

PENDING - this template is currently being worked one extensively. Parameters inconsistent until work finished.

Personal tools