Difference between revisions of "Module:List/doc"
Jump to navigation
Jump to search
blackwiki>Mr. Stradivarius (Undid revision 581618494 by Mr. Stradivarius (talk) actually, this is no longer necessary due to changes at Module:Random) |
blackwiki>Frietjes |
||
| Line 22: | Line 22: | ||
<nowiki>|item_style = </nowiki>''style for all list items'' | <nowiki>|item_style = </nowiki>''style for all list items'' | ||
<nowiki>|item_style1 = </nowiki>''style for the first list item''<nowiki> |item_style2 = </nowiki>''style for the second list item''<nowiki> |</nowiki>... | <nowiki>|item_style1 = </nowiki>''style for the first list item''<nowiki> |item_style2 = </nowiki>''style for the second list item''<nowiki> |</nowiki>... | ||
| + | <nowiki>|item_value1 = </nowiki>''value for the first list item''<nowiki> |item_value2 = </nowiki>''value for the second list item''<nowiki> |</nowiki>... | ||
<nowiki>|indent = </nowiki>''indent for horizontal lists'' | <nowiki>|indent = </nowiki>''indent for horizontal lists'' | ||
<nowiki>}}</nowiki> | <nowiki>}}</nowiki> | ||
| Line 70: | Line 71: | ||
* <code>item_style</code> - a custom css style for all of the list items (the {{tag|li}} tags). The format is the same as for the {{para|style}} parameter. <code>li_style</code> is an alias for this parameter, included for backwards compatibility. | * <code>item_style</code> - a custom css style for all of the list items (the {{tag|li}} tags). The format is the same as for the {{para|style}} parameter. <code>li_style</code> is an alias for this parameter, included for backwards compatibility. | ||
* <code>item_style1</code>, <code>item_style2</code>, <code>item_style3</code>... - custom css styles for each of the list items. The format is the same as for the {{para|style}} parameter. The <code>li_style1</code>, <code>li_style2</code> <code>li_style3</code> ... parameters are aliases for these parameters, included for backwards compatibility. | * <code>item_style1</code>, <code>item_style2</code>, <code>item_style3</code>... - custom css styles for each of the list items. The format is the same as for the {{para|style}} parameter. The <code>li_style1</code>, <code>li_style2</code> <code>li_style3</code> ... parameters are aliases for these parameters, included for backwards compatibility. | ||
| + | * <code>item_value1</code>, <code>item_value2</code>, <code>item_value3</code>... - custom value for list items. The value should be a positive integer (only works with ordered lists). | ||
* <code>indent</code> - this parameter indents the list, for horizontal and horizontal ordered lists only. The value must be a number, e.g. <code>2</code>. The indent is calculated in [[Em (typography)|em]], and is 1.6 times the value specified. If no indent is specified, the default is zero. | * <code>indent</code> - this parameter indents the list, for horizontal and horizontal ordered lists only. The value must be a number, e.g. <code>2</code>. The indent is calculated in [[Em (typography)|em]], and is 1.6 times the value specified. If no indent is specified, the default is zero. | ||
Revision as of 22:57, 14 November 2013
| 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, 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 |
|---|---|---|
bulleted
|
Bulleted lists |
|
unbulleted
|
Unbulleted lists |
|
horizontal
|
Horizontal bulleted lists |
|
ordered
|
Ordered lists (numbered lists and alphabetical lists) |
|
horizontal_ordered
|
Horizontal ordered lists |
|
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. This parameter is also supported in theory for horizontal ordered lists, but in practice, as of November 2013, it does not work due to lack of browser support.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. This is also supported in theory for horizontal ordered lists, but in practice, as of November 2013, this does not work due to lack of browser support. See also thelist_style_typeparameter.list_style_type- the type of marker used in ordered lists. This uses CSS styling, and has more types available than thetypeparameter, which uses an html attribute. Possible values are listed at W3schools' list-style-type page. Support may vary by browser.list-style-typeis 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.ul_styleandol_styleare aliases for this parameter, included for backwards compatibility.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.li_styleis an alias for this parameter, included for backwards compatibility.item_style1,item_style2,item_style3... - custom css styles for each of the list items. The format is the same as for the|style=parameter. Theli_style1,li_style2li_style3... parameters are aliases for these parameters, included for backwards compatibility.item_value1,item_value2,item_value3... - custom value for list items. The value should be a positive integer (only works with 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|li_style=color:blue;}}
|
|
{{#invoke:list|bulleted|First item|Second item|Third item|li_style1=background-color:yellow;|li_style2=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|li_style=color:blue;}}
|
|
{{#invoke:list|unbulleted|First item|Second item|Third item|li_style1=background-color:yellow;|li_style2=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}}
|
|
- Unbulleted lists
| Code | Result |
|---|---|
{{#invoke:list|unbulleted|First item|Second item|Third item}}
|
|
{{#invoke:list|unbulleted|First item|Second item|Third item|li_style=color:blue;}}
|
|
{{#invoke:list|unbulleted|First item|Second item|Third item|li_style1=background-color:yellow;|li_style2=background-color:silver;}}
|
|
- Ordered lists
| 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
| Code | Result |
|---|---|
{{#invoke:list|horizontal_ordered|First item|Second item|Third item}}
|
|
{{#invoke:list|horizontal_ordered|First item|Second item|Third item|indent=2}}
|
|