# 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  

; All parameters  

; Arguments passed from parent template  

; Functions  

| Function name | Produces | Example output | Template using the function |
| --- | --- | --- | --- |
| <code>bulleted</code> | Bulleted lists |  |  |
| <code>unbulleted</code> | Unbulleted lists |  |  |
| <code>horizontal</code> | Horizontal bulleted lists |  |  |
| <code>ordered</code> | Ordered lists (numbered lists and alphabetical lists) |  |  |
| <code>horizontal_ordered</code> | Horizontal ordered lists | } |  |

## Parameters

- Positional parameters (<code>1</code>, <code>2</code>, <code>3</code>...) - these are the list items. If no list items are present, the module will output nothing.
- <code>start</code> - 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.
- <code>type</code> - 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 <code>list_style_type</code> parameter.
- <code>list_style_type</code> - the type of marker used in ordered lists. This uses CSS styling, and has more types available than the <code>type</code> parameter, which uses an html attribute. Possible values are listed at W3schools' list-style-type page. Support may vary by browser. <code>list-style-type</code> is an alias for this parameter.
- <code>class</code> - a custom class for the tags surrounding the list, e.g. <code>plainlinks</code>.
- <code>style</code> - a custom css style for the tags surrounding the list, e.g. <code>font-size: 90%;</code>.
- <code>list_style</code> - a custom css style for the list itself. The format is the same as for the parameter.
- <code>item_style</code> - a custom css style for all of the list items (the tags). The format is the same as for the parameter.
- <code>item1_style</code>, <code>item2_style</code>, <code>item3_style</code>... - custom css styles for each of the list items. The format is the same as for the parameter.
- <code>item1_value</code>, <code>item2_value</code>, <code>item3_value</code>... - 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.)
- <code>indent</code> - this parameter indents the list, for horizontal and horizontal ordered lists only. The value must be a number, e.g. <code>2</code>. 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  

**<code></code>**

| <code></code> | } |
| --- | --- |

; Unbulleted lists  

**<code></code>**

| <code></code> | } |
| --- | --- |

; Horizontal lists  

**<code></code>**

| <code></code> | } |
| --- | --- |

; Unbulleted lists  

**<code></code>**

| <code></code> | } |
| --- | --- |

; Ordered lists  

**<code></code>**

| <code></code> | } |
| --- | --- |

; Horizontal ordered lists  

**<code></code>**

| <code></code> | } |
| --- | --- |

## Tracking/maintenance category
- :Category:List templates with deprecated parameters