Module:List/doc

This module outputs various kinds of lists. At present, it supports bulleted lists, unbulleted lists, horizontal lists, ordered lists, and horizontal ordered 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 ordered lists
|type        = type of numbering for ordered 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
ordered	Ordered lists (numbered lists and alphabetical lists)	First item Second item Third item
horizontal_ordered	Horizontal ordered lists	First item Second item Third item

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 ordered 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 item for ordered lists. This can be a start number for numbered lists, or a start letter for alphabetical lists. This parameter is also supported in theory for horizontal ordered lists, but in practice, as of November 2013, it does not work due to lack of browser support.
• type - the type of marker used in ordered 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 ordered lists, but in practice, as of November 2013, this does not work due to lack of browser support.

Examples

Bulleted lists

Code	Result
{{#invoke:list|bulleted|First item|Second item|Third item}}	First item Second item Third item
{{#invoke:list|bulleted|First item|Second item|Third item|li_style=color:blue;}}	First item Second item Third item
{{#invoke:list|bulleted|First item|Second item|Third item|li_style1=background-color:yellow;|li_style2=background-color:silver;}}	First item Second item Third item

Unbulleted lists

Code	Result
{{#invoke:list|unbulleted|First item|Second item|Third item}}	First item Second item Third item
{{#invoke:list|unbulleted|First item|Second item|Third item|li_style=color:blue;}}	First item Second item Third item
{{#invoke:list|unbulleted|First item|Second item|Third item|li_style1=background-color:yellow;|li_style2=background-color:silver;}}	First item Second item Third item

Horizontal lists

Code	Result
{{#invoke:list|horizontal|First item|Second item|Third item}}	First item Second item Third item
{{#invoke:list|horizontal|First item|Second item|Third item|indent=2}}	First item Second item Third item

Unbulleted lists

Code	Result
{{#invoke:list|unbulleted|First item|Second item|Third item}}	First item Second item Third item
{{#invoke:list|unbulleted|First item|Second item|Third item|li_style=color:blue;}}	First item Second item Third item
{{#invoke:list|unbulleted|First item|Second item|Third item|li_style1=background-color:yellow;|li_style2=background-color:silver;}}	First item Second item Third item

Ordered lists

Code	Result
{{#invoke:list|ordered|First item|Second item|Third item}}	First item Second item Third item
{{#invoke:list|ordered|First item|Second item|Third item|start=3}}	First item Second item Third item
{{#invoke:list|ordered|First item|Second item|Third item|type=i}	First item Second item Third item

Horizontal ordered lists

Code	Result
{{#invoke:list|horizontal_ordered|First item|Second item|Third item}}	First item Second item Third item
{{#invoke:list|horizontal_ordered|First item|Second item|Third item|indent=2}}	First item Second item Third item