Template:Item

Template documentation [View] [Edit] [History] [Refresh]

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 unspecified, will try to retrieve it from {{{id}}}.

unnamed Parameter 2

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. Pluralism is partially intuitive - adding 's' to Butterfly will return Butterflies. For non-english language, auto translation will be applied.

t

Custom link text, it will override unnamed Parameter 2, and it will be displayed as-is, without plural processing and auto translation.

mode

Display mode. It can be:

• image(Preferred) or imageonly or onlyimage means only image will be displayed;
• text(Preferred) or noimage means no image will be displayed;
• table(Preferred) or 2-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 separate 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 separated with slashes(eg. 32px/24x24px).

When multiple images specified:

• • If only one size specified, it will apply to all images
  • if size is less than image, extra images will be displayed as if they don't have size argument
  • if size is more than image, extra sizes will simply be ignored.

And you can append it with *[factor] to scale image, e.g. 24x24px*0.5, 24px*0.5/24px*2 ...

scale

Image(s) will be scaled based on size and scale. e.g. |size=32x32px|scale=0.5 is equal to |size=16x16px. This will multiply with scale factor in size parameter, |size=32x32px*0.5|scale=0.5 is equal to |size=8x8px. scale can be set by options.

maxsize

Image size limit. Using standard image size syntax, eg. 32px/24x24px. will be applied after scale.

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). Note: eicons also will base on link first. If you use |link=somelink|nolink=y, it will be ignored.

nolink = y/yes

Same as |link=|. Overrides any link input.

anchor = y/yes

If set, will create an anchor for {{{1}}}.

note

Extra note text. By default, it will be 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 be displayed as gray txt in normal size, without link, and always take a single line.

bignote

Another note text. It will always be displayed after all other text block.

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/<icons content>

