Sablon:Item/doc
An all-in-one template for display item name/icon/link.
By default, displays a link to the item and adds an item icon in front of it.
Usage
All parameters are optional. Despite this, some combinations are invalid and may cause errors, e.g. {{item|icons=no|mode=image}}
See examples below for more details.
- unnamed parameter 1
Default item display name, link target, and image file name. If unspecitied, will try to retrieve it from {{{id}}}.
- unnamed Parameter 2 or t
Custom link text, which can include line breaks (<br />) and other wikitext. If an 's', 'es', 'ies' or 'ves' is passed as the custom text, it will be appended to the end of the item name.
- mode
Display mode. It can be:
image
(Preferred) orimageonly
oronlyimage
means only image will be displayed;text
(Preferred) ornoimage
means no image will be displayed;table
(Preferred) or2-cell
will output 2 cells code for table. This is roughly a shortcut for{{item|mode=image|itemname}} || {{item|mode=text|itemname}}
Use preferred values as much as possible to get the best performance.
- image
image filename, no brackets nor "File:"(must include file extension, eg. Parrot.png).
You can specify multiple images, just seperate filenames with slashes(eg. Parrot.png/Parrot (placed).png).
- size
Custom graphic size (Read Extended image syntax for details).
You can specify multiple sizes, just seperated with slashes(eg. 32px/24x24px).
When multiple images specified:
- If only one size specified, it will apply to all images
- if size is less then image, extra images will be displayed as if they don't have size argument
- if size is more then image, extra sizes will simply be ignored.
- ext
image file extension, default is png. Only valid when there is no image input.
- link
Custom link target. If blank given(i.e. |link=|
), it will be no link(See example below).
- nolink = y/yes
Same as |link=|
, only valid when there is no link
input. If you use |link=somelink|nolink=y
, it will be ignored.
- anchor = y/yes
If set, will create an anchor for {{{1}}}.
- note
Extra note text. By default, it will displayed as smaller and gray text between item name and platform icons , and without link on it.
- note2
Another note text. By default, it will displayed as gray txt in normal size, without link, and always take a single line.
- wrap = y/yes
Only valid when there is no id= or note2= input. If set, platform icons and/or note will be displayed in new line.
- icons = n/no/y/yes
n/no=suppresses the platform icons; default is yes.
- id
Number, will display items(or other type) ID infomation.
- type
the type of ID, case-insensitive, default is item
, only valid when id is sepcified. can be tile
, wall
, npc
, mount
, buff
, debuff
, projectile
, or armor
. All other values are treated as item
.
- small = y/yes
Reduces the size of the platform icons (useful when space is an issue).
- class
Custom Css class(es). There're some predefined classes for certain formatting purpose(see examples below). You can add yours if needed.
- css or style
Custom css style rules.
Examples
Basic
Result | Code | Note |
---|---|---|
Ágy | {{item|Bed}} |
Basic usage. |
Any Bed | {{item|Bed|Any Bed}} |
Custom text. |
Ágy Pillangó | {{item|Bed|s}} {{item|Butterfly|ies}} |
plural. |
Wooden Sword Tárgyi adatértéke: 24 |
{{item|id=24}} |
auto retrieve name from id. |
My Best Weapon Tárgyi adatértéke: 24 |
{{item|id=24|t=My Best Weapon}} |
auto retrieve name from id. |
Húsfal | {{item|Wall of Flesh|size=32px}} |
custom image size. (Read Extended image syntax for details). |
Wall of Flesh |
{{item|Wall of Flesh|size=32px|Wall of<br/>Flesh}} |
Custom text in multiple lines. |
Kincses zsák | {{item|Treasure Bag|s|ext=gif}} |
Custom image file extension. |
Kincses zsák(Expert Mode) | {{item|Treasure Bag|s|note={{small|(Expert Mode)}}|ext=gif}} |
Note text. |
Parrot Pet | {{item|Pet Parrot|image=Parrot.png|Parrot Pet}} |
Custom image file name. |
Parrot Pet | {{item|Pet Parrot|image=Parrot.png|Parrot Pet|ext=jpg}} |
Will display Parrot.png, ext is ignored when image specified.
|
Parrot Pet | {{item|Parrot|link=Pet Parrot|Parrot Pet}} |
Custom link target. |
Beeswax | {{item|Beeswax|link=}} |
Unlinked. |
Beeswax | {{item|Beeswax|nolink=y}} |
Unlinked. |
Beeswax | {{item|Beeswax|nolink=y|link=Bee}} |
if link is specified, it will override unlink=y .
|
Beeswax | {{item|Beeswax|small=y}} |
Small platform icons. |
Beeswax | {{item|Beeswax|icons=no}} |
Don't display platform icons.(Will be faster) |
Beeswax Tárgyi adatértéke: 5019 |
{{item|Beeswax|id=5019}} |
With Item ID infomation |
Pet Tiphia Hatásbeli adatértéke: 204 |
{{item|Pet Tiphia|id=204|type=buff}} |
Other type of ID, in this case, Buff ID. |
Segítő Ellenféli adatértéke: 22 |
{{item|Guide|id=22|type=npc}} |
NPC ID. |
Beeswax Tárgyi adatértéke: 5019 |
{{item|Beeswax|id=5019|anchor=y}} |
Create an anchor. Now {{PAGENAME}}#Beeswax will link to here. |
Multiple images
Result | Code | Note |
---|---|---|
Kemence | {{item|Furnace|image=Furnace.png/Furnace_(placed).gif}} |
Multiple images with auto size. |
Kemence | {{item|Furnace|image=Furnace.png/Furnace_(placed).gif|size=20px}} |
Only one size specified, all images will use this size. |
Kemence | {{item|Furnace|image=Furnace.png/Furnace_(placed).gif|size=30px/20px}} |
Multiple images with multiple sizes. |
Kemence | {{item|Furnace|image=Furnace.png/Furnace_(placed).gif|size=30px/20px/300px}} |
Size is more them images, extra size is ignored. |
Kemence | {{item|Furnace|image=Furnace.png/Furnace_(placed).gif/Hellforge.png|size=16px/50px}} |
Size is less then image, extra image will use auto size. |
Wrap, id and note2
wrap
is valid only when id
and note2
are not specified.
Display mode
Css and predefined classes
Result | Code | Note |
---|---|---|
Beeswax Tárgyi adatértéke: 2384 |
{{item|Beeswax|link=|id=2384|css=color:red;border: 2px solid blue;padding: 3px; background:#ccc}} |
Custom css rules. |
Beeswax Tárgyi adatértéke: 2384 |
{{item|Beeswax|id=2384|class=boldname}} |
Predefined class: boldname , item name will displayed in bold.
|
Beeswaxnote note2 Tárgyi adatértéke: 2384 Beeswaxnote note2 Tárgyi adatértéke: 2384 Beeswaxnote note2 Tárgyi adatértéke: 2384 |
{{item|Beeswax|id=2384|note=note|note2=note2|class=notecolor}} |
Predefined class: notecolor and note2color , note or note2 will display in normal(inherited) text color, respectively .
|
Beeswaxnote note2 Tárgyi adatértéke: 2384 Beeswaxnote note2 Tárgyi adatértéke: 2384 |
{{item|Beeswax|id=2384|note=note|note2=note2|class=notecolor}} |
Predefined class: notesize and note2size , note will display in normal size, or note2 will display in reduced size, respectively.
|
Beeswaxnote note2 Tárgyi adatértéke: 2384 Beeswaxnote note2 Tárgyi adatértéke: 2384 Beeswaxnote note2 Tárgyi adatértéke: 2384 |
{{item|Beeswax|id=2384|note=note|note2=note2|class=textleft}}<br/>{{item|Beeswax|id=2384|note=note|note2=note2|class=textcenter}}<br/>{{item|Beeswax|id=2384|note=note|note2=note2|class=textright}} |
Predefined class: textleft , textcenter , and textright , Similar to alignleft/aligncenter/alignright , but only applied to text part.alignleft/center/right can use with text/align/center/right at same time.
|
Beeswax Tárgyi adatértéke: 2384 |
{{item|Beeswax|id=2384|class=block|mode=text}} |
Predefined class: block , main item element and text element will display as block element(default is inline-block ).It is usually only practical when mode=text .
|
Beeswaxnote note2 Tárgyi adatértéke: 2384 |
{{item|Beeswax|id=2384|note=note|note2=note2|class=notesize notecolor boldname|css=color:red}} |
You can specify multiple classes, seperate with space, and can specify custom css rules at the same time. |
Change default options
You can use {{item/options}}
to set/get and reset some options' default value.
Usage
- Set:
{{item/options|nolink=y|smallicons=no|...}}
or{{item/options|set|nolink=y|smallicons=no|...}}
- get:
{{item/options|get|nolink}}
- reset:
{{item/options|reset}}
or{{item/options|resetall}}
All parameters:
- unnamed parameter 1
Action. get
or load
means get the current value of a option, reset
or resetall
means reset all options to default value, other values(include none. if you want, recommend to use set
for better readability) means set options' value.
- unnamed Parameter 2
The name of option which you want to get its value, only valid when action is get. Can be small
, smallicons
, icons
, mode
, wrap
, nolink
, class
, css
or style
.
- small/smallicons = y/yes/n/no
Only valid when action is set. Turn on/off reduced size for platform icons. See {{item}}
's small
parameter.
- icons = y/yes/n/no
Only valid when action is set. Turn on/off platform icons display. When turn off, {{item}}
will be faster. See {{item}}
's icons
parameter.
- mode
Only valid when action is set. Set the default value for {{item}}
's mode parameter. You can use any valid value for {{item}}
's mode parameter, and a invalid value(recommend to use default
, all
, or both
for better readability) means change the mode back to default. See {{item}}
's mode
parameter.
- wrap = y/yes/n/no
Only valid when action is set. Turn on/off line wrap. See {{item}}
's wrap
parameter.
- anchor = y/yes/n/no
Only valid when action is set. Turn on/off anchor. See {{item}}
's anchor
parameter.
- nolink = y/yes/n/no
Only valid when action is set. Turn on/off no link option. See {{item}}
's nolink
parameter.
- class
Only valid when action is set. Default value for class
. See {{item}}
's class
parameter.
- css/style
Only valid when action is set. Default value for css
. See {{item}}
's css
parameter.
See examples below for more details.
Example
Code | output |
---|---|
By default: {{item|Beeswax|note=(note)}} turn off platform icons: {{item/options|set|icons=no}} {{item|Beeswax|note=(note)}} turn on platform icons, and turn on small icons: {{item/options|set|icons=y|smallicons=y}} {{item|Beeswax|note=(note)}} turn on line wrap, and set to text mode: {{item/options|set|wrap=y|mode=text}} {{item|Beeswax|note=(note)}} turn on no link mode: {{item/options|set|nolink=y}} {{item|Beeswax|note=(note)}} This will be overrided by '''<code>link=</code>''' {{item|Beeswax|note=(note)|link=Bee}} get current setting: nolink = {{item/options|get|nolink}} ; wrap = {{item/options|get|wrap}} ; mode = {{item/options|get|mode}} ; reset all options: {{item/options|reset}} {{item|Beeswax|note=(note)}} custom css and class: {{item/options|set|css=border:1px solid red;padding:3px}} {{item|Beeswax|note=(note)}} {{item/options|set|class=boldname}} {{item|Beeswax|note=(note)}} reset all: {{item/options|resetall}} {{item|Beeswax|note=(note)}} |
By default: turn off platform icons: turn on platform icons, and turn on small icons: turn on line wrap, and set to text mode: Beeswax (note) turn on no link mode: Beeswax (note) This will be overrided by Beeswax (note) get current setting: nolink = y ; wrap = y ; mode = text ; reset all options: custom css and class: reset all:
|
- Pages using DynamicPageList3 dplvar parser function
- Template documentation