Template:Img item/doc: Difference between revisions

Latest revision as of 14:07, 14 April 2024

This is a documentation subpage for Template:Img item.
It contains usage information and other content that is not part of the original template page.

The {{Img item}} template is used to generate an item image by simply knowing the display name or item ID.

Editing

To add new definitions or edit an existing one, please go to the following subpages:

Img item/icon - for the icon
Img item/link - for the link
Img item/name - for the name

Usage

{{Img item
|item = <!-- or {{{1}}} (first anonymous parameter) -->
|size = <!-- optional -->
|icon = <!-- or |img = --> <!-- optional -->
|link = <!-- optional -->
|name = <!-- optional -->
}}

Parameters

item: Determines the item image, name, and link. Can be the item's display name, item ID (without module) or previous names (so long as there are no conflicts). Can be replaced with the first anonymous parameter. Default: File:image.png
size: The size of the image. This can be left blank unless needed to be customized. Default: 32px
icon: Manually set the image to be displayed. This will normally be left blank. Can be replaced with img.
link: Manually set the link for the image. This will normally be left blank.
name: Manually set the "name" to show when hovering over. This will normally be left blank.

Anonymous parameters

See more: Anonymous parameters
{{{1}}}: Alternative to item, for simplified markup. Determines the item image, name, and link. Can be the item's display name, item ID (without module) or previous names (so long as there are no conflicts). Default: File:image.png
{{{2}}}: Adding "name" will remove the image and only display the name and link. Alternative to using {{Img item/link}} and {{Img item/name}}.

Examples

Type	Produces	Explanation
{{Img item\|item=ShotgunShellsBox\|size=32px}}		Using the item ID with the item and size parameters.
{{Img item\|ShotgunShellsBox}}		The markup can be simplified by removing the item and size parameters, and just including the item ID as the first anonymous parameter. This produces the same result as the above example.
{{Img item\|icon=Chainsaw_Model\|size=64px\|name=Zombie slayer\|link=Zombie}}		The icon, size, name and link can be manually adjusted. Here it's showing the Chainsaw model as the icon at size 64px, "Zombie slayer" as the name, and Zombie as the link.
{{Img item\|ShotgunShellsBox\|name}}	Box of Shotgun Shells	Using just the first and second anonymous parameters, with the second being "name", display just the indexed name and link.

@@ Line 1: / Line 1: @@
 {{Documentation subpage}}
 The {{tlx|Img item}} template is used to generate an item image by simply knowing the display name or item ID.
 ==Editing==
@@ Line 21: / Line 21: @@
 ;item: Determines the item image, name, and link. Can be the item's display name, item ID (without module) or previous names (so long as there are no conflicts). Can be replaced with the first [[#Anonymous parameters|anonymous parameter]]. ''Default: [[:File:image.png]]''
 ;size: The size of the image. This can be left blank unless needed to be customized. ''Default: 32px''
 ;icon: Manually set the image to be displayed. This will normally be left blank. Can be replaced with '''img'''.
 ;link: Manually set the link for the image. This will normally be left blank.
 ;name: Manually set the "name" to show when hovering over. This will normally be left blank.
@@ Line 38: / Line 38: @@
 |<pre>{{Img item|item=ShotgunShellsBox|size=32px}}</pre>
 |{{Img item|item=ShotgunShellsBox|size=32px}}
 |Using the item ID with the '''item''' and '''size''' parameters.
 |-
 |<pre>{{Img item|ShotgunShellsBox}}</pre>
 |{{Img item|ShotgunShellsBox}}
 |The markup can be simplified by removing the '''item''' and '''size''' parameters, and just including the item ID as the first [[#Anonymous parameters|anonymous parameter]]. This produces the same result as the above example.
 |-
 |<pre>{{Img item|icon=Chainsaw_Model|size=64px|name=Zombie slayer|link=Zombie}}</pre>
 |{{Img item|icon=Chainsaw_Model|size=64px|name=Zombie slayer|link=Zombie}}
 |The '''icon''', '''size''', '''name''' and '''link''' can be manually adjusted. Here it's showing the [[Chainsaw]] model as the '''icon''' at '''size''' 64px, "Zombie slayer" as the '''name''', and [[Zombies]] as the '''link'''.
 |-
 |<pre>{{Img item|ShotgunShellsBox|name}}</pre>
 |{{Img item|ShotgunShellsBox|name}}
 |Using just the '''first''' and '''second''' [[#Anonymous parameters|anonymous parameters]], with the '''second''' being "name", display just the indexed name and link.
 |}