Toggle menu
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Template:Plainlist/doc: Difference between revisions

Template page
m Protected "Template:Plainlist/doc": Initial wiki setup ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))
No edit summary
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{wikipedia|page name}}
{{Documentation subpage}}
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE -->
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE -->
{{Cascade-protected template}}
{{Cascade-protected template}}
{{High-use}}
This template provides a WCAG/ISO-standards-compliant accessible alternative to <code><nowiki><br /></nowiki></code> separated lists, per WP:UBLIST and WP:PLIST
{{Template shortcut|plist}}
{{Uses TemplateStyles|Template:Plainlist/styles.css}}
This template provides a [[Web Content Accessibility Guidelines|WCAG]]/ISO-standards-compliant accessible alternative to <code><nowiki><br /></nowiki></code> separated lists, per [[WP:UBLIST]] and [[WP:PLIST]]


== Usage ==
== Usage ==
Line 11: Line 9:


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


It uses proper HTML list markup, which is more standards-compliant and more accessible than separating list items with {{tag|br|s}}. Detailed reasons for using this template can be found at [[WP:UBLIST]].
It uses proper HTML list markup, which is more standards-compliant and more accessible than separating list items with {{tag|br|s}}. Detailed reasons for using this template can be found at WP:UBLIST.


This template can be used with or without {{tl|endplainlist}}. It is an alternative to {{tl|unbulleted list}}, which performs the same function in a more concise but less wiki-style manner. Note that {{tl|unbulleted list}} will work inside image captions, whereas {{tl|plainlist}} does not.
This template can be used with or without {{tl|endplainlist}}. It is an alternative to {{tl|unbulleted list}}, which performs the same function in a more concise but less wiki-style manner. Note that {{tl|unbulleted list}} will work inside image captions, whereas {{tl|plainlist}} does not.
== Examples ==
{{Markup
|<syntaxhighlight lang="wikitext">
{{plainlist|
* [[cat]]
* [[dog]]
* [[horse]]
* [[cow]]
* [[sheep]]
* [[pig]]
}}
</syntaxhighlight>
|
{{plainlist|
* [[cat]]
* [[dog]]
* [[horse]]
* [[cow]]
* [[sheep]]
* [[pig]]
}}
}}
=== Alternative syntax ===
{{Markup
|<syntaxhighlight lang="wikitext">
{{plainlist}}
* [[cat]]
* [[dog]]
* [[horse]]
* [[cow]]
* [[sheep]]
* [[pig]]
{{endplainlist}}
</syntaxhighlight>
|
{{plainlist}}
* [[cat]]
* [[dog]]
* [[horse]]
* [[cow]]
* [[sheep]]
* [[pig]]
{{endplainlist}}
}}


== Parameters ==
== 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 [[Web Content Accessibility Guidelines|WCAG]]/ISO standards–compliant accessible alternative to <code class=\"nowrap\">&lt;[[HTML element#br|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 ===
=== 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 {{slink|Template:Wbr/doc#Controlling line-breaking in infoboxes}} for details.
Template may be used with and {{tlx|nowrap}} to control line-breaking in bulletless lists, to prevent wrapped long entries from being confused with multiple entries. See for details.


== Technical details ==
== Technical details ==
{{tl|Plainlist}} works by constructing a [[span and div|div]] with the [[Cascading Style Sheets|CSS]] class "plainlist" which has the styles listed in [[Template:Plainlist/styles.css]].
{{tl|Plainlist}} works by constructing a div with the CSS class "plainlist" which has the styles listed in Template:Plainlist/styles.css.


{| class="wikitable"
{| class="wikitable"
Line 118: Line 41:
}}
}}
</pre>
</pre>
| class="nowrap" | {{nowiki2|tag=pre|
| class="nowrap" |  
{{Plainlist|
* Example 1
* Example 2
* Example 3
}}
}}
| <syntaxhighlight lang="html">
| <syntaxhighlight lang="html">
<div class="plainlist">
<div class="plainlist">
Line 136: Line 53:
|}
|}


== Redirects ==
* {{Template link|Bulletless list}}
* {{Template link|PL}}
* {{Template link|Plain list}}
* {{tl|Startplainlist}}


== See also ==
* {{tl|unbulleted list}} – essentially the same but uses <code><nowiki>| ... | ... | ...</nowiki></code> instead of <code><nowiki>|* ... * ... * ...</nowiki></code>
* {{tl|flatlist}} and {{tl|hlist}} (replacements for comma- or dash-separated lists)
* {{tl|bulleted list}}
* {{tl|indented plainlist}}
* {{tl|ordered list}}
* {{section link|Template:Infobox person#Inline lists}} for more information on creating lists within the Infobox family of templates, with examples in the following {{section link|Template:Infobox person#Examples|nopage=y}}
{{navbox lists}}
<includeonly>{{Sandbox other||
<includeonly>{{Sandbox other||
<!-- CATEGORIES HERE, THANKS -->
<!-- CATEGORIES HERE, THANKS -->

Latest revision as of 05:30, 14 April 2025

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

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.

Parameters

Controlling line-breaking

Template may be used with and {{nowrap}} to control line-breaking in bulletless lists, to prevent wrapped long entries from being confused with multiple entries. See 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
}}
<div class="plainlist">
<ul>
<li>Example 1</li>
<li>Example 2</li>
<li>Example 3</li>
</ul>
</div>