Difference between revisions of "Template:WareList/doc"
From SpiralKnights
m (created) |
m (→Notes: actually we sort of would need to do that for that method. Just going to take this speculation out, and work on it in the future. Or someone else can have a go at it.) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| + | <noinclude>{{documentation subpage}}</noinclude> | ||
==Usage== | ==Usage== | ||
To display a sortable list of wares on individual [[vendor]] pages. It is similar to [[Template:PrizeBoxList]], but does not display the item's tooltip, and provides cost information instead of possibility data. | To display a sortable list of wares on individual [[vendor]] pages. It is similar to [[Template:PrizeBoxList]], but does not display the item's tooltip, and provides cost information instead of possibility data. | ||
| Line 15: | Line 16: | ||
==Parameters== | ==Parameters== | ||
| − | Parameters are highly variable, designed to work with the huge inventory of Spiral Knights. For examples, see [http://wiki.spiralknights.com/Special:WhatLinksHere/Template:WareList what links here] to determine what is best for unit cost variation and colloquial subtypes (subtyping is not part of the game. It is something editors have agreed to do to further aid item searching within these lists as well as player understanding. Materials do not have subtypes). Pay special attention to capitalization. Do not upload icon files unless you know the item has just been released or there has been trouble obtaining an icon for a long time due to recolor behavior. All icons are otherwise uploaded, rendering red text the result of an error in input. | + | Parameters are highly variable, designed to work with the huge inventory of Spiral Knights. For examples, see [http://wiki.spiralknights.com/Special:WhatLinksHere/Template:WareList what links here] to determine what is best for unit cost variation and colloquial subtypes (subtyping is not part of the game's inventory classification in many cases. It is something editors have agreed to do to further aid item searching within these lists as well as player understanding. Materials do not have subtypes). Pay special attention to capitalization. Do not upload icon files unless you know the item has just been released or there has been trouble obtaining an icon for a long time due to recolor behavior. All icons are otherwise uploaded, rendering red text the result of an error in input. |
Notes are built into the template for [[Hall of Heroes]] vendors. Otherwise, the phrase "Binds upon purchase." is most commonly used here. It is not a template default because editors need to carefully make sure each entry is correct for sensitive [[binding]] information. | Notes are built into the template for [[Hall of Heroes]] vendors. Otherwise, the phrase "Binds upon purchase." is most commonly used here. It is not a template default because editors need to carefully make sure each entry is correct for sensitive [[binding]] information. | ||
==Notes== | ==Notes== | ||
| − | The cost column is not sortable because sorting tends to organize the table in a rather useless manner for certain vendors (especially [[Randolph]]). Tables sort lower values to the top first, | + | The cost column is not sortable because sorting tends to organize the table in a rather useless manner for certain vendors (especially [[Randolph]]). Tables sort lower place values to the top first, meaning 100 is considered to be less than 20 due to "1" vs. "2". To avoid the various complications that arise from this behavior, vendor lists have each individual ware entry in order from least to greatest based on cost, with unit variation organized alphabetically in the same manner. See [[Brinks]] for more details. |
Latest revision as of 15:53, 20 April 2016
 |
This is a documentation subpage for Template:WareList (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template page. |
Contents
Usage
To display a sortable list of wares on individual vendor pages. It is similar to Template:PrizeBoxList, but does not display the item's tooltip, and provides cost information instead of possibility data.
Code
{{WareList
|name =
|type =
|subtype =
|star =
|cost =
|notes =
}}
Parameters
Parameters are highly variable, designed to work with the huge inventory of Spiral Knights. For examples, see what links here to determine what is best for unit cost variation and colloquial subtypes (subtyping is not part of the game's inventory classification in many cases. It is something editors have agreed to do to further aid item searching within these lists as well as player understanding. Materials do not have subtypes). Pay special attention to capitalization. Do not upload icon files unless you know the item has just been released or there has been trouble obtaining an icon for a long time due to recolor behavior. All icons are otherwise uploaded, rendering red text the result of an error in input.
Notes are built into the template for Hall of Heroes vendors. Otherwise, the phrase "Binds upon purchase." is most commonly used here. It is not a template default because editors need to carefully make sure each entry is correct for sensitive binding information.
Notes
The cost column is not sortable because sorting tends to organize the table in a rather useless manner for certain vendors (especially Randolph). Tables sort lower place values to the top first, meaning 100 is considered to be less than 20 due to "1" vs. "2". To avoid the various complications that arise from this behavior, vendor lists have each individual ware entry in order from least to greatest based on cost, with unit variation organized alphabetically in the same manner. See Brinks for more details.
