Template:Plainlist

Template documentation[view] [edit] [history] [purge]

This template provides a WCAG/ISO-standards-compliant accessible alternative to <br /> separated lists, per WP:UBLIST and WP:PLIST

Usage

{{plainlist}} starts a plain (i.e. unbulleted) list, such as:

• cat
• dog
• horse
• cow
• sheep
• pig

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

Markup	Renders as
{{plainlist| * [[cat]] * [[dog]] * [[horse]] * [[cow]] * [[sheep]] * [[pig]] }}	cat dog horse cow sheep pig

Alternative syntax

Markup	Renders as
{{plainlist}} * [[cat]] * [[dog]] * [[horse]] * [[cow]] * [[sheep]] * [[pig]] {{endplainlist}}	cat dog horse cow sheep pig

Parameters

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Plainlist

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.

⧼templatedata-doc-param-name⧽		⧼templatedata-doc-param-desc⧽	⧼templatedata-doc-param-type⧽	⧼templatedata-doc-param-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.	⧼templatedata-doc-param-type-content⧽	⧼templatedata-doc-param-status-suggested⧽
CSS classes	class	Adds a CSS class to the containing div. ⧼templatedata-doc-param-default⧽ The class "plainlist" is always applied.	⧼templatedata-doc-param-type-string⧽	⧼templatedata-doc-param-status-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. ⧼templatedata-doc-param-example⧽ border:solid 1px silver; background:lightyellow	⧼templatedata-doc-param-type-string⧽	⧼templatedata-doc-param-status-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. ⧼templatedata-doc-param-example⧽ 2	⧼templatedata-doc-param-type-number⧽	⧼templatedata-doc-param-status-optional⧽

Test of raw TemplateData output:

<templatedata>{"description":"This template provides a WCAG/ISO-standards-compliant accessible alternative to
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
. Detailed reasons for using this template can be found at WP:UBLIST.",

"params":{ "1":{"suggested":true,"type":"content","description":"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.","label":"List content"},

"class":{"description":"Adds a CSS class to the containing div.","type":"string","default":"The class \"plainlist\" is always applied.","label":"CSS classes"},

"style":{"type":"string","example":"border:solid 1px silver; background:lightyellow","description":"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.","label":"Custom CSS"},

"indent":{"type":"number","example":"2","description":"Indents the list by a number of standard indents (one indent being 1.6em), particularly handy for inclusion in an indented discussion thread.","label":"Indent level"} }

}</templatedata>

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.

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;
    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}}
• {{Indented plainlist}}
• {{ordered list}}
• for more information on creating lists within the Infobox family of templates, with examples in the following

The above documentation is transcluded from Template:Plainlist/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.