Module:List/doc

This module outputs various kinds of lists. At present, it supports bulleted lists, unbulleted lists, horizontal lists, ordered lists (numbered or alphabetical), and horizontal ordered lists. It allows for easy css styling of the list or of the individual list items.

Usage

Quick usage

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

All parameters

{{#invoke:list|''function''
|''first item''|''second item''|''third item''|...
|start           = ''start number for ordered lists''
|type            = ''type of numbering for ordered lists''
|list_style_type = ''type of marker for ordered lists (uses CSS)''
|class           = ''class''
|style           = ''style''
|list_style      = ''style for the list''
|item_style      = ''style for all list items''
|item1_style     = ''style for the first list item'' |item2_style = ''style for the second list item'' |...
|item1_value     = ''value for the first list item'' |item2_value = ''value for the second list item'' |...
|indent          = ''indent for horizontal lists''
}}

Arguments passed from parent template

{{#invoke:list|''function''}}

Functions

Function name	Produces	Example output	Template using the function
bulleted	Bulleted lists	First item Second item Third item	Template:Tlx
unbulleted	Unbulleted lists	First item Second item Third item	Template:Tlx
horizontal	Horizontal bulleted lists	First item Second item Third item	Template:Tlx
ordered	Ordered lists (numbered lists and alphabetical lists)	First item Second item Third item	Template:Tlx
horizontal_ordered	Horizontal ordered lists	First item Second item Third item

Parameters

Positional parameters (|1=, |2=, |3=, etc.) 

These are the list items. If no list items are present, the module will output nothing.

|start= 

Sets the start item for ordered lists. This can be a start number for numbered lists, or a start letter for alphabetical lists. Horizontal ordered lists only support numbers.

|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. Not supported in horizontal ordered lists. See also the |list_style_type= parameter.

|list_style_type= 

The type of marker used in ordered lists. This uses CSS styling, and has more types available than the |type= parameter, which uses an HTML attribute. Possible values are listed at MDN's list-style-type page. Support may vary by browser. list-style-type is an alias for this parameter.

|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.

|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.

|item1_style=, |item2_style=, |item3_style=, etc. 

Custom CSS styles for each of the list items. The format is the same as for the |style= parameter.

|item1_value=, |item2_value=, |item3_value=, etc. 

Custom value for the given list item. List items following the one given will increment from the specified value. The value should be a positive integer. (Note that this option only has an effect on ordered lists.)

|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.

Examples

Bulleted lists

Markup	Renders as
{{#invoke:list|bulleted|First item|Second item|Third item}}	First item Second item Third item
{{#invoke:list|bulleted|First item|Second item|Third item|item_style=color:blue;}}	First item Second item Third item
{{#invoke:list|bulleted|First item|Second item|Third item|item1_style=background-color:yellow;|item2_style=background-color:silver;}}	First item Second item Third item

Unbulleted lists

Markup	Renders as
{{#invoke:list|unbulleted|First item|Second item|Third item}}	First item Second item Third item
{{#invoke:list|unbulleted|First item|Second item|Third item|item_style=color:blue;}}	First item Second item Third item
{{#invoke:list|unbulleted|First item|Second item|Third item|item1_style=background-color:yellow;|item2_style=background-color:silver;}}	First item Second item Third item

Horizontal lists

Markup	Renders as
{{#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

Ordered lists

Markup	Renders as
{{#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
{{#invoke:list|ordered|First item|Second item|Third item|list_style_type=lower-greek}}	First item Second item Third item

Horizontal ordered lists

Markup	Renders as
{{#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|start=3}}	First item Second item Third item
{{#invoke:list|horizontal_ordered|First item|Second item|Third item|indent=2}}	First item Second item Third item