Template:Infobox item/doc: Difference between revisions

From Modded Wiki
Jump to navigation Jump to search
No edit summary
 
(21 intermediate revisions by 11 users not shown)
Line 1: Line 1:
{{Documentation header}}
{{Documentation header}}
{{lua|Infobox}}
 
{{Item}}
This template provides a uniform design for usable item pages.
This template provides a uniform design for usable item pages. When an item immediately restores health on right click, it is recommended to use [[Template:Food]] instead. The parameter list below needs updating due to recent changes to infobox parameter standards.
<pre style="display:table">
<pre width="30px">
{{Item
{{Item
|title=
| title =
|image=
| image =
|imagesize=
| image2 =
|image2=
| image3 =
|image2size=
<!-- Start Multiple mode -->
|image3=
| group =
|image3size=
| 1-1 =
|invimage=
| 1-2 =
|invimage2=
| 1-3 =
|invimage3=
| group2 =  
|otherosonly=
| 2-1 =  
|durability=
| 2-2 =  
|renewable=
| 2-3 =  
|stackable=
| group3 =  
|availability=
| 3-1 =  
|firstver=
| 3-2 =  
|firstdev=
| 3-3 =  
|data=
| group4 =  
|nameid=  
| 4-1 =  
|notes=
| 4-2 =  
| 4-3 =  
<!-- End Multiple mode -->
| durability =  
| rarity =  
| renewable =  
| stackable =  
| heals =  
| effects =  
}}</pre>
}}</pre>


Please note that if the item has multiple data values, document these in the dedicated ID section of the page. See below:
See below:


