Module:List/doc
Jump to navigation
Jump to search
This is the documentation page for Module:List
40x40px | This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
This template uses Module:TableTools, a script written in the Lua programming language. Please see Wikipedia:Lua if you want to learn more about Lua or help convert other templates. |
Lua error in package.lua at line 80: module 'Module:TNT' not found.
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 |
---|---|---|---|
bulleted
|
Bulleted lists |
|
{{bulleted list}} |
unbulleted
|
Unbulleted lists | Page Template:Plainlist/styles.css has no content.
|
{{unbulleted list}} |
horizontal
|
Horizontal bulleted lists | Page Template:Hlist/styles.css has no content.
|
{{hlist}} |
ordered
|
Ordered lists (numbered lists and alphabetical lists) |
|
{{ordered list}} |
horizontal_ordered
|
Horizontal ordered lists | Page Template:Hlist/styles.css has no content.
|
{{horizontal ordered list}} |
Parameters
- Positional parameters (
1
,2
,3
...) - 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 thelist_style_type
parameter.list_style_type
- the type of marker used in ordered lists. This uses CSS styling, and has more types available than thetype
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
... - 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
... - 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
Code | Result |
---|---|
{{#invoke:list|bulleted|First item|Second item|Third item}}
|
|
{{#invoke:list|bulleted|First item|Second item|Third item|item_style=color:blue;}}
|
|
{{#invoke:list|bulleted|First item|Second item|Third item|item1_style=background-color:yellow;|item2_style=background-color:silver;}}
|
|
Unbulleted lists
Code | Result |
---|---|
{{#invoke:list|unbulleted|First item|Second item|Third item}}
|
Page Template:Plainlist/styles.css has no content.
|
{{#invoke:list|unbulleted|First item|Second item|Third item|item_style=color:blue;}}
|
Page Template:Plainlist/styles.css has no content.
|
{{#invoke:list|unbulleted|First item|Second item|Third item|item1_style=background-color:yellow;|item2_style=background-color:silver;}}
|
Page Template:Plainlist/styles.css has no content.
|
Horizontal lists
Code | Result |
---|---|
{{#invoke:list|horizontal|First item|Second item|Third item}}
|
Page Template:Hlist/styles.css has no content.
|
{{#invoke:list|horizontal|First item|Second item|Third item|indent=2}}
|
Page Template:Hlist/styles.css has no content.
|
Ordered lists
Code | Result |
---|---|
{{#invoke:list|ordered|First item|Second item|Third item}}
|
|
{{#invoke:list|ordered|First item|Second item|Third item|start=3}}
|
|
Lowercase Roman numerals: {{#invoke:list|ordered|First item|Second item|Third item|type=i}}
|
|
Lowercase Greek alphabet: {{#invoke:list|ordered|First item|Second item|Third item|list_style_type=lower-greek}}
|
|
Horizontal ordered lists
Code | Result |
---|---|
{{#invoke:list|horizontal_ordered|First item|Second item|Third item}}
|
Page Template:Hlist/styles.css has no content.
|
{{#invoke:list|horizontal_ordered|First item|Second item|Third item|start=3}}
|
Page Template:Hlist/styles.css has no content.
|
{{#invoke:list|horizontal_ordered|First item|Second item|Third item|indent=2}}
|
Page Template:Hlist/styles.css has no content.
|
Tracking/maintenance category
See also