Difference between revisions of "Template:FurnitureList/doc"
From SpiralKnights
m (Replaced content with 'PENDING - this template is currently being worked one extensively. Parameters inconsistent until work finished.') |
m (→Parameters) |
||
| (4 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== | ||
| + | ===Required=== | ||
| + | '''<nowiki>{{FurnitureList/Start}}</nowiki>''' - 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. | ||
| + | |||
| + | '''<nowiki>{{Table/End}}</nowiki>''' - ends template. | ||
| + | |||
| + | ===Optional=== | ||
| + | '''<nowiki>{{{clearleft}}}</nowiki>''' - put this after <nowiki>{{Table/end}}</nowiki> 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 [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. | ||
Latest revision as of 18:39, 4 July 2015
Contents
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.
