Template:Plainlist

Template documentation

This documentation is  transcluded from Template:Plainlist/doc. (Edit | history)
Note to editors: Please don't categorize this template by editing it directly. Instead, place the category in its documentation page, in its "includeonly" section.

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

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

Alternative syntax

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

Parameters

{
	"params": {
		"1": {
			"label": "List 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.",
			"type": "content",
			"suggested": true
		},
		"class": {
			"label": "CSS classes",
			"description": "Adds a CSS class to the containing div.",
			"type": "string",
			"default": "The class \"plainlist\" is always applied."
		},
		"style": {
			"label": "Custom CSS",
			"description": "Adds CSS style options. Complex styles should not be used in articles (per {{Wikipedia|WP:Deviations}}) but may be acceptable on user, project, and talk pages.",
		    "type": "string",
            "example": "border:solid 1px silver; background:lightyellow"
		},
		"indent": {
			"label": "Indent level",
            "description": "Indents the list by a number of standard indents (one indent being 1.6em), particularly handy for inclusion in an indented discussion thread.",
			"type": "number",
            "example": "2"
		}
	},
	"description": "This template provides a WCAG/ISO-standards-compliant accessible alternative to <br /> separated lists, per {{Wikipedia|WP:UBLIST}} and {{Wikipedia|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."
} </sntaxhighlight><!--}}-->

=== Controlling line-breaking ===
Template {{tlx|nbsp}} may be used with {{tlx|wbr}} and {{tlx|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 ==
{{tl|Plainlist}} works by constructing a {{Wikipedia|span and div|div}} with the {{Wikipedia|Cascading Style Sheets|CSS}} class "plainlist" which has the styles listed in {{Wikipedia|Template:Plainlist/styles.css}}.

{| class="wikitable"
! Wikitext	
! Expanded template	
! HTML
|- style="vertical-align:top;"
| class="nowrap" | <pre>
{{Plainlist|
* Example 1
* Example 2
* Example 3
}}
</pre>	
| class="nowrap" | {{nowiki2|tag=pre|
{{Plainlist|
* Example 1
* Example 2
* Example 3
}}
}}	
| <syntaxhighlight lang="html">
<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}}
• Template:Infobox person#Inline lists § Notes for more information on creating lists within the Infobox family of templates, with examples in the following § Notes

Flat	{{hlist}} {{hlist |item1 |item2 |...}} item1 item2 ...	{{flatlist}} {{flatlist| * item1 * item2 * ...}} item1 item2 ...	{{cslist}} {{cslist |item1 |item2 |...}} {{bold list}} {{bold list |item1 |item2 |...}}
Bulleted and Ordered	{{bulleted list}} {{bulleted list |item1 |item2 |...}}		{{ordered list}} {{Ordered list |list_style_type=lower-alpha |first |second |...}}
Unbulleted	{{unbulleted list}} {{unbulleted list |item1 |item2 |...}} item1 item2 ...	{{plainlist}} {{plainlist| * item1 * item2 * ...}} item1 item2 ...	{{glossary}} (glossary, description, definition, association) {{glossary}} {{term|first term}} {{defn|first description}} {{term|second term}} {{defn|second description}} {{term|...}} {{defn|....}} {{glossary end}} first term Template:Defn second term Template:Defn ... Template:Defn Template:Glossary end
Other	{{flowlist}} [[File:Bad Title Example.png|left|thumb|100px]] {{flowlist| *item1 *item2 *...}}	{{columns-list}} {{columns-list|colwidth=5em| # first # second # third # ...}}