n/no=suppresses the platform icons; default is yes; other values will completely override platform icons part, in this case, the value of this parameter should/must usually be {{{{#rmatch:eicons|^#(\s*(\w+?)\s*)(:(.*)$|$)|#[[[:Template:Tl/parser function links]]##$2 $1]:$4|eicons}}{{#dplreplace:|/₪/||}}}}, see examples below.

small = y/yes

Reduces the size of the platform icons (useful when space is an issue).

id

Number, will display items(or other type) ID information.

type

the type of ID, case-insensitive, default is item, only valid when id is specified. can be tile, wall, npc, mount, buff, debuff, projectile, or armor. All other values are treated as item.

showid = y/yes/n/no

Explicitly turn on/off id display. Default is on when id is set, off when id is not set. If showid is turned on and id is not set, will auto retrieve id from database (using data templates such as {{{{#rmatch:itemIdFromName|^#(\s*(\w+?)\s*)(:(.*)$|$)|#[[[:Template:Tl/parser function links]]##$2 $1]:$4|itemIdFromName}}{{#dplreplace:|/₪/||}}}}, according to value of type).

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
	{{item|Bed}}	Basic usage.
	{{item|Format:C}}	":" in item name.
	{{item|Weapon Imbue: Venom}}	": " in item name.
	{{item|Bed|Any Bed}}	Custom text.
	{{item|Bed|Any [[Beds|Bed]]}}	Custom text with link. Note the difference between link target of image and link target of text.
	{{item|Psycho Knife|s}} {{item|Butterfly|s}}	plural.
	{{item|id=24}}	auto retrieve name from id.
	{{item|id=24|showid=no}}	auto retrieve name from id but don't display id.
	{{item|id=24|t=My Best Weapon}}	auto retrieve name from id.
	{{item|id=31|type=buff}}	auto retrieve buff name from id.
	{{item|Wall of Flesh|size=32px}}	custom image size. (Read Extended image syntax for details).
	{{item|Wall of Flesh|size=32px|Wall of<br/>Flesh}}	Custom text in multiple lines.
	{{item|Wall of Flesh|size=32px|Wall of<br/>Flesh|class=multi-line}}	Multiple lines need "multi-line" class for middle vertical align.
	{{item|Treasure Bag|s|ext=gif}}	Custom image file extension.
	{{item|Treasure Bag|s|note={{small|(Expert Mode)}}|ext=gif}}	Note text.
	{{item|Pet Parrot|image=Parrot.png|Parrot Pet}}	Custom image file name.
	{{item|Pet Parrot|image=Parrot.png|Parrot Pet|ext=jpg}}	Will display Parrot.png, ext is ignored when image specified.
	{{item|Beeswax|image=<div style="background:yellow">[[File:Guide.png]]×[[File:Nurse.png]]</div>}}	Custom image code. The code must include at least one [[File: (case insenstive).
	{{item|Parrot|link=Pet Parrot|Parrot Pet}}	Custom link target.
	{{item|Beeswax|link=}}	Unlinked.
	{{item|Beeswax|nolink=y}}	Unlinked.
	{{item|Beeswax|nolink=y|link=Bee}}	if nolink=y is specified, it will override link.
	{{item|Beeswax|small=y}}	Small platform icons.
	{{item|Beeswax|icons=no}}	Don't display platform icons.(Will be faster)
	{{item|Beeswax|id=5019}}	With Item ID infomation
	{{item|Wooden Sword|showid=y}}	Auto Item ID.(only works for PC items)
	{{item|Pet Tiphia|id=204|type=buff}}	Other type of ID, in this case, Buff ID.
	{{item|Guide|id=22|type=npc}}	NPC ID.
	{{item|Confused|showid=y|type=buff}}	Auto Buff ID
	{{item|Beeswax|id=5019|anchor=y}}	Create an anchor. Now {{PAGENAME}}#Beeswax will link to here.

Size and scale

Result	Code	Note
	{{item|Beeswax}}	Default size, this image is 32px in height.
	{{item|Beeswax|size=16px}}	Custom absolute size.(x16px)
	{{item|Beeswax|size=*0.5}}	Custom scaled size.(x16px)
	{{item|Beeswax|size=x40px*0.5}}	Scaled absolute size.(x20px)
	{{item|Beeswax|scale=0.5}}	Scale. (x16px)
	{{item|Beeswax|size=40px*0.5|scale=2}}	combine scaled size and scale. (40px)
	{{item|Beeswax|maxsize=12px}}	maxsize
	{{item|Beeswax|maxsize=40px}}	maxsize, no effect
	{{item|Beeswax|maxsize=12x16px}}	maxsize
Template:Options/setTemplate:Options/reset	{{options/set|item|scale=0.5}}{{item|Beeswax}}{{options/reset|item}}	change scale via option.
Template:Options/setTemplate:Options/reset	{{options/set|item|scale=0.55}}{{item|Beeswax|size=*0.5}}{{options/reset|item}}	double scale.

Note: Due to the way of [[File:]]'s size option works, if you want to set a size (after scale) larger than origin image size, you need to set it in DDpx or DDxDDpx, and xDDpx will be no effect. e.g. for Beeswax, {{item|Beeswax|size=x40px}} will be no effect.

Multiple images

Result	Code	Note
	{{item|Furnace|image=Furnace.png/Furnace_(placed).gif}}	Multiple images with auto size.
	{{item|Furnace|image=Furnace.png/Furnace_(placed).gif|size=20px}}	Only one size specified, all images will use this size.
	{{item|Furnace|image=Furnace.png/Furnace_(placed).gif|size=30px/20px}}	Multiple images with multiple sizes.
	{{item|Furnace|image=Furnace.png/Furnace_(placed).gif|size=30px/20px/300px}}	Size is more than images, extra size is ignored.
	{{item|Furnace|image=Furnace.png/Furnace_(placed).gif/Hellforge.png|size=16px/50px}}	Size is less than image, extra image will use auto size.

Platform icons

Result	Code	Note
	{{item|Beeswax}}	Default behavior, generate platform icons from unnamed parameter 1.
	{{item|Beeswax|icons=no}}	Don't display platform icons.
	{{item|Beeswax|epage=Bee Minecart}}	Use Bee Minecart to generate platform icons.
	{{item|Beeswax|icons= {{eicons|1.4.0.1|3ds=y|small=y}} }}	Override platform icons.
	{{item|Beeswax| small=y | icons= {{eicons|1.4.0.1|3ds=y}} }}	Size setting of {{{{#rmatch:item|^#(\s*(\w+?)\s*)(:(.*)$|$)|#[[[:Template:Tl/parser function links]]##$2 $1]:$4|item}}{{#dplreplace:|/₪/	^#(\s*(\w+?)\s*)(:(.*)$|$)|#[[[:Template:Tl/parser function links]]##$2 $1]:$4|eicons}}{{#dplreplace:|/₪/	}}}} in {{{icons}}} input.
	{{item|Beeswax|icons= {{eicons|1.4.0.1|3ds=y|small=y}} }}

Wrap, id, note, note2 and bignote

wrap is valid only when id and note2 are not specified.

Result	Code	Note
	{{item|Beeswax|wrap=y}}	If there are platform icons and no note, platform icons will wrap to next line. note that platform icons are displayed in reduced size.
	{{item|bed|wrap=y|note=(some note)}}	If there are some note, note will wrap next line.
	{{item|Beeswax|wrap=y|note=(some note)}}	If there are some note, note will display in next line, and platform icons will display in same line.
	{{item|Beeswax|wrap=y|note=(some note)|id=234}}	If id is specified, note and eicons will displayed in same line, even if wrap=y.
	{{item|Beeswax|wrap=y|note2=some other notes.}}	note2 is similar.
	{{item|Beeswax|id=2384|note2=some other notes.}}	id and note2 will always take a single line.
	{{item|Beeswax||bignote=(BIG note)}} {{item|Beeswax|wrap=y|note=(some note)}}|bignote=(bignote)	Bignote will always be displayed after all other contents.

Display mode

Result	Code	Note
	{{item|Beeswax|id=2384}}	By default, it will display image and text info.
Template:Options/setTemplate:Options/set	{{options/set|item|mode=table}}{{item|Beeswax|mode=|id=2384}}{{options/set|item|mode=}}	Force to use default mode .
	{{item|Beeswax|mode=image|id=2384}}	mode=image: Only image will be displayed, no text, no note, no id, and no platform icons.
	{{item|Beeswax|mode=text|wrap=y|note=(some note)}}	mode=text: image won't be displayed.
	{| class="terraria lined" |{{item|Beeswax|mode=table}} |- |{{item|Butterfly|ies|note=(some note)|mode=table}} |}	mode=table: output as two adjacent cells for table.
text row 1 row 2	{| class="terraria lined" |{{item|Beeswax|mode=table}} || text |- |{{item|Butterfly|ies|note=(some note)|mode=table|rowspan=2}} || row 1 |- | row 2 |}	mode=table: rowspan
	{| class="terraria lined item-noborder" |{{item|Beeswax|mode=table}} |- |{{item|Butterfly|ies|note=(some note)|mode=table}} |}	table with "item-noborder" class: hide border between 2 cells.

Css and predefined classes

Result	Code	Note
	{{item|Beeswax|link=|id=2384|css=color:red;border: 2px solid blue;padding: 3px; background:#ccc}}	Custom css rules.
	{{item|Beeswax|id=2384|class=boldname}}	Predefined class: boldname, item name will displayed in bold.
	{{item|Beeswax|id=2384|note=note|note2=note2|class=notecolor}} {{item|Beeswax|id=2384|note=note|note2=note2|class=note2color}} {{item|Beeswax|id=2384|note=note|note2=note2|css=color:red|class=note2color}}	Predefined class: notecolor and note2color, note or note2 will display in normal(inherited) text color， respectively .
	{{item|Beeswax|id=2384|note=note|note2=note2|class=notecolor}} {{item|Beeswax|id=2384|note=note|note2=note2|class=note2color}}	Predefined class: notesize and note2size, note will display in normal size, or note2 will display in reduced size, respectively.
	{{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.
Template:TrTemplate:Options/getInternal Item ID: 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.
	{{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.
	<div style="width: 5em">{{item|Wall of Flesh|size=32px|class=break}}</div>	Wrap item name for long text when there is no enough space.

Transform

You can transform item image via these CSS classes.

The transformation happens at the center of the image and its effective dimensions will retain the original values of the object as if untransformed. So be careful with rotate90 and rotate270.

Result	Code
	{{item|guide}}
	{{item|guide|class=mirror}}
	{{item|guide|class=flip}}
	{{item|guide|class=rotate90}}
	{{item|guide|class=rotate180}}
	{{item|guide|class=rotate270}}

Change default options

Template:Options/autodoc

NOTE: In order to avoid unwanted influences, it is very important to restore options state as soon as possible, especially in the template. Use {{{{#rmatch:options/snap|^#(\s*(\w+?)\s*)(:(.*)$|$)|#[[[:Template:Tl/parser function links]]##$2 $1]:$4|options/snap}}{{#dplreplace:|/₪/||}}}} and {{{{#rmatch:options/restore|^#(\s*(\w+?)\s*)(:(.*)$|$)|#[[[:Template:Tl/parser function links]]##$2 $1]:$4|options/restore}}{{#dplreplace:|/₪/||}}}}

See examples below for more details.

Example

Code

output

By default: {{item|Beeswax|note=(note)}} turn off platform icons: {{options/set|item|icons=no}} {{item|Beeswax|note=(note)}} turn on platform icons, and turn on small icons: {{options/set|item|icons=y|smallicons=y}} {{item|Beeswax|note=(note)}} turn on line wrap, and set to text mode: {{options/set|item|wrap=y|mode=text}} {{item|Beeswax|note=(note)}} turn on no link mode: {{options/set|item|nolink=y}} {{item|Beeswax|note=(note)}} get current setting: nolink = {{options|item|nolink}} ; wrap = {{options|item|wrap}} ; mode = {{options|item|mode}} ; reset all options: {{options/reset|item}} {{item|Beeswax|note=(note)}} custom css and class: {{options/set|item|css=border:1px solid red;padding:3px}} {{item|Beeswax|note=(note)}} {{options/set|item|class=boldname}} {{item|Beeswax|note=(note)}} reset all: {{options/reset|item}} {{item|Beeswax|note=(note)}}

By default: turn off platform icons: Template:Options/set turn on platform icons, and turn on small icons: Template:Options/set turn on line wrap, and set to text mode: Template:Options/set turn on no link mode: Template:Options/set get current setting: nolink = Template:Options ; wrap = Template:Options ; mode = Template:Options ; reset all options: Template:Options/reset custom css and class: Template:Options/set Template:Options/set reset all: Template:Options/reset

About Translation

{{{{#rmatch:item|^#(\s*(\w+?)\s*)(:(.*)$|$)|#[[[:Template:Tl/parser function links]]##$2 $1]:$4|item}}{{#dplreplace:|/₪/||}}}} is i18n-ready and integrated automatic translation. When translate to other language, It may not require any edit, auto translation will get things done, for example:

Code	On English Page	On Italian Page
{{item|Golden Chest}}

if there is still English text, or you want to modify display text, please keep unnamed parameter 1 untouched({{{{#rmatch:item|^#(\s*(\w+?)\s*)(:(.*)$|$)|#[[[:Template:Tl/parser function links]]##$2 $1]:$4|item}}{{#dplreplace:|/₪/||}}}} will handle the image and link target), and change unnamed parameter 2, for example:

On English Page	On Italian Page	Wrong usage
{{item|Copper Ore|Ore}}: (links to Copper Ore)	{{item|Copper Ore|Minerale}}: (links to Copper Ore/it)	{{item|Minerale di rame}}: {{item|Minerale di rame|Minerale}}: (image and link are broken.)