Template:Item/doc
This is the documentation page for Item. It contains usage information, categories, and other content not part of the original template page. | ||
|---|---|---|
| Main | Documentation | Usage |
This template creates an icon and link for a given Item.
Syntax
{{Item|item name|optional size}}
Parameter List
- 1 or name — Name of the item. Defaults to Unknown.
- 2 or size — Size of the image in pixels. Defaults to 30.
- x or count — The amount of the item.
- link — Page to link to. Defaults to the item name
- text — Text to display. Defaults to the item name.
- notext — Set to "1" to omit text.
- type — Type of the item. Defaults to Item.
- newline — Set to "1" to display text on a new line.
- ref — Reference to append to the entire content.
- comma — Append a comma to the item text following AmE rules.
- dot — Append a dot to the item text following AmE rules.
- commaspc — Append a comma and a space to the item text following AmE rules.
- dotspc — Append a dot and a space to the item text following AmE rules.
Examples
Parameter #1
{{Item|Popsicle}} yields: ![]()
Popsicle
Parameter #2
{{Item|Popsicle|20}} yields: ![]()
Popsicle
{{Item|Popsicle|200}} yields: ![]()
Popsicle
link
{{Item|Popsicle|link = Food}} yields: ![]()
Popsicle
text
{{Item|Popsicle|text = Not Popsicles}} yields: ![]()
Not Popsicles
notext
{{Item|Popsicle|notext = 1}} yields: ![]()
x
{{Item|Popsicle|x = 5,000}} yields: ![]()
Popsicle ×5,000
Ending Punctuation
{{Item|Popsicle|x = 5,000|comma = 1}} yields: ![]()
Popsicle ×5,000,
{{Item|Lucky Star|comma = 1}} yields: ![]()
Lucky Star,
{{Item|Lucky Star|note = this is an item|dotspc = 1}} yields: ![]()
Lucky Star (this is an item).
Template Data
Creates an icon and link for a given Item.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Item Name | 1 name | Name of the Item
| String | required |
| Image Size | 2 size | Size of the image, in pixels
| String | optional |
| Amount | x count | Amount of the item
| Number | suggested |
| Page Link | link | Page to link to, if different from the item. Defaults to the item name. | String | optional |
| Text | text | Text to display. Defaults to the item name. | String | optional |
| No Text | notext | Set to "1" to omit text after the item image | Boolean | optional |
| Type | type | Type of the item, for items that do not use the "Item" prefix
| String | optional |
| white | white | no description | Unknown | optional |
| New Line | newline | Set to "1" to display text on a new line. | Boolean | optional |