Module:List/doc

This module outputs various kinds of lists. At present, it supports bulleted lists, unbulleted lists, horizontal lists, numbered lists, and horizontal numbered lists.

Usage

Quick usage

{{#invoke:list|function|first item|second item|third item|...}}

All parameters

{{#invoke:list|function
|first item|second item|third item|...
|class       = class
|style       = style
|list_style  = style for the list tag
|item_style  = style for all list item tags
|item_style1 = style for the first list item tag |item_style2 = style for the second list item tag |...
|start       = start number for numbered lists
|type        = type of numbering for numbered lists
}}

Arguments passed from parent template

{{#invoke:list|function}}

Functions

Function name	Produces	Example output
bulleted	Bulleted lists	First item Second item Third item
unbulleted	Unbulleted lists	First item Second item Third item
horizontal	Horizontal bulleted lists	First item Second item Third item
numbered	Numbered lists
horizontal_numbered	Horizontal numbered lists

Parameters

• Positional parameters (1, 2, 3...) - these are the list items. If no list items are present, the module will output nothing.
• class - a custom class for the <div>...</div> tags surrounding the list, e.g. plainlinks.
• style - a custom css style for the <div>...</div> tags surrounding the list, e.g. font-size: 90%;.
• list_style - a custom css style for the list itself. The format is the same as for the |style= parameter. ul_style is an alias for this parameter, included for backwards compatibility.
• item_style - a custom css style for all of the list items (the <li>...</li> tags). The format is the same as for the |style= parameter. li_style is an alias for this parameter, included for backwards compatibility.
• item_style1, item_style2, item_style3... - custom css styles for each of the list items. The format is the same as for the |style= parameter. The li_style1, li_style2 li_style3 ... parameters are aliases for these parameters, included for backwards compatibility.
• indent - this parameter indents the list, for horizontal and horizontal numbered lists only. The value must be a number, e.g. 2. The indent is calculated in em, and is 1.6 times the value specified. If no indent is specified, the default is zero.
• start - sets the start number for numbered lists. This is also supported in theory for horizontal numbered lists, but in practice, as of November 2013, this does not work due to lack of browswer support.
• type - the type of numbering for numbered lists. Possible values are "1" for numbers (the default), "A" for uppercase letters, "a" for lowercase letters, "I" for uppercase Roman numerals, and "i" for lowercase Roman numerals. This is also supported in theory for horizontal numbered lists, but in practice, as of November 2013, this does not work due to lack of browswer support.

Examples

Unbulleted lists

Code	Result
{{#invoke:unbulleted list|unbulleted|entry1|entry2|entry3|entry4|entry5|entry6|entry7|entry8|entry9}}
{{#invoke:unbulleted list|unbulleted|Winner|Runner-up|Third place|li_style=color:blue;}}
{{#invoke:unbulleted list|unbulleted|Winner|Runner-up|Third place|li_style1=background-color:yellow;|li_style2=background-color:silver;}}

Horizontal lists

Code	Result
{{#invoke:unbulleted list|hlist|entry1|entry2|entry3|entry4|entry5|entry6|entry7|entry8|entry9}}
{{#invoke:unbulleted list|hlist|Winner|Runner-up|Third place|li_style=color:blue;}}
{{#invoke:unbulleted list|hlist|Winner|Runner-up|Third place|li_style=color:blue;|indent=2}}
{{#invoke:unbulleted list|hlist|Winner|Runner-up|Third place|li_style1=background-color:yellow;|li_style2=background-color:silver;}}