Template:Plainlist/doc
This is a documentation subpage for Template:Plainlist. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 279,000 pages, or roughly 121% 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. |
This template provides a WCAG/ISO-standards-compliant accessible alternative to <br />
separated lists, per WP:UBLIST and WP:PLIST
Usage
edit{{plainlist}} starts a plain (i.e. unbulleted) list, such as:
It uses proper HTML list markup, which is more standards-compliant and more accessible than separating list items with <br />
. Detailed reasons for using this template can be found at WP:UBLIST.
This template can be used with or without {{endplainlist}}. It is an alternative to {{unbulleted list}}, which performs the same function in a more concise but less wiki-style manner. Note that {{unbulleted list}} will work inside image captions, whereas {{plainlist}} does not.
Examples
editMarkup | Renders as |
---|---|
|
|
Alternative syntax
editMarkup | Renders as |
---|---|
|
|
Parameters
editTemplateData for Plainlist
Parameter | Description | Type | Status | |
---|---|---|---|---|
List content | 1 | If supplied, the list, as a normal bulleted list. (Every line should start with an asterisk. No blank lines between lines.) See template page for how this works otherwise. | Content | suggested |
CSS classes | class | Adds a CSS class to the containing div.
| String | optional |
Custom CSS | style | Adds CSS style options. Complex styles should not be used in articles (per WP:Deviations) but may be acceptable on user, project, and talk pages.
| String | optional |
Indent level | indent | Indents the list by a number of standard indents (one indent being 1.6em), particularly handy for inclusion in an indented discussion thread.
| Number | optional |
Controlling line-breaking
editTemplate {{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.
Technical details
edit{{Plainlist}} works by constructing a div with the CSS class "plainlist" which has the following style (see MediaWiki:Common.css):
.plainlist ul {
line-height: inherit;
list-style: none;
margin: 0;
}
.plainlist ul li {
margin-bottom: 0;
}
Wikitext | Expanded template | HTML |
---|---|---|
{{Plainlist|
* Example 1
* Example 2
* Example 3
}}
|
{{Plainlist|
* Example 1
* Example 2
* Example 3
}}
|
<div class="plainlist">
<ul>
<li>Example 1</li>
<li>Example 2</li>
<li>Example 3</li>
</ul>
</div>
|
Redirects
edit- {{Startplainlist}}
See also
edit- {{unbulleted list}} – essentially the same but uses
| ... | ... | ...
instead of <syntaxhighlight lang="wikitext" inline="yes">|* ... * ... * ...</nowiki></syntazxhighlight> - {{flatlist}} and {{hlist}} (replacements for comma- or dash-separated lists)
- {{bulleted list}}
- {{Indented plainlist}}
- {{ordered list}}
- Template:Infobox person § Inline lists for more information on creating lists within the Infobox family of templates, with examples in the following § Examples