Module:List/doc

From No Man's Sky Wiki
Jump to: navigation, search

This is the documentation page for Module:List

Template-info.png Documentation

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

Template:Pre2

All parameters

Template:Pre2

Arguments passed from parent template

Template:Pre2

Functions
Function name Produces Example output Template using the function
bulleted Bulleted lists Lua error in package.lua at line 80: module 'Module:Arguments' not found. {{bulleted list}}
unbulleted Unbulleted lists Lua error in package.lua at line 80: module 'Module:Arguments' not found. {{unbulleted list}}
horizontal Horizontal bulleted lists Lua error in package.lua at line 80: module 'Module:Arguments' not found. {{hlist}}
ordered Ordered lists (numbered lists and alphabetical lists) Lua error in package.lua at line 80: module 'Module:Arguments' not found. {{ordered list}}
horizontal_ordered Horizontal ordered lists Lua error in package.lua at line 80: module 'Module:Arguments' not found.

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 the list_style_type parameter.
  • list_style_type - the type of marker used in ordered lists. This uses CSS styling, and has more types available than the type 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 Template:Tag tags surrounding the list, e.g. plainlinks.
  • style - a custom css style for the Template:Tag 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 Template:Tag tags). The format is the same as for the Template: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: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
Code Result
{{#invoke:list|bulleted|First item|Second item|Third item}} Lua error in package.lua at line 80: module 'Module:Arguments' not found.
{{#invoke:list|bulleted|First item|Second item|Third item|item_style=color:blue;}} Lua error in package.lua at line 80: module 'Module:Arguments' not found.
{{#invoke:list|bulleted|First item|Second item|Third item|item1_style=background-color:yellow;|item2_style=background-color:silver;}} Lua error in package.lua at line 80: module 'Module:Arguments' not found.
Unbulleted lists
Code Result
{{#invoke:list|unbulleted|First item|Second item|Third item}} Lua error in package.lua at line 80: module 'Module:Arguments' not found.
{{#invoke:list|unbulleted|First item|Second item|Third item|item_style=color:blue;}} Lua error in package.lua at line 80: module 'Module:Arguments' not found.
{{#invoke:list|unbulleted|First item|Second item|Third item|item1_style=background-color:yellow;|item2_style=background-color:silver;}} Lua error in package.lua at line 80: module 'Module:Arguments' not found.
Horizontal lists
Code Result
{{#invoke:list|horizontal|First item|Second item|Third item}} Lua error in package.lua at line 80: module 'Module:Arguments' not found.
{{#invoke:list|horizontal|First item|Second item|Third item|indent=2}} Lua error in package.lua at line 80: module 'Module:Arguments' not found.
Unbulleted lists
Code Result
{{#invoke:list|unbulleted|First item|Second item|Third item}} Lua error in package.lua at line 80: module 'Module:Arguments' not found.
{{#invoke:list|unbulleted|First item|Second item|Third item|item_style=color:blue;}} Lua error in package.lua at line 80: module 'Module:Arguments' not found.
{{#invoke:list|unbulleted|First item|Second item|Third item|item1_style=background-color:yellow;|item2_style=background-color:silver;}} Lua error in package.lua at line 80: module 'Module:Arguments' not found.
Ordered lists
Code Result
{{#invoke:list|ordered|First item|Second item|Third item}} Lua error in package.lua at line 80: module 'Module:Arguments' not found.
{{#invoke:list|ordered|First item|Second item|Third item|start=3}} Lua error in package.lua at line 80: module 'Module:Arguments' not found.
{{#invoke:list|ordered|First item|Second item|Third item|type=i} Lua error in package.lua at line 80: module 'Module:Arguments' not found.
{{#invoke:list|ordered|First item|Second item|Third item|list_style_type=lower-greek}} Lua error in package.lua at line 80: module 'Module:Arguments' not found.
Horizontal ordered lists
Code Result
{{#invoke:list|horizontal_ordered|First item|Second item|Third item}} Lua error in package.lua at line 80: module 'Module:Arguments' not found.
{{#invoke:list|horizontal_ordered|First item|Second item|Third item|start=3}} Lua error in package.lua at line 80: module 'Module:Arguments' not found.
{{#invoke:list|horizontal_ordered|First item|Second item|Third item|indent=2}} Lua error in package.lua at line 80: module 'Module:Arguments' not found.

See also[edit source]

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.