Difference between revisions of "Module:List/doc"
Dinoguy1000 (talk | contribs) (from wikipedia:Module:List/doc) |
|||
Line 1: | Line 1: | ||
+ | {{used in system|in [[MediaWiki:Citethispage-content]]}} | ||
+ | {{module rating|protected}} | ||
+ | {{Lua|Module:TableTools|Module:Arguments}} | ||
+ | {{Uses TemplateStyles|Template:Plainlist/styles.css|Template:Hlist/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. | ||
== Usage == | == Usage == | ||
− | + | === Quick usage === | |
− | + | {{pre|<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>... | ||
Line 25: | Line 28: | ||
}} | }} | ||
− | + | === Arguments passed from parent template === | |
− | + | {{pre|<nowiki>{{</nowiki>#invoke:list<nowiki>|</nowiki>''function''<nowiki>}}</nowiki>}} | |
− | {{ | ||
− | |||
− | |||
+ | === Functions === | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
Line 36: | Line 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 [[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 [[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 [ | + | * <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 [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>. | ||
Line 74: | Line 80: | ||
== Examples == | == Examples == | ||
− | + | === Bulleted lists === | |
− | |||
{| class="wikitable" | {| class="wikitable" | ||
! Code !! Result | ! Code !! Result | ||
Line 89: | Line 94: | ||
|} | |} | ||
− | + | === Unbulleted lists === | |
− | |||
{| class="wikitable" | {| class="wikitable" | ||
! Code !! Result | ! Code !! Result | ||
Line 104: | Line 108: | ||
|} | |} | ||
− | + | === Horizontal lists === | |
− | |||
{| class="wikitable" | {| class="wikitable" | ||
! Code !! Result | ! Code !! Result | ||
Line 116: | Line 119: | ||
|} | |} | ||
− | + | === Ordered lists === | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
{| class="wikitable" | {| class="wikitable" | ||
! Code !! Result | ! Code !! Result | ||
Line 142: | Line 129: | ||
| {{#invoke:list|ordered|First item|Second item|Third item|start=3}} | | {{#invoke:list|ordered|First item|Second item|Third item|start=3}} | ||
|- | |- | ||
− | | <code><nowiki>{{#invoke:list|ordered|First item|Second item|Third item|type=i}</nowiki></code> | + | | Lowercase [[Roman numerals]]: <code><nowiki>{{#invoke:list|ordered|First item|Second item|Third item|type=i}}</nowiki></code> |
| {{#invoke:list|ordered|First item|Second item|Third item|type=i}} | | {{#invoke:list|ordered|First item|Second item|Third item|type=i}} | ||
|- | |- | ||
− | | <code><nowiki>{{#invoke:list|ordered|First item|Second item|Third item|list_style_type=lower-greek}}</nowiki></code> | + | | Lowercase [[Greek alphabet]]: <code><nowiki>{{#invoke:list|ordered|First item|Second item|Third item|list_style_type=lower-greek}}</nowiki></code> |
| {{#invoke:list|ordered|First item|Second item|Third item|list_style_type=lower-greek}} | | {{#invoke:list|ordered|First item|Second item|Third item|list_style_type=lower-greek}} | ||
|} | |} | ||
− | + | === Horizontal ordered lists === | |
− | |||
{| class="wikitable" | {| class="wikitable" | ||
! Code !! Result | ! Code !! Result | ||
Line 163: | Line 149: | ||
| {{#invoke:list|horizontal_ordered|First item|Second item|Third item|indent=2}} | | {{#invoke:list|horizontal_ordered|First item|Second item|Third item|indent=2}} | ||
|} | |} | ||
+ | |||
+ | == Tracking/maintenance category == | ||
+ | * {{clc|List templates with deprecated parameters}} | ||
== See also == | == See also == | ||
+ | * [[Module:Separated entries]] | ||
− | + | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | | |
+ | <!-- Categories below this line, please; interwikis at Wikidata --> | ||
+ | [[Category:Modules that add a tracking category]] | ||
+ | }}</includeonly> |
Revision as of 19:37, 25 January 2023
This Lua module is used in MediaWiki:Citethispage-content, and on approximately 2,070,000 pages, or roughly 230% of all pages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid major disruption and server load, 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. |
This module depends on the following other modules: |
Lua error in Module:TNT at line 159: Missing JsonConfig extension; Cannot load https://commons.wikimedia.org/wiki/Data:I18n/Uses TemplateStyles.tab.
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.
Contents
Usage
Quick usage
{{#invoke:list|function|first item|second item|third item|...}}
All parameters
{{#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
{{#invoke:list|function}}
Functions
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
- 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}}
|
|
{{#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
Code | Result |
---|---|
{{#invoke:list|horizontal|First item|Second item|Third item}}
|
|
{{#invoke:list|horizontal|First item|Second item|Third item|indent=2}}
|
|
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}}
|
|
{{#invoke:list|horizontal_ordered|First item|Second item|Third item|start=3}}
|
|
{{#invoke:list|horizontal_ordered|First item|Second item|Third item|indent=2}}
|
|
Tracking/maintenance category
See also