Template:Plainlist/doc
This is a documentation subpage for Template:Plainlist. It contains usage information, categories and other content or metadata that is not part of the original template. |
This template provides a WCAG/ISO-standards-compliant accessible alternative to <br />
separated lists, per w:UBLIST and w:PLIST
Usage
{{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 w: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
{{Plainlist| * [[cat]] * [[dog]] * [[horse]] * [[cow]] * [[sheep]] * [[pig]] }}
Alternative syntax
{{Plainlist}} * [[cat]] * [[dog]] * [[horse]] * [[cow]] * [[sheep]] * [[pig]] {{Endplainlist}}
Parameters
This template provides a WCAG/ISO-standards-compliant accessible alternative to <br /> separated lists, per [[WP:UBLIST]] and [[WP:PLIST]]. 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.
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.
| Unknown | 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
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 w:Template:Wbr/doc#Controlling line-breaking in infoboxes for details.
Technical details
{{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 none;
margin: 0;
}
.plainlist ul li {
margin-bottom: 0;
}
Wikitext | Expanded template | HTML |
---|---|---|
{{Plainlist| * Example 1 * Example 2 * Example 3 }} |
Template:Nowiki2 | <div class="plainlist">
<ul>
<li>Example 1</li>
<li>Example 2</li>
<li>Example 3</li>
</ul>
</div>
|
Redirects
- {{Startplainlist}}
See also
- {{Unbulleted list}} – essentially the same but uses
| ... | ... | ...
instead of|* ... * ... * ...
- {{Flatlist}} and {{Hlist}} (replacements for comma- or dash-separated lists)
- {{Bulleted list}}
- {{Ordered list}}
- Inline lists for more information on creating lists within the Infobox family of templates, with examples in the following examples