Template:FurnitureList/doc

From SpiralKnights

Revision as of 04:38, 21 November 2014 by Novaster (Talk | contribs)

Jump to: navigation, search

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.

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.

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

Example: general example...

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


Produces:

- fixed capital letter in "Start" (consistency with template naming like SKWindow/NewRow etc.)

|- valign="middle" | style="background: #c7dbea; padding: 3px 3px 3px 3px; border-radius: 5px;" align="center" | [[{{{link}}}|Bed]]

| style="background: #c7dbea; padding: 3px 3px 3px 3px; border-radius: 5px;" |
link={{{link}}}

| style="background: #c7dbea; padding: 3px 3px 3px 3px; border-radius: 5px;" align = "center" valign = "middle" | Bed

| style="background: #c7dbea; padding: 3px 3px 3px 3px; border-radius: 5px;" align = "center" valign = "middle" | Birdsong Emporium

| style="background: #c7dbea; padding: 3px 3px 3px 3px; border-radius: 5px;" valign = "top" | Interactive: ???


|}



Example: emphasis on disambiguation workaround...

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

Produces:

- fixed capital letter in "Start" (consistency with template naming like SKWindow/NewRow etc.)

|- valign="middle" | style="background: #c7dbea; padding: 3px 3px 3px 3px; border-radius: 5px;" align="center" | [[{{{link}}}|Frumious Fang]]

| style="background: #c7dbea; padding: 3px 3px 3px 3px; border-radius: 5px;" |
link={{{link}}}

| style="background: #c7dbea; padding: 3px 3px 3px 3px; border-radius: 5px;" align = "center" valign = "middle" | Stand

| style="background: #c7dbea; padding: 3px 3px 3px 3px; border-radius: 5px;" align = "center" valign = "middle" | Boss Trophy (Armero)

| style="background: #c7dbea; padding: 3px 3px 3px 3px; border-radius: 5px;" valign = "top" | Interactive: ???


|}



Example: emphasis on overworld image...

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


Produces:

- fixed capital letter in "Start" (consistency with template naming like SKWindow/NewRow etc.)

|- valign="middle" | style="background: #c7dbea; padding: 3px 3px 3px 3px; border-radius: 5px;" align="center" | [[{{{link}}}|Curious Mewkat]]

| style="background: #c7dbea; padding: 3px 3px 3px 3px; border-radius: 5px;" |
link={{{link}}}

| style="background: #c7dbea; padding: 3px 3px 3px 3px; border-radius: 5px;" align = "center" valign = "middle" | Creature

| style="background: #c7dbea; padding: 3px 3px 3px 3px; border-radius: 5px;" align = "center" valign = "middle" | Moorcroft

| style="background: #c7dbea; padding: 3px 3px 3px 3px; border-radius: 5px;" valign = "top" | Interactive: ???


|}



And so on.

Personal tools