Module:List/doc
< Module:List
Revision as of 22:44, 13 November 2013 by Mr. Stradivarius (talk) (create, based on Module:Unbulleted list/doc, which itself is based on Template:Unbulleted list/doc)
This is the documentation page for Module:List
40x40px | This module is rated as beta, and is ready for widespread use. It is still new and should be used with some caution to ensure the results are as expected. |
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 |
|
unbulleted
|
Unbulleted lists |
|
horizontal
|
Horizontal bulleted lists |
|
numbered
|
Numbered lists | Script error: The function "numbered" does not exist. |
horizontal_numbered
|
Horizontal numbered lists | Script error: The function "horizontal_numbered" does not exist. |
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%;
. -
ul_style
- a custom css style for the<ul>...</ul>
tags around the list. The format is the same as for the|style=
parameter. -
li_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_style1
,li_style2
,li_style3
... - custom css styles for each of the list items. The format is the same as for the|style=
parameter. -
indent
- for horizontal lists only, this parameter indents the list. 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
- Unbulleted lists
Code | Result |
---|---|
{{#invoke:unbulleted list|unbulleted|entry1|entry2|entry3|entry4|entry5|entry6|entry7|entry8|entry9}}
|
Script error: No such module "unbulleted list". |
{{#invoke:unbulleted list|unbulleted|Winner|Runner-up|Third place|li_style=color:blue;}}
|
Script error: No such module "unbulleted list". |
{{#invoke:unbulleted list|unbulleted|Winner|Runner-up|Third place|li_style1=background-color:yellow;|li_style2=background-color:silver;}}
|
Script error: No such module "unbulleted list". |
- Horizontal lists
Code | Result |
---|---|
{{#invoke:unbulleted list|hlist|entry1|entry2|entry3|entry4|entry5|entry6|entry7|entry8|entry9}}
|
Script error: No such module "unbulleted list". |
{{#invoke:unbulleted list|hlist|Winner|Runner-up|Third place|li_style=color:blue;}}
|
Script error: No such module "unbulleted list". |
{{#invoke:unbulleted list|hlist|Winner|Runner-up|Third place|li_style=color:blue;|indent=2}}
|
Script error: No such module "unbulleted list". |
{{#invoke:unbulleted list|hlist|Winner|Runner-up|Third place|li_style1=background-color:yellow;|li_style2=background-color:silver;}}
|
Script error: No such module "unbulleted list". |