Template:Infobox item/doc: Difference between revisions

Latest revision as of 15:39, 25 May 2024

This is the documentation page. It should be transcluded into Template:Infobox item. See Template:Documentation for more information.

This template provides a uniform design for usable item pages.

{{Item
| title =
| image =
| image2 = 
| image3 = 
<!-- Start Multiple mode --> 
| group = 
| 1-1 = 
| 1-2 = 
| 1-3 = 
| group2 = 
| 2-1 = 
| 2-2 = 
| 2-3 = 
| group3 = 
| 3-1 = 
| 3-2 = 
| 3-3 = 
| group4 = 
| 4-1 = 
| 4-2 = 
| 4-3 = 
<!-- End Multiple mode -->
| durability = 
| rarity = 
| renewable = 
| stackable = 
| heals = 
| effects = 
}}

See below:

Parameter	Function	Default/Example value
`title`	Optional value to use a different title instead of the page name	`{{BASEPAGENAME}}`
`image`	Image of the item (should be approx. 160x160px)	`{{{title}}}.png` if it exists, otherwise No image.svg (linking to the page where to upload the missing image)
`imageN`	Other images for multi-state items	None
`rarity`	The color of this item's name. See rarity for more info.	Common
`durability`	How durable the item is	None
`renewable`	Whether the item is renewable	?
`stackable`	Stackable	?
`heals`	Amount of hunger points restored	None
`effects`	Status effects given when consumed	None
Parameter (multiple mode only)	Function	Default/Example value
`multiple`	Whether to enter multiple mode. In this mode, multiple images can be present under the same tab.	0
`group`	Group (tab) under which to put the image	None
`groupN`	Other tabs present	None
`1-n`	nth image under the first (default) tab	None
`N-n`	nth image under the Nth tab	None

@@ Line 1: / Line 1: @@
-{{doc/start|clear}}
+{{Documentation header}}
-This template provides a uniform design for usable item pages. When an item restores health, it is recommended to use [[Template:Food]] instead. <pre>
+This template provides a uniform design for usable item pages.
+<pre style="display:table">
 {{Item
-|name=
+| title =
-|image=
+| image =
-|invimage=
+| image2 =
-|type=
+| image3 =
-|durability=
+<!-- Start Multiple mode -->
-|stackable=
+| group =
-|data=
+| 1-1 =
+| 1-2 =
+| 1-3 =
+| group2 =
+| 2-1 =
+| 2-2 =
+| 2-3 =
+| group3 =
+| 3-1 =
+| 3-2 =
+| 3-3 =
+| group4 =
+| 4-1 =
+| 4-2 =
+| 4-3 =
+<!-- End Multiple mode -->
+| durability =
+| rarity =
+| renewable =
+| stackable =
+| heals =
+| effects =
 }}</pre>
-Please note that if the item has multiple data values, use <code><nowiki>|multipledata=</nowiki></code> instead. See below:
+See below:
-{| class=grid style="background-color: transparent;"
+{| class="wikitable"
 ! Parameter
 ! Function
 ! Default/Example value
 |-
-| <code>name</code> || Optional value to use a different name instead of the page name || <code><nowiki>{{BASEPAGENAME}}</nowiki></code>
+| <code>title</code> || Optional value to use a different title instead of the page name || <code><nowiki>{{BASEPAGENAME}}</nowiki></code>
 |-
-| <code>image</code> || Image of the item (Should be 150x150px) || [[:File:No image.png|No image.png]]
+| <code>image</code> || Image of the item (should be approx. 160x160px) || <code><nowiki>{{{title}}}.png</nowiki></code> if it exists, otherwise [[:File:No image.svg|No image.svg]] (linking to the page where to upload the missing image)
 |-
-| <code>invimage</code> || Image for object in inventory (Should be 36x36px) || ''None''
+| <code>image''N''</code> || Other images for multi-state items || ''None''
 |-
-| <code>type</code> || Type (Weapon, Ranged Weapon, Craftable Item, Tool, etc. ) || ?
+| <code>rarity</code> || The color of this item's name. See [[rarity]] for more info. || Common
 |-
-| <code>durability</code> || How durable the item is || N/A
+| <code>durability</code> || How durable the item is || ''None''
+|-
+| <code>renewable</code> || Whether the item is [[Renewable Resources|renewable]] || ?
 |-
 | <code>stackable</code> || Stackable || ?
 |-
-| <code>data</code> || Single decimal data value || ''None''
+| <code>heals</code> || Amount of hunger points restored || ''None''
+|-
+| <code>effects</code> || Status effects given when consumed || ''None''
 |-
-| <code>multipledata</code> || Multiple decimal data values, use {{tl|dv}} || ''None''
+! Parameter (multiple mode only)
+! Function
+! Default/Example value
+|-
+| {{cd|multiple}} || Whether to enter multiple mode. In this mode, multiple images can be present under the same tab. || 0
+|-
+| {{cd|group}} || Group (tab) under which to put the image || ''None''
+|-
+| {{cd|group''N''}} || Other tabs present || ''None''
+|-
+| {{cd|1-''n''}} || ''n''th image under the first (default) tab || ''None''
+|-
+| {{cd|''N''-''n''}} || ''n''th image under the ''N''th tab || ''None''
 |}
 == See also ==
 {{Infobox see also}}
-{{doc/end}}
+<includeonly>
+<!-- Template categories/interwiki here -->
+[[Category:Infobox templates|I]]
+[[cs:Šablona:Item]]
+[[de:Vorlage:Gegenstand]]
+[[es:Plantilla:Objeto]]
+[[fr:Modèle:Objet]]
+[[it:Template:Oggetto]]
+[[ja:テンプレート:Item]]
+[[nl:Sjabloon:Voorwerp]]
+[[pl:Szablon:Przedmiot]]
+[[pt:Predefinição:Item]]
+[[ru:Шаблон:Предмет]]
+[[uk:Шаблон:Предмет]]
+[[zh:Template:Item]]
+</includeonly>
+<noinclude>
+<!-- Documentation categories/interwiki here -->
+[[cs:Šablona:Item/doc]]
+[[de:Vorlage:Gegenstand/Dokumentation]]
+[[es:Plantilla:Objeto/doc]]
+[[fr:Modèle:Objet/doc]]
+[[ja:テンプレート:Item/doc]]
+[[nl:Sjabloon:Voorwerp/doc]]
+[[pl:Szablon:Przedmiot/opis]]
+[[pt:Predefinição:Item/doc]]
+[[ru:Шаблон:Предмет/док]]
+[[uk:Шаблон:Предмет/док]]
+</noinclude>

Template:Infobox item/doc: Difference between revisions

Latest revision as of 15:39, 25 May 2024

See also

Navigation menu

Search