Template:Plainlist: Difference between revisions

Latest revision as of 15:05, 11 June 2022

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

This template is used on approximately 280,000 pages, or roughly 13391% 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 Template:Plainlist. 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   separated lists, per SW:UBLIST and SW: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  . Detailed reasons for using this template can be found at SW: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 for this template used by TemplateWizard, VisualEditor and other tools.

TemplateData for Plainlist

This template provides a WCAG/ISO-standards-compliant accessible alternative to separated lists, per SW:UBLIST and SW: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 SW: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. Default The class "plainlist" is always applied.	String	optional
Custom CSS	`style`	Adds CSS style options. Complex styles should not be used in articles (per SW:Deviations) but may be acceptable on user, project, and talk pages. Example border:solid 1px silver; background:lightyellow	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. Example 2	Number	optional

Test of raw TemplateData output:

This template provides a WCAG/ISO-standards-compliant accessible alternative to separated lists, per SW:UBLIST and SW: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 SW:UBLIST.

Template parameters
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. Default The class "plainlist" is always applied.	String	optional
Custom CSS	`style`	Adds CSS style options. Complex styles should not be used in articles (per SW:Deviations) but may be acceptable on user, project, and talk pages. Example border:solid 1px silver; background:lightyellow	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. Example 2	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 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
}}

<div class="plainlist " >
* Example 1
* Example 2
* Example 3

</div>

<div class="plainlist">
<ul>
<li>Example 1</li>
<li>Example 2</li>
<li>Example 3</li>
</ul>
</div>

Redirects

{{Startplainlist}}