Template:Unbulleted list/doc: Difference between revisions

Latest revision as of 20:07, 7 August 2022

This is a documentation subpage for Template:Unbulleted list.
It contains usage information, categories and other content that is not part of the original template page.

This template is used on approximately 1,140,000 pages, or roughly 268868% of all pages.
To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

Shortcuts

{{ubl}}
{{ubt}}
{{ublist}}
{{unbullet}}

This template uses Lua:

Module:List

This template creates unbulleted lists. Each item in the list may have CSS styles added to it individually, by appending a numbered parameter.

Usage

Basic usage

{{unbulleted list|first item|second item|third item|...}}

All parameters

{{unbulleted list
|first item|second item|third item|...
|class     = class
|style     = style
|list_style  = style for ul tag
|item_style  = style for all li tags
|item1_style = style for first li tag |item2_style = style for second li tag |...
}}

Parameters

Positional parameters (1, 2, 3...) – these are the list items. If no list items are present, the module will output nothing.
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 <ul>...</ul> tags around the list. 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.

<templatedata> { "params": { "1": { "label": "List item 1", "type": "line", "required": true, "description": "First item in the list" }, "2": { "label": "List item 2", "type": "line", "description": "Second item in the list" }, "3": { "label": "List item 3", "type": "line", "description": "Third item in the list" }, "4": { "label": "List item 4", "type": "line", "description": "Fourth item in the list" }, "5": { "label": "List item 5", "type": "line", "description": "Fifth item in the list" }, "6": { "label": "List item 6", "type": "line", "description": "Sixth item in the list" }, "7": { "label": "List item 7", "type": "line", "description": "Seventh item in the list" }, "8": { "label": "List item 8", "type": "line", "description": "Eighth item in the list" }, "9": { "label": "List item 9", "type": "line", "description": "Ninth item in the list" }, "class": {

"description": "A custom class for the

...

tags surrounding the list",

"example": "plainlinks" }, "style": {

"description": "A custom CSS style for the

...

tags surrounding the list",

"example": "font-size: 90%;" }, "list_style": {

"description": "A custom CSS style for the

...

tags around the list",

"label": "List style" }, "item_style": {

"description": "A custom CSS style for all of the list items (the

...

tags)", "label": "Item style" }, "item1_style": { "label": "Item 1 style", "description": "Custom CSS style for list item 1" }, "item2_style": { "label": "Item 2 style", "description": "Custom CSS style for list item 2" }, "item3_style": { "label": "Item 3 style", "description": "Custom CSS style for list item 3" }, "item4_style": { "label": "Item 4 style", "description": "Custom CSS style for list item 4" }, "item5_style": { "label": "Item 5 style", "description": "Custom CSS style for list item 5" }, "item6_style": { "label": "Item 6 style", "description": "Custom CSS style for list item 6" }, "item7_style": { "label": "Item 7 style", "description": "Custom CSS style for list item 7" }, "item8_style": { "label": "Item 8 style", "description": "Custom CSS style for list item 8" }, "item9_style": { "label": "Item 9 style", "description": "Custom CSS style for list item 9" } }, "paramOrder": [ "class", "style", "list_style", "item_style", "1", "2", "3", "4", "5", "6", "7", "8", "9", "item1_style", "item2_style", "item3_style", "item4_style", "item5_style", "item6_style", "item7_style", "item8_style", "item9_style" ], "description": "Creates a list of items separated by line breaks but not bullets (•)" } </templatedata>

Example

Code	Result
`{{Unbulleted list\|entry1\|entry2\|entry3\|entry4\|entry5\|entry6\|entry7\|entry8\|entry9}}`	entry1 entry2 entry3 entry4 entry5 entry6 entry7 entry8 entry9
`{{Unbulleted list\|Winner\|Runner-up\|Third place\|item_style=color:blue;}}`	Winner Runner-up Third place
`{{Unbulleted list\|Winner\|Runner-up\|Third place\|item1_style=background-color:yellow;\|item2_style=background-color:silver;}}`	Winner Runner-up Third place

Controlling line-breaking

Template {{nbsp}} may be used with {{wbr}} and {{nowrap}} to control line-breaking in bulletless lists, to prevent wrapped long entries from being confused with multiple entries. See Template:Wbr/doc#Controlling line-breaking in infoboxes for details.

Wrapping this entire template with {{nowrap}} causes syntax errors. Use |class=nowrap instead.

Technical details

{{Unbulleted list}} works by constructing a div with the CSS class "plainlist" which has the following style (see MediaWiki:Common.css): <syntaxhighlight lang="css"> .plainlist ul {

   line-height: inherit;
   list-style: none;
   margin: 0;

} .plainlist ul li {

   margin-bottom: 0;

} </syntaxhighlight>

Wikitext	Expanded template	HTML
{{Unbulleted list \| Example 1 \| Example 2 \| Example 3 }}	<syntaxhighlight lang="html"> Example 1 Example 2 Example 3 </syntaxhighlight>	<syntaxhighlight lang="html"> Example 1 Example 2 Example 3 </syntaxhighlight>