Template:Iconbar/doc

Documentation

[purge]

This template uses Module:Iconbar, a script written in the Lua programming language. Please see wp:Lua and mw:Extension:Scribunto to learn more about Lua.

This template creates a bar made of icons.

{{iconbar
|value=
|title=
|size=
|full=
|half=
|empty=
|reverse=
|total=
}}

Parameter	Function	Default value
value	Integer value between 0 and 20. One "full" icon is shown for each increase of 2 to value (e.g. three are shown if value is 6 or 7, etc.), and if value is odd, a "half" icon is shown at the end of the bar.	0
title	Mouseover text. If this parameter isn't specified, it falls back to value.	None
size	Width of each icon in CSS units like "px" or "em". Units default to "px".	None
full	"Full" icon. One of these is shown for each increase of 2 to value (e.g. three are shown if value is 6 or 7, etc.).	None
half	"Half" icon, used at the end of the bar if value is odd.	None
empty	"Empty" icon, used if value is 0 or if total is used and is higher than value.	None
reverse	Pass a value to display the "half" icon on the left end of the bar instead of the right.
total	Minimum number of icons to be shown. If value is lower than this, empty icons are shown to reach the minimum.	None

See also

• {{Armorbar}}
• {{Healthbar}}
• {{Hungerbar}}
• {{Iconbar}}
• Module:Iconbar

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.