23,539
edits→Examples
(fix doc) |
|||
(9 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
<includeonly>''This text is transcluded from [[Template: | <includeonly>''This text is transcluded from [[Template:Item icon/doc]].''</includeonly> | ||
<div class="bg3wiki-tooltip-box">{{Center|{{ItemIcon|name=Bex's handmade cookies|show_name=t|show_rarity=t}}}}</div> | |||
This template fetches and displays an icon for an item. The information is uploaded using the standard item descriptions. Use [[Template:ItemIcon Insert]] to add a page that doesn't use [[Template:MiscItemPage]], [[Template:EquipmentPage]], or [[Template:WeaponPage]]. | This template fetches and displays an icon for an item. The information is uploaded using the standard item descriptions. Use [[Template:ItemIcon Insert]] to add a page that doesn't use [[Template:MiscItemPage]], [[Template:EquipmentPage]], or [[Template:WeaponPage]]. | ||
Line 5: | Line 6: | ||
Usage: <pre>{{ItemIcon | Usage: <pre>{{ItemIcon | ||
|name=the name of the icon page | |name=the name of the icon page | ||
|uid=(optional) If specified, will search for this UID instead of the page name. | |||
|size=(optional) the size of the icon | |size=(optional) the size of the icon | ||
|show_name=(optional) Whether to show the name. Any value will show the name of the item as a link. Omit to hide it. | |show_name=(optional) Whether to show the name. Any value will show the name of the item as a link. Omit to hide it. | ||
Line 12: | Line 14: | ||
|override_rarity=(optional) When specified with '''override_icon''', will set the rarity of the displayed item. | |override_rarity=(optional) When specified with '''override_icon''', will set the rarity of the displayed item. | ||
|alias=(optional) If specified, the link text will be this instead. | |alias=(optional) If specified, the link text will be this instead. | ||
| | |nowrap=(optional) If specified, the text will not wrap. | ||
}}</pre> | }}</pre> | ||
Line 29: | Line 31: | ||
{{ItemIcon/Example|Potion of Supreme Healing|40||}} | {{ItemIcon/Example|Potion of Supreme Healing|40||}} | ||
{{ItemIcon/Example|Potion of Supreme Healing|25||}} | {{ItemIcon/Example|Potion of Supreme Healing|25||}} | ||
{{ItemIcon/Example|The Red Knight's Final | {{ItemIcon/Example|The Red Knight's Final Strategem|40||}} | ||
{{ItemIcon/Example|The Red Knight's Final | {{ItemIcon/Example|The Red Knight's Final Strategem|25||}} | ||
{{ItemIcon/ExampleDivider|Linked icon}} | {{ItemIcon/ExampleDivider|Linked icon}} | ||
Line 37: | Line 39: | ||
{{ItemIcon/Example|Potion of Supreme Healing|40|true|}} | {{ItemIcon/Example|Potion of Supreme Healing|40|true|}} | ||
{{ItemIcon/Example|Potion of Supreme Healing|25|true|}} | {{ItemIcon/Example|Potion of Supreme Healing|25|true|}} | ||
{{ItemIcon/Example|The Red Knight's Final | {{ItemIcon/Example|The Red Knight's Final Strategem|40|true|}} | ||
{{ItemIcon/Example|The Red Knight's Final | {{ItemIcon/Example|The Red Knight's Final Strategem|25|true|}} | ||
{{ItemIcon/ExampleDivider|Rarity icon}} | {{ItemIcon/ExampleDivider|Rarity icon}} | ||
Line 45: | Line 47: | ||
{{ItemIcon/Example|Potion of Supreme Healing|40|true|true}} | {{ItemIcon/Example|Potion of Supreme Healing|40|true|true}} | ||
{{ItemIcon/Example|Potion of Supreme Healing|25|true|true}} | {{ItemIcon/Example|Potion of Supreme Healing|25|true|true}} | ||
{{ItemIcon/Example|The Red Knight's Final | {{ItemIcon/Example|The Red Knight's Final Strategem|40|true|true}} | ||
{{ItemIcon/Example|The Red Knight's Final | {{ItemIcon/Example|The Red Knight's Final Strategem|25|true|true}} | ||
{{ItemIcon/ExampleDivider|Other}} | {{ItemIcon/ExampleDivider|Other}} | ||
Line 63: | Line 65: | ||
=== Wrap override === | === Wrap override === | ||
{{ItemIcon|name=A is for Azuth and other Gods II|nowrap=true|show_name=true}}{{ItemIcon|name=A is for Azuth and other Gods II|nowrap=true|show_name=true}}{{ItemIcon|name=A is for Azuth and other Gods II|nowrap=true|show_name=true}}{{ItemIcon|name=A is for Azuth and other Gods II|nowrap=true|show_name=true}}{{ItemIcon|name=A is for Azuth and other Gods II|nowrap=true|show_name=true}}{{ItemIcon|name=A is for Azuth and other Gods II|nowrap=true|show_name=true}}{{ItemIcon|name=A is for Azuth and other Gods II|nowrap=true|show_name=true}} | {{ItemIcon|name=A is for Azuth, and other Gods II|nowrap=true|show_name=true}}{{ItemIcon|name=A is for Azuth, and other Gods II|nowrap=true|show_name=true}}{{ItemIcon|name=A is for Azuth, and other Gods II|nowrap=true|show_name=true}}{{ItemIcon|name=A is for Azuth, and other Gods II|nowrap=true|show_name=true}}{{ItemIcon|name=A is for Azuth, and other Gods II|nowrap=true|show_name=true}}{{ItemIcon|name=A is for Azuth, and other Gods II|nowrap=true|show_name=true}}{{ItemIcon|name=A is for Azuth, and other Gods II|nowrap=true|show_name=true}} | ||
=== UID search === | |||
Specifying the {{C|uid}} parameter allows for picking a specific item among a number of different items with the same name. Note that you {{strong|must}} provide the name of the item for it to display properly. | |||
<pre>* {{ItemIcon|name=Leather Armour|show_name=true}} | |||
* {{ItemIcon|name=Leather Armour|uid=ARM_Leather_Rogue|show_name=true}} | |||
* {{ItemIcon|name=Leather Armour|uid=UNI_Leather_Jaheira|show_name=true}}</pre> | |||
* {{ItemIcon|name=Leather Armour|show_name=true}} | |||
* {{ItemIcon|name=Leather Armour|uid=ARM_Leather_Rogue|show_name=true}} | |||
* {{ItemIcon|name=Leather Armour|uid=UNI_Leather_Jaheira|show_name=true}} | |||
== Related templates == | == Related templates == | ||
Line 74: | Line 86: | ||
* Check that the page exists | * Check that the page exists | ||
: The page must exist and use [[Template:MiscItemPage]], [[Template:EquipmentPage]], [[Template:WeaponPage]], or [[Template:ItemIcon Insert]]. Technically, you could also insert directly into the <code>item_icon</code> Cargo table, but please don't do that without good reason. | : The page must exist and use [[Template:MiscItemPage]], [[Template:EquipmentPage]], [[Template:WeaponPage]], or [[Template:ItemIcon Insert]]. Technically, you could also insert directly into the <code>item_icon</code> Cargo table, but please don't do that without good reason. | ||
: Also make sure that the item is spelled correctly. '''ItemIcon''' is unaware of redirects, which can cause a missing icon link when the page link works fine. | |||
* Check that the parameters are passed to the page-generating templates | * Check that the parameters are passed to the page-generating templates | ||
: '''ItemIcon''' pulls from the page-generating template parameters, particularly <code>rarity</code>, <code>image</code>, and <code>icon</code>. Either <code>image</code> or <code>icon</code> needs to be set for an icon to show. | : '''ItemIcon''' pulls from the page-generating template parameters, particularly <code>rarity</code>, <code>image</code>, and <code>icon</code>. Either <code>image</code> or <code>icon</code> needs to be set for an icon to show. |