Template:Icon list/doc

This is the documentation page for Icon list. It contains usage information, categories, and other content not part of the original template page.
Main	Documentation	Usage

This template uses Module:Icon list (edit|hist), a script written in Lua.

Creates a list of {{Icon}}.

Syntax

• 1 — List of items.
  • *amount — Indicate amount exclusive to the item.
  • /quality — Indicate quality exclusive to the item.
  • »note — Indicate note exclusive to the item.
  • { param1 = value1 $ param2 = value2 $ value 3 } — indicate parameters exclusive to the item, allows unnamed parameters.
• list — Include to render as bullet list in the form of <ul><li>icon1</li><li>icon2</li><li>icon3</li><li>icon4</li></ul>
• inline — Include to render icons all inline in the form of icon1 icon2 icon3 icon4.
• inline_list — Include to render icons all inline, with delimiter in sentence form of icon1, icon2, icon3 and icon4.
• delim — Delimiter of the list in 1. Default ,.
• amount_delim — Delimiter of amount in 1. Default *.
• quality_delim — Delimiter of the quality in 1. Default /.
• note_delim — Delimiter of the notes in 1. Default ».
• param_delim — Delimiter of the parameters in 1. Default $.
• The following arguments of {{Icon}} can be set to apply to all items by including them as normal parameters.
  • text
  • size
  • x or amount or 2
  • quality
  • ext

Examples

{{Icon list|Golden pearl;Pink diamond;Rainbow wool|notext = 1}} yields:
File:Golden pearl.pngFile:Golden pearl.pngFile:Rainbow wool.pngFile:Rainbow wool.png
{{Icon list|Carrot;Okra*3;hot pepper/1|inline_list = 1|p4 = nolink=1}} yields:
 Carrot Okra × 3 hot pepper

Template Data

Creates a list of {{Icon}}.

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Input List	1	"delim" delimited list of items. Within each item, delimited by "amount_delim", "note_delim", and "param_delim".	String	required
Default amount	amount x 2	Default amount of items if not stated, unformatted Example 12	Number	optional
Input delimiter	delim	Character(s) to split input items by. Default , Example ;	String	optional
Amount delimiter	amount_delim	Character(s) to separate item name from amount. Default *	String	optional
Note delimiter	quality_delim	Character(s) to separate item from quality. Default /	String	optional
Parameter delimiter	param_delim	Character(s) to split item from Icon parameters. Default $	String	optional
Note delimiter	note_delim	Character(s) to separate item from note.	Unknown	optional
Size	size	Default icon size Default 30 Example 35	Number	optional