Difference between revisions of "Template:I-slot"

From Mine Blocks Wiki
Jump to navigation Jump to search
If you find a typo, inconsistency, or error, please sign up and help out the wiki! We can't do it without your help! :D Thank you!
Line 1: Line 1:
−
<span class="minetip invslot-item" {{#if: {{{minetip-title|}}}|data-minetip-title="{{{minetip-title|}}}" }} {{#if: {{{minnetip-text|}}}|data-minetip-text="{{{minetip-text|}}}"}}>[[File:{{{1|Invisible-sprite}}}.png|16x16px|class=item-icon pixel {{{4}}}|link={{{2|{{{1}}}}}}|{{{3|{{{1}}}}}}]]</span><noinclude>
+
<span class="minetip invslot-item" {{#if: {{{minetip-title|}}}|data-minetip-title="{{{minetip-title|{{{name}}}}}}" }} {{#if: {{{minnetip-text|}}}|data-minetip-text="{{{minetip-text|}}}"}}>[[File:{{{name|Invisible-sprite}}}.png|{{{size|16}}}x{{{size|16}}}px|class=item-icon pixel {{{class|}}}|link={{{item-link|{{{name}}}}}}|{{{tooltip|{{{name}}}}}}]]</span><noinclude>
 
== About ==
 
== About ==
 
This templated (named '''I-slot''' as a shortcut for '''item-slot''') serves as an easy method to add icon sprites that are inside of a in-game slot, with tooltip included with the item's name and/or with extra info.
 
This templated (named '''I-slot''' as a shortcut for '''item-slot''') serves as an easy method to add icon sprites that are inside of a in-game slot, with tooltip included with the item's name and/or with extra info.
Line 7: Line 7:
 
<pre><nowiki>
 
<pre><nowiki>
 
{{I-slot
 
{{I-slot
−
|<file-name>
+
|name = <file-name>
−
|<item-link>?
+
|link = <item-link>
−
|<tooltip-text>?
+
|size = <file-size> (width and height at the same time)
−
|<file-class>?
+
|class = <file-class>
−
|<tooltip-title>
+
|tooltip = <default-tooltip-text>
−
|<tooltip-text>
+
|tooltip-title = <mb-tooltip-title>
 +
|tooltip-text = <mb-tooltip-text>
 
}}
 
}}
 
</nowiki></pre>. Note tht <code>tooltip-title</code> and <code>tooltip-text</code> are mandatory for the tooltip to work. In case you don't need <code>tooltip-text</code>, you can mention the parameter and leave it empty. <code>tooltip-title</code> defaults to the first parameter (<code>file-name</code>)'s text if it's not used.
 
</nowiki></pre>. Note tht <code>tooltip-title</code> and <code>tooltip-text</code> are mandatory for the tooltip to work. In case you don't need <code>tooltip-text</code>, you can mention the parameter and leave it empty. <code>tooltip-title</code> defaults to the first parameter (<code>file-name</code>)'s text if it's not used.
 +
 +
{| class="wikitable"
 +
! Parameter
 +
! Function
 +
! Value type
 +
! Default value
 +
! Status
 +
|-
 +
! <code>name</code>
 +
| It's the item's name. It's mainly used for the image name. No format is needed to specify.
 +
| String
 +
| Invisible-sprite
 +
| Recommended
 +
|-
 +
! <code>link</code>
 +
| Icon's link.
 +
| Wikitext
 +
| <code>name</code>'s value
 +
| Optional
 +
|-
 +
! <code>size</code>
 +
| Icon's size (both width and height share the same value to keep the image fully squared).
 +
| Integer
 +
| 16
 +
| Optional
 +
|-
 +
! <code>class</code>
 +
| Icon's extra classes.
 +
| String
 +
| None
 +
| Optional
 +
|-
 +
! <code>tooltip</code>
 +
| Icon's default tooltip text. It's automatically removed if the Mine Blocks-themed tooltip isbeing used (see below).
 +
| String
 +
| <code>name</code>'s value
 +
| Optional
 +
|-
 +
! <code>tooltip-title</code>
 +
| Icon's Mine Block tooltip title.
 +
| String
 +
| <code>name</code>'s value
 +
| Optional
 +
|-
 +
! <code>tooltip-text</code>
 +
| Icon's Mine Block tooltip text. Use the forward slash (<code>/</code>) as line breaks.
 +
| String
 +
| None
 +
| Optional.<br>Mandatory if <code>tooltip-title</code> is being used
 +
|}
  
 
== Examples ==
 
== Examples ==
−
* <code><nowiki>{{I-slot|Wooden Planks|tooltip-title}}</nowiki></nowiki></code> → {{I-slot|Wooden Planks}}
+
* Name: <code><nowiki>{{I-slot|name=Wooden Planks}}</nowiki></code> → {{I-slot|name=Wooden Planks}}
−
* <code><nowiki>{{I-slot|Wooden Planks|Cow}}</nowiki></nowiki></code> → {{I-slot|Wooden Planks|Cow}}
+
* Name and link: <code><nowiki>{{I-slot|name=Wooden Planks|link=Cow}}</nowiki></code> → {{I-slot|name=Wooden Planks|link=Cow}}
−
* <code><nowiki>{{I-slot|Wooden Planks|Cow|Tooltip text.}}</nowiki></nowiki></code> → {{I-slot|Wooden Planks|Cow|Tooltip text.}}
+
* Name, link, and size: <code><nowiki>{{I-slot|name=Wooden Planks|link=Cow|size=24}}</nowiki></code> → {{I-slot|name=Wooden Planks|link=Cow|size=24}}
 +
* Name, link, size, and icon class: <code><nowiki>{{I-slot|name=Wooden Planks|link=Cow|size=24|class=thumb-class}}</nowiki></code> → {{I-slot|name=Wooden Planks|link=Cow|size=24|class=thumb-class}}
 +
* Name, link, size, icon class, and default tooltip text: <code><nowiki>{{I-slot|name=Wooden Planks|link=Cow|size=24|class=thumb-class|tooltip=Default tooltip text.}}</nowiki></code> → {{I-slot|name=Wooden Planks|link=Cow|size=24|class=thumb-class|tooltip=Default tooltip text.}}
 +
* Name, link, size, icon class, default tooltip text, and empty mb tooltip title: <code><nowiki>{{I-slot|name=Wooden Planks|link=Cow|size=24|class=thumb-class|tooltip=Default tooltip text.|tooltip-title=}}</nowiki></code> → {{I-slot|name=Wooden Planks|link=Cow|size=24|class=thumb-class|tooltip=Default tooltip text.|tooltip-title=}}
 +
* Name, link, size, icon class, default tooltip text, and mb tooltip title with custom text: <code><nowiki>{{I-slot|name=Wooden Planks|link=Cow|size=24|class=thumb-class|tooltip=Default tooltip text.|tooltip-title=Lorem ipsum}}</nowiki></code> → {{I-slot|name=Wooden Planks|link=Cow|size=24|class=thumb-class|tooltip=Default tooltip text.|tooltip-title=Lorem ipsum}}
 +
* Name, link, size, icon class, default tooltip text, and empty mb tooltip text: <code><nowiki>{{I-slot|name=Wooden Planks|link=Cow|size=24|class=thumb-class|tooltip=Default tooltip text.|tooltip-text=}}</nowiki></code> → {{I-slot|name=Wooden Planks|link=Cow|size=24|class=thumb-class|tooltip=Default tooltip text.|tooltip-text=}}
 +
* Name, link, size, icon class, default tooltip text, and mb tooltip with custom text: <code><nowiki>{{I-slot|name=Wooden Planks|link=Cow|size=24|class=thumb-class|tooltip=Default tooltip text.|tooltip-text=Dolor sit amet.}}</nowiki></code> → {{I-slot|name=Wooden Planks|link=Cow|size=24|class=thumb-class|tooltip=Default tooltip text.|tooltip-text=Dolor sit amet.}}
 +
* Name, link, size, icon class, default tooltip text, mb tooltip title with custom text, and mb tooltip with custom text: <code><nowiki>{{I-slot|name=Wooden Planks|link=Cow|size=24|class=thumb-class|tooltip=Default tooltip text.|tooltip-title=Lorem ipsum|tooltip-text=Dolor sit amet.}}</nowiki></code> → {{I-slot|name=Wooden Planks|link=Cow|size=24|class=thumb-class|tooltip=Default tooltip text.|tooltip-title=Lorem ipsum|tooltip-text=Dolor sit amet.}}
 +
 
 +
== Note ==
 +
Despite the default tooltip being removed if the custom mb tooltip is being used, it's recommended to also use it since it will display as a fallback in case the user has disabled their JavaScript.
 
</noinclude>
 
</noinclude>

Revision as of 11:26, 18 December 2021

{{{name}}}

About

This templated (named I-slot as a shortcut for item-slot) serves as an easy method to add icon sprites that are inside of a in-game slot, with tooltip included with the item's name and/or with extra info.

Usage

The syntax of the template is: 

{{I-slot
|name = <file-name>
|link = <item-link>
|size = <file-size> (width and height at the same time)
|class = <file-class>
|tooltip = <default-tooltip-text>
|tooltip-title = <mb-tooltip-title>
|tooltip-text = <mb-tooltip-text>
}}

. Note tht tooltip-title and tooltip-text are mandatory for the tooltip to work. In case you don't need tooltip-text, you can mention the parameter and leave it empty. tooltip-title defaults to the first parameter (file-name)'s text if it's not used.

Parameter Function Value type Default value Status
name It's the item's name. It's mainly used for the image name. No format is needed to specify. String Invisible-sprite Recommended
link Icon's link. Wikitext name's value Optional
size Icon's size (both width and height share the same value to keep the image fully squared). Integer 16 Optional
class Icon's extra classes. String None Optional
tooltip Icon's default tooltip text. It's automatically removed if the Mine Blocks-themed tooltip isbeing used (see below). String name's value Optional
tooltip-title Icon's Mine Block tooltip title. String name's value Optional
tooltip-text Icon's Mine Block tooltip text. Use the forward slash (/) as line breaks. String None Optional.
Mandatory if tooltip-title is being used

Examples

  • Name: {{I-slot|name=Wooden Planks}} → Wooden Planks
  • Name and link: {{I-slot|name=Wooden Planks|link=Cow}} → Wooden Planks
  • Name, link, and size: {{I-slot|name=Wooden Planks|link=Cow|size=24}} → Wooden Planks
  • Name, link, size, and icon class: {{I-slot|name=Wooden Planks|link=Cow|size=24|class=thumb-class}} → Wooden Planks
  • Name, link, size, icon class, and default tooltip text: {{I-slot|name=Wooden Planks|link=Cow|size=24|class=thumb-class|tooltip=Default tooltip text.}} → Default tooltip text.
  • Name, link, size, icon class, default tooltip text, and empty mb tooltip title: {{I-slot|name=Wooden Planks|link=Cow|size=24|class=thumb-class|tooltip=Default tooltip text.|tooltip-title=}} → Default tooltip text.
  • Name, link, size, icon class, default tooltip text, and mb tooltip title with custom text: {{I-slot|name=Wooden Planks|link=Cow|size=24|class=thumb-class|tooltip=Default tooltip text.|tooltip-title=Lorem ipsum}} → Default tooltip text.
  • Name, link, size, icon class, default tooltip text, and empty mb tooltip text: {{I-slot|name=Wooden Planks|link=Cow|size=24|class=thumb-class|tooltip=Default tooltip text.|tooltip-text=}} → Default tooltip text.
  • Name, link, size, icon class, default tooltip text, and mb tooltip with custom text: {{I-slot|name=Wooden Planks|link=Cow|size=24|class=thumb-class|tooltip=Default tooltip text.|tooltip-text=Dolor sit amet.}} → Default tooltip text.
  • Name, link, size, icon class, default tooltip text, mb tooltip title with custom text, and mb tooltip with custom text: {{I-slot|name=Wooden Planks|link=Cow|size=24|class=thumb-class|tooltip=Default tooltip text.|tooltip-title=Lorem ipsum|tooltip-text=Dolor sit amet.}} → Default tooltip text.

Note

Despite the default tooltip being removed if the custom mb tooltip is being used, it's recommended to also use it since it will display as a fallback in case the user has disabled their JavaScript.

Retrieved from "https://mineblocks.com/1/wiki/index.php?title=Template:I-slot&oldid=25938"