Difference between revisions of "Template:Icon"

From Project: Gorgon Wiki
Jump to: navigation, search
(Documentation of usage of the "label" parameter.)
(Documentation.)
Line 16: Line 16:
 
}}]]<noinclude>
 
}}]]<noinclude>
 
__NOTOC__
 
__NOTOC__
==Syntax==
+
==Usage==
 
<pre>
 
<pre>
 +
{{icon|<name>}}
 
{{icon|<name>|size=16px}}
 
{{icon|<name>|size=16px}}
 +
{{icon|<name>|label=<full item name>}}
 +
{{icon|<name>|size=16px|label=<full item name>}}
 
</pre>
 
</pre>
  

Revision as of 18:11, 29 October 2014

{{{1}}}

Usage

{{icon|<name>}}
{{icon|<name>|size=16px}}
{{icon|<name>|label=<full item name>}}
{{icon|<name>|size=16px|label=<full item name>}}

Description

Create an item icon with a mouseover tooltip that shows the full item name.

The template code does the following:

  • Makes certain icons link to relevant article instead of the "File history" page (eg. Saltpeter).
  • Substitute certain icons during alpha, when several items use the same icon (eg. lemon uses banana icon), this is important so that the wiki article is specifying the proper icons. If/when these items get a unique icon, only the substitution in the template needs to be removed.
  • Adds a mouseover tooltip effect that display the full name of the item.
  • The capitalized icon name is the item name by default, which saves providing a separate item name for simple one-word items (eg. "banana" > "Banana").
  • Automatically provides a long name for common icons, eg. "water" => "Bottle of Water", which reduces code in the article.

Parameters

parameter 1
Name of the icon. See Item Icons Guide for available icons (eg. "firstaid"). If not provided, an empty box is shown.
size
OPTIONAL. Changes the size of the icon (default is 32px).
label
OPTIONAL. Specify the image title, which also becomes a mouseover tooltip. Use this for long item names where the capitalized icon name does not match, and for items that use the same icon so the tooltip shows the correct item name (eg. "Advanced Holistic Ink" and "Basic Holistic Ink" which use the same icon).

Examples

Default 32x32px icon. By default the capitalized icon name becomes the tooltip: "lemon" => "Lemon".

{{icon|lemon}}

Smaller inline icon.

{{icon|saltpeter|size=16px}}

Provide the full name for items that have similar looking icons with label parameter.

{{icon|genericpot|label=Advanced Holistic Ink}}