Template:Plainlist/doc: Difference between revisions

Safer nicotine wiki Tobacco Harm Reduction
Jump to navigation Jump to search
(CSS: "type": "string",)
 
imported>Jay D. Easy
mNo edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE -->
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE -->
{{#ifeq:{{FULLPAGENAME}} | Template:Plainlist | {{high-risk| 171000+ }} }}
{{High-use}}
 
{{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]]
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 ==
{{tl|plainlist}} starts a plain (i.e. unbulleted) list, such as:
{{tl|plainlist}} starts a plain (i.e. unbulleted) list, such as:


Line 21: Line 21:
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==
== Examples ==
{{Markup
{{Markup
|<nowiki>
|<nowiki>
Line 43: Line 43:
}}
}}
}}
}}
=== Alternative syntax ===
=== Alternative syntax ===
{{Markup
{{Markup
Line 66: Line 67:
}}
}}


==Parameters==
== Parameters ==
{{Format TemplateData|JSON= {
{{Format TemplateData|JSON= {
"params": {
"params": {
Line 100: Line 101:
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.
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==
== Technical details ==
{{tl|Plainlist}} works by constructing a [[span and div|div]] with the [[Cascading Style Sheets|CSS]] class "plainlist" which has the following style (see [[MediaWiki:Common.css]]):
{{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]].
<syntaxhighlight lang="css">
.plainlist ul {
    line-height: inherit;
    list-style: none none;
    margin: 0;
}
.plainlist ul li {
    margin-bottom: 0;
}
</syntaxhighlight>


{| class="wikitable"
{| class="wikitable"
Line 143: Line 134:
|}
|}


==Redirects==
== Redirects ==
* {{tl|Startplainlist}}
* {{tl|Startplainlist}}


==See also==
== See also ==
* {{tl|unbulleted list}} – essentially the same but uses <code><nowiki>| ... | ... | ...</nowiki></code> instead of <code><nowiki>|* ... * ... * ...</nowiki></code>
* {{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|flatlist}} and {{tl|hlist}} (replacements for comma- or dash-separated lists)
* {{tl|bulleted list}}
* {{tl|bulleted list}}
* {{tl|Indented plainlist}}
* {{tl|indented plainlist}}
* {{tl|ordered list}}
* {{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}}  
* {{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}}  

Latest revision as of 19:15, 30 January 2023

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:

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

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

Alternative syntax

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

Parameters

This is the TemplateData documentation for this template used by VisualEditor and other tools.

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.
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.
CSS classesclass
Adds a CSS class to the containing div.
Default
The class "plainlist" is always applied.
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
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

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
}}
'"`UNIQ--templatestyles-0000000E-QINU`"'<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

See also