Module:Wp/wal/List/doc
Appearance
This is the documentation page for Module:Wp/wal/List
TemplateStyles' src
attribute must not be empty.
This Lua module is used in MediaWiki:Citethispage-content. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid major disruption, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them. |
Error: {{Wp/wal/Module rating}} must be placed in the Module namespace. Lua error in package.lua at line 80: module 'Module:List' not found.
TemplateStyles' src
attribute must not be empty.
This module uses TemplateStyles: |
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
[edit source]Quick usage
[edit source]All parameters
[edit source]Arguments passed from parent template
[edit source]Functions
[edit source]Function name | Produces | Example output | Template using the function |
---|---|---|---|
bulleted
|
Bulleted lists | Script error: No such module "list". | Script error: No such module "Template link general". |
unbulleted
|
Unbulleted lists | Script error: No such module "Wp/wal/list". | Script error: No such module "Template link general". |
horizontal
|
Horizontal bulleted lists | Script error: No such module "Wp/wal/list". | Script error: No such module "Template link general". |
ordered
|
Ordered lists (numbered lists and alphabetical lists) | Script error: No such module "Wp/wal/list". | Script error: No such module "Template link general". |
horizontal_ordered
|
Horizontal ordered lists | Script error: No such module "Wp/wal/list". | Script error: No such module "Template link general". |
Parameters
[edit source]- 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 Template:Para 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 Template:Wp/wal/para parameter.item1_style
,item2_style
,item3_style
... - custom css styles for each of the list items. The format is the same as for the Template:Wp/wal/para 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
[edit source]Bulleted lists
[edit source]Code | Result |
---|---|
{{#invoke:list|bulleted|First item|Second item|Third item}}
|
Script error: No such module "list". |
{{#invoke:list|bulleted|First item|Second item|Third item|item_style=color:blue;}}
|
Script error: No such module "list". |
{{#invoke:list|bulleted|First item|Second item|Third item|item1_style=background-color:yellow;|item2_style=background-color:silver;}}
|
|
Unbulleted lists
[edit source]Code | Result |
---|---|
{{#invoke:list|unbulleted|First item|Second item|Third item}}
|
Script error: No such module "list". |
{{#invoke:list|unbulleted|First item|Second item|Third item|item_style=color:blue;}}
|
Script error: No such module "list". |
{{#invoke:list|unbulleted|First item|Second item|Third item|item1_style=background-color:yellow;|item2_style=background-color:silver;}}
|
Script error: No such module "list". |
Horizontal lists
[edit source]Code | Result |
---|---|
{{#invoke:list|horizontal|First item|Second item|Third item}}
|
Script error: No such module "list". |
{{#invoke:list|horizontal|First item|Second item|Third item|indent=2}}
|
Script error: No such module "list". |
Ordered lists
[edit source]Code | Result |
---|---|
{{#invoke:list|ordered|First item|Second item|Third item}}
|
Script error: No such module "list". |
{{#invoke:list|ordered|First item|Second item|Third item|start=3}}
|
Script error: No such module "list". |
Lowercase Roman numerals: {{#invoke:list|ordered|First item|Second item|Third item|type=i}}
|
Script error: No such module "list". |
Lowercase Greek alphabet: {{#invoke:list|ordered|First item|Second item|Third item|list_style_type=lower-greek}}
|
Script error: No such module "list". |
Horizontal ordered lists
[edit source]Code | Result |
---|---|
{{#invoke:list|horizontal_ordered|First item|Second item|Third item}}
|
Script error: No such module "list". |
{{#invoke:list|horizontal_ordered|First item|Second item|Third item|start=3}}
|
Script error: No such module "list". |
{{#invoke:list|horizontal_ordered|First item|Second item|Third item|indent=2}}
|
Script error: No such module "Wp/wal/list". |
Tracking/maintenance category
[edit source]See also
[edit source]