{| class="wikitable"
{| class="wikitable"
Line 36: Line 43:
| <code>title</code> || Optional value to use a different title 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 block (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>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>imagesize</code> || Adjusts the size of the image || 160px
| <code>image''N''</code> || Other images for multi-state items || ''None''
|-
|-
| <code>image2</code> || Image of the block (should be approx. 160x160px) || ''None''
| <code>rarity</code> || The color of this item's name. See [[rarity]] for more info. || Common
|-
|-
| <code>image2size</code> || Adjusts the size of the second image || 160px
| <code>durability</code> || How durable the item is || ''None''
|-
|-
| <code>image3</code> || Image of the block (should be approx. 160x160px) || ''None''
| <code>renewable</code> || Whether the item is [[Renewable Resources|renewable]] || ?
|-
|-
| <code>image3size</code> || Adjusts the size of the third image || 160px
| <code>stackable</code> || Stackable || ?
|-
|-
| <code>invimage</code> || Image for object in inventory. Can use '''None''' to force no invimage.  Uses [[Template:Grid]]. || <code><nowiki>Grid {{{title}}}.png</nowiki></code> if it exists, otherwise ''None''
| <code>heals</code> || Amount of hunger points restored || ''None''
|-
|-
| <code>invimage2</code> || Second image for two-state objects in inventory. <br> Uses [[Template:Grid]]. || ''None''
| <code>effects</code> || Status effects given when consumed || ''None''
|-
|-
| <code>invimage3</code> || Third image for three-state objects in inventory. <br> Uses [[Template:Grid]]. || ''None''
! Parameter (multiple mode only)
|-
! Function
| <code>invimage4</code> || Fourth image for four-state objects in inventory. <br> Uses [[Template:Grid]]. || ''None''
! Default/Example value
|-
| <code>invimage5</code> || Fifth image for five-state objects in inventory. <br> Uses [[Template:Grid]]. || ''None''
|-
| <code>invimage6</code> || Sixth image for six-state objects in inventory. <br> Uses [[Template:Grid]]. || ''None''
|-
| <code>invimage7</code> || Seventh image for seven-state objects in inventory. <br> Uses [[Template:Grid]]. || ''None''
|-
| <code>invimage8</code> || Eighth image for eight-state objects in inventory. <br> Uses [[Template:Grid]]. || ''None''
|-
| <code>invimage9</code> || Ninth image for nine-state objects in inventory. <br> Uses [[Template:Grid]]. || ''None''
|-
| <code>invimage10</code> || Tenth image for ten-state objects in inventory. <br> Uses [[Template:Grid]]. || ''None''
|-
| <code>invimage11</code> || Eleventh image for eleven-state objects in inventory. <br> Uses [[Template:Grid]]. || ''None''
|-
| <code>invimage12</code> || Twelfth image for twelve-state objects in inventory. <br> Uses [[Template:Grid]]. || ''None''
|-
| <code>invimage13</code> || Thirteenth image for thirteen-state objects in inventory. <br> Uses [[Template:Grid]]. || ''None''
|-
| <code>invimage14</code> || Fourteenth image for fourteen-state objects in inventory. <br> Uses [[Template:Grid]]. || ''None''
|-
| <code>invimage15</code> || Fifteenth image for fifteen-state objects in inventory. <br> Uses [[Template:Grid]]. || ''None''
|-
| <code>invimage16</code> || Sixteenth image for sixteen-state objects in inventory. <br> Uses [[Template:Grid]]. || ''None''
|-
| <code>invimage17</code> || Seventeenth image for seventeen-state objects in inventory. <br> Uses [[Template:Grid]]. || ''None''
|-
| <code>invimage18</code> || Eighteenth image for eighteen-state objects in inventory. <br> Uses [[Template:Grid]]. || ''None''
|-
| <code>invimage19</code> || Nineteenth image for nineteen-state objects in inventory. <br> Uses [[Template:Grid]]. || ''None''
|-
| <code>invimage20</code> || Twentieth image for twenty-state objects in inventory. <br> Uses [[Template:Grid]]. || ''None''
|-
| <code>invimage21</code> || Twenty-First image for twenty-one-state objects in inventory. <br> Uses [[Template:Grid]]. || ''None''
|-
| <code>invimage22</code> || Twenty-Second image for twenty-two-state objects in inventory. <br> Uses [[Template:Grid]]. || ''None''
|-
| <code>invimage23</code> || Twenty-Third image for twenty-three-state objects in inventory. <br> Uses [[Template:Grid]]. || ''None''
|-
| <code>invimage24</code> || Twenty-Forth image for twenty-four-state objects in inventory. <br> Uses [[Template:Grid]]. || ''None''
|-
| <code>invimage25</code> || Twenty-Fifth image for twenty-five-state objects in inventory. <br> Uses [[Template:Grid]]. || ''None''
|-
| <code>otherosonly</code> || For use if the item is only available in a specific version of Minecraft.  || ''None''
|-
| <code>durability</code> || How durable the item is || N/A
|-
| <code>renewable</code> || Whether the item is [[Renewable Resources|renewable]] || ?
|-
| <code>stackable</code> || Stackable || ?
|-
| <code>availability </code> || The availability of an item || ?
|-
|-
| <code>firstver</code> || First version that it was seen in (e.g. Alpha v1.0.17, classic 0.0.23a).  || ''None''
| {{cd|multiple}} || Whether to enter multiple mode. In this mode, multiple images can be present under the same tab. || 0
|-
|-
| <code>firstdev</code> || First development snapshot it was seen in, requires firstver. || ''None''
| {{cd|group}} || Group (tab) under which to put the image || ''None''
|-
|-
| <code>data</code> || Single decimal data value || ''None''
| {{cd|group''N''}} || Other tabs present || ''None''
|-
|-
| <code>nameid</code> || The item's named identifier. Can use '''None''' to force no name ID. || <code>title</code> or <code><nowiki>{{BASEPAGENAME}}</nowiki></code>
| {{cd|1-''n''}} || ''n''th image under the first (default) tab || ''None''
|-
|-
| <code>multipledata</code> || Multiple decimal data values, use {{tl|dv}} || ''None''
| {{cd|''N''-''n''}} || ''n''th image under the ''N''th tab || ''None''
|}
|}


Line 125: Line 80:
[[Category:Infobox templates|I]]
[[Category:Infobox templates|I]]


[[cs:Šablona:Item]]
[[de:Vorlage:Gegenstand]]
[[de:Vorlage:Gegenstand]]
[[es:Plantilla:Objeto]]
[[fr:Modèle:Objet]]
[[fr:Modèle:Objet]]
[[it:Template:Oggetto]]
[[it:Template:Oggetto]]
[[ja:テンプレート:Item]]
[[ja:テンプレート:Item]]
[[nl:Sjabloon:Voorwerp]]
[[nl:Sjabloon:Voorwerp]]
[[pl:Szablon:Przedmiot]]
[[pt:Predefinição:Item]]
[[pt:Predefinição:Item]]
[[ru:Шаблон:Предмет]]
[[ru:Шаблон:Предмет]]
[[uk:Шаблон:Предмет]]
[[zh:Template:Item]]
[[zh:Template:Item]]
</includeonly>
</includeonly>
<noinclude>
<noinclude>
<!-- Documentation categories/interwiki here -->
<!-- Documentation categories/interwiki here -->
[[cs:Šablona:Item/doc]]
[[de:Vorlage:Gegenstand/Dokumentation]]
[[de:Vorlage:Gegenstand/Dokumentation]]
[[es:Plantilla:Objeto/doc]]
[[fr:Modèle:Objet/doc]]
[[fr:Modèle:Objet/doc]]
[[ja:テンプレート:Item/doc]]
[[ja:テンプレート:Item/doc]]
[[nl:Sjabloon:Voorwerp/doc]]
[[nl:Sjabloon:Voorwerp/doc]]
[[pl:Szablon:Przedmiot/opis]]
[[pt:Predefinição:Item/doc]]
[[pt:Predefinição:Item/doc]]
[[ru:Шаблон:Предмет/док]]
[[ru:Шаблон:Предмет/док]]
[[uk:Шаблон:Предмет/док]]
</noinclude>
</noinclude>

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

See also

Minecraft
Minecraft Earth
Minecraft Dungeons
Minecraft Legends
Minecraft Story Mode
Other
Meta


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:Шаблон:Предмет/док