Jump to content

Template:Plainlist/doc

From Wikifunctions

This template provides a WCAG/ISO-standards-compliant accessible alternative to <br/> separated lists, per w:WP:UBLIST and w: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 w: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 for this template used by TemplateWizard, VisualEditor and other tools.

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.

Template parameters

ParameterDescriptionTypeStatus
List content1

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.

Contentsuggested
CSS classesclass

Adds a CSS class to the containing div.

Default
The class "plainlist" is always applied.
Stringoptional
Custom CSSstyle

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.

Example
border:solid 1px silver; background:lightyellow
Unknownoptional
Indent levelindent

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
Numberoptional

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
}}
Template:Nowiki2
<div class="plainlist">
<ul>
<li>Example 1</li>
<li>Example 2</li>
<li>Example 3</li>
</ul>
</div>

Redirects

See also

Template:Navbox lists