Template:Plainlist/doc: Difference between revisions

Revision as of 17:29, 8 April 2025

This page uses Creative Commons Licensed content from Wikipedia (view authors).

This is a documentation subpage for Template:Plainlist
It may contain usage information, categories and other content that is not part of the original template page.

This template can only be edited by administrators because it is transcluded onto one or more cascade-protected pages.

Template:High-use

Shortcut

{{plist}}

This template uses TemplateStyles:

Template:Plainlist/styles.css

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

Template:Markup

Alternative syntax

Template:Markup

Parameters

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 styles listed in Template:Plainlist/styles.css.

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>

@@ Line 71: / Line 71: @@
 == Parameters ==
-{{Format TemplateData|JSON= {
-	"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 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 <code class=\"nowrap\">&lt;br&#32;&#47;&gt;</code>-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 <code class=\"nowrap\">&lt;br&#32;&#47;&gt;</code>. Detailed reasons for using this template can be found at WP:UBLIST."
-} }}
 === Controlling line-breaking ===