Difference between revisions of "Template:FurnitureInfo/doc"
From SpiralKnights
(Created page with '<noinclude>{{documentation subpage}}</noinclude> Use the template to display furniture. <pre> {{FurnitureInfo | name = {{PAGENAME}} | cost = ### | availability = Area }} </pre> …') |
m (added doc subpage tag) |
||
| (8 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
<noinclude>{{documentation subpage}}</noinclude> | <noinclude>{{documentation subpage}}</noinclude> | ||
| − | + | ==Parameters== | |
| + | ===Required=== | ||
| − | < | + | ;"name" |
| − | + | :The true name of the item as seen in-game. Avoid using '''<nowiki>{{PAGENAME}}</nowiki>''' - don't want to deal with disambiguation issues. | |
| − | + | ;"acquisition" | |
| − | + | :Where to obtain the item, and how much it costs, if there is a set price. Items from boxes typically don't have a set price, though we have seen some stability in [[Supply Depot Sale]]s, it would not be prudent to state prices of this nature in an official manner. | |
| − | + | ;"dimensions" | |
| − | + | :The length by width dimensions. To date, dimensions include: | |
| − | + | ::1x1 | |
| + | ::2x1 | ||
| + | ::2x2 | ||
| + | ::3x1 | ||
| + | ::3x3 | ||
| + | ;"rotation" | ||
| + | :The directions that the item can be rotated in design mode. To date, directions include: | ||
| + | ::S | ||
| + | ::SWE | ||
| + | ::NSWE | ||
| + | ::ALL | ||
| + | ::WANDERING | ||
| − | + | ==Usage== | |
| + | For furniture items that have just a tad more information than a simple chair, warranting their own pages. Typically used for items that have a recipe, like [[Trophy Furniture]]. | ||
| − | < | + | It is recommended to use '''<nowiki>__NOTOC__</nowiki>''' after this template, since most of the pages this template is used on are very compressed and tidy as a result of this template, rendering a ToC less useful and more in the way. |
| − | | | + | |
| − | </ | + | |
| + | ;Example: | ||
| + | <nowiki> | ||
| + | {{FurnitureInfo</nowiki><br/><nowiki> | ||
| + | | name = Replica Royal Jelly</nowiki><br/><nowiki> | ||
| + | | acquisition = Craft at [[Armero Alchemy Machine]]</nowiki><br/><nowiki> | ||
| + | | dimensions = 3x3</nowiki><br/><nowiki> | ||
| + | | rotation = NSWE</nowiki><br/><nowiki> | ||
| + | }}</nowiki><br/><nowiki> | ||
| + | </nowiki> | ||
| + | <br/><br/><br/> | ||
| + | |||
| + | ;Produces: | ||
| + | |||
| + | <includeonly> | ||
| + | {{FurnitureInfo | ||
| + | | name = Replica Royal Jelly | ||
| + | | acquisition = Craft at [[Armero Alchemy Machine]] | ||
| + | | dimensions = 3x3 | ||
| + | | rotation = NSWE | ||
| + | }}</includeonly> | ||
Latest revision as of 22:22, 2 October 2015
 |
This is a documentation subpage for Template:FurnitureInfo (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template page. |
Parameters
Required
- "name"
- The true name of the item as seen in-game. Avoid using {{PAGENAME}} - don't want to deal with disambiguation issues.
- "acquisition"
- Where to obtain the item, and how much it costs, if there is a set price. Items from boxes typically don't have a set price, though we have seen some stability in Supply Depot Sales, it would not be prudent to state prices of this nature in an official manner.
- "dimensions"
- The length by width dimensions. To date, dimensions include:
- 1x1
- 2x1
- 2x2
- 3x1
- 3x3
- "rotation"
- The directions that the item can be rotated in design mode. To date, directions include:
- S
- SWE
- NSWE
- ALL
- WANDERING
Usage
For furniture items that have just a tad more information than a simple chair, warranting their own pages. Typically used for items that have a recipe, like Trophy Furniture.
It is recommended to use __NOTOC__ after this template, since most of the pages this template is used on are very compressed and tidy as a result of this template, rendering a ToC less useful and more in the way.
- Example
{{FurnitureInfo
| name = Replica Royal Jelly
| acquisition = Craft at [[Armero Alchemy Machine]]
| dimensions = 3x3
| rotation = NSWE
}}
- Produces
