imported>Oetterer |
|||
Zeile 1: | Zeile 1: | ||
{{documentation subpage}} | {{documentation subpage}} | ||
− | {{module rating| | + | {{module rating|protected}} |
+ | {{Lua|Module:TableTools|Module:Arguments}} | ||
+ | {{Uses TemplateStyles|Module:List/styles.css}} | ||
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. | 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. | ||
Zeile 6: | Zeile 8: | ||
== Usage == | == Usage == | ||
− | + | === Quick usage === | |
− | |||
{{pre2|<nowiki>{{</nowiki>#invoke:list<nowiki>|</nowiki>''function''<nowiki>|</nowiki>''first item''<nowiki>|</nowiki>''second item''<nowiki>|</nowiki>''third item''<nowiki>|</nowiki>...<nowiki>}}</nowiki>}} | {{pre2|<nowiki>{{</nowiki>#invoke:list<nowiki>|</nowiki>''function''<nowiki>|</nowiki>''first item''<nowiki>|</nowiki>''second item''<nowiki>|</nowiki>''third item''<nowiki>|</nowiki>...<nowiki>}}</nowiki>}} | ||
− | + | === All parameters === | |
− | + | {{pre| | |
− | {{ | ||
<nowiki>{{</nowiki>#invoke:list<nowiki>|</nowiki>''function'' | <nowiki>{{</nowiki>#invoke:list<nowiki>|</nowiki>''function'' | ||
<nowiki>|</nowiki>''first item''<nowiki>|</nowiki>''second item''<nowiki>|</nowiki>''third item''<nowiki>|</nowiki>... | <nowiki>|</nowiki>''first item''<nowiki>|</nowiki>''second item''<nowiki>|</nowiki>''third item''<nowiki>|</nowiki>... | ||
Zeile 28: | Zeile 28: | ||
}} | }} | ||
− | + | === Arguments passed from parent template === | |
− | + | {{pre|<nowiki>{{</nowiki>#invoke:list<nowiki>|</nowiki>''function''<nowiki>}}</nowiki>}} | |
− | < | ||
− | {{#invoke:list|function}} | ||
− | </ | ||
− | |||
− | |||
+ | === Functions === | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
Zeile 41: | Zeile 37: | ||
! Produces | ! Produces | ||
! Example output | ! Example output | ||
+ | ! Template using the function | ||
|- | |- | ||
| <code>bulleted</code> | | <code>bulleted</code> | ||
| Bulleted lists | | Bulleted lists | ||
| {{#invoke:list|bulleted|First item|Second item|Third item}} | | {{#invoke:list|bulleted|First item|Second item|Third item}} | ||
+ | | {{tlx|bulleted list}} | ||
|- | |- | ||
| <code>unbulleted</code> | | <code>unbulleted</code> | ||
| Unbulleted lists | | Unbulleted lists | ||
| {{#invoke:list|unbulleted|First item|Second item|Third item}} | | {{#invoke:list|unbulleted|First item|Second item|Third item}} | ||
+ | | {{tlx|unbulleted list}} | ||
|- | |- | ||
| <code>horizontal</code> | | <code>horizontal</code> | ||
| Horizontal bulleted lists | | Horizontal bulleted lists | ||
| {{#invoke:list|horizontal|First item|Second item|Third item}} | | {{#invoke:list|horizontal|First item|Second item|Third item}} | ||
+ | | {{tlx|hlist}} | ||
|- | |- | ||
| <code>ordered</code> | | <code>ordered</code> | ||
| Ordered lists (numbered lists and alphabetical lists) | | Ordered lists (numbered lists and alphabetical lists) | ||
| {{#invoke:list|ordered|First item|Second item|Third item}} | | {{#invoke:list|ordered|First item|Second item|Third item}} | ||
+ | | {{tlx|ordered list}} | ||
|- | |- | ||
| <code>horizontal_ordered</code> | | <code>horizontal_ordered</code> | ||
| Horizontal ordered lists | | Horizontal ordered lists | ||
| {{#invoke:list|horizontal_ordered|First item|Second item|Third item}} | | {{#invoke:list|horizontal_ordered|First item|Second item|Third item}} | ||
+ | | {{tlx|horizontal ordered list}} | ||
|} | |} | ||
== Parameters == | == 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. | * 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>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 [[wpen:Roman numerals]], and "i" for lowercase Roman numerals. Not supported in horizontal ordered lists. See also the <code>list_style_type</code> parameter. | * <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 [[wpen: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 [[wpen:html attribute]]. Possible values are listed at [ | + | * <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 [[wpen:html attribute]]. Possible values are listed at [https://developer.mozilla.org/en-US/docs/Web/CSS/list-style-type MDN's 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 {{tag|div}} tags surrounding the list, e.g. <code>plainlinks</code>. | * <code>class</code> - a custom class for the {{tag|div}} tags surrounding the list, e.g. <code>plainlinks</code>. | ||
* <code>style</code> - a custom css style for the {{tag|div}} tags surrounding the list, e.g. <code>font-size: 90%;</code>. | * <code>style</code> - a custom css style for the {{tag|div}} tags surrounding the list, e.g. <code>font-size: 90%;</code>. | ||
Zeile 79: | Zeile 80: | ||
== Examples == | == Examples == | ||
− | + | === Bulleted lists === | |
− | |||
{| class="wikitable" | {| class="wikitable" | ||
! Code !! Result | ! Code !! Result | ||
Zeile 94: | Zeile 94: | ||
|} | |} | ||
− | + | === Unbulleted lists === | |
− | |||
{| class="wikitable" | {| class="wikitable" | ||
! Code !! Result | ! Code !! Result | ||
Zeile 109: | Zeile 108: | ||
|} | |} | ||
− | + | === Horizontal lists === | |
− | |||
{| class="wikitable" | {| class="wikitable" | ||
! Code !! Result | ! Code !! Result | ||
Zeile 121: | Zeile 119: | ||
|} | |} | ||
− | + | === Ordered lists === | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
{| class="wikitable" | {| class="wikitable" | ||
! Code !! Result | ! Code !! Result | ||
Zeile 154: | Zeile 136: | ||
|} | |} | ||
− | + | === Horizontal ordered lists === | |
− | |||
{| class="wikitable" | {| class="wikitable" | ||
! Code !! Result | ! Code !! Result |
Aktuelle Version vom 4. Oktober 2022, 13:44 Uhr
This is a documentation subpage for Modul:List. It contains usage information, categories and other content that is not part of the original modul page. |
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 module depends on the following other modules: |
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[Quelltext bearbeiten]
Quick usage[Quelltext bearbeiten]
{{#invoke:list|function|first item|second item|third item|...}}
All parameters[Quelltext bearbeiten]
{{#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[Quelltext bearbeiten]
{{#invoke:list|function}}
Functions[Quelltext bearbeiten]
Function name | Produces | Example output | Template using the function |
---|---|---|---|
bulleted
|
Bulleted lists |
|
{{bulleted list}}
|
unbulleted
|
Unbulleted lists |
|
{{unbulleted list}}
|
horizontal
|
Horizontal bulleted lists |
|
{{hlist}}
|
ordered
|
Ordered lists (numbered lists and alphabetical lists) |
|
{{ordered list}}
|
horizontal_ordered
|
Horizontal ordered lists |
|
{{horizontal ordered list}}
|
Parameters[Quelltext bearbeiten]
- 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 wpen: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 wpen: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[Quelltext bearbeiten]
Bulleted lists[Quelltext bearbeiten]
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[Quelltext bearbeiten]
Code | Result |
---|---|
{{#invoke:list|unbulleted|First item|Second item|Third item}}
|
|
{{#invoke:list|unbulleted|First item|Second item|Third item|item_style=color:blue;}}
|
|
{{#invoke:list|unbulleted|First item|Second item|Third item|item1_style=background-color:yellow;|item2_style=background-color:silver;}}
|
|
Horizontal lists[Quelltext bearbeiten]
Code | Result |
---|---|
{{#invoke:list|horizontal|First item|Second item|Third item}}
|
|
{{#invoke:list|horizontal|First item|Second item|Third item|indent=2}}
|
|
Ordered lists[Quelltext bearbeiten]
Code | Result |
---|---|
{{#invoke:list|ordered|First item|Second item|Third item}}
|
|
{{#invoke:list|ordered|First item|Second item|Third item|start=3}}
|
|
{{#invoke:list|ordered|First item|Second item|Third item|type=i}
|
|
{{#invoke:list|ordered|First item|Second item|Third item|list_style_type=lower-greek}}
|
|
Horizontal ordered lists[Quelltext bearbeiten]
Code | Result |
---|---|
{{#invoke:list|horizontal_ordered|First item|Second item|Third item}}
|
|
{{#invoke:list|horizontal_ordered|First item|Second item|Third item|start=3}}
|
|
{{#invoke:list|horizontal_ordered|First item|Second item|Third item|indent=2}}
|
|