Template:Plainlist/doc - Revision history

Caleb Cooper at 14:56, 31 October 2020

2020-10-31T14:56:21Z

← Older revision		Revision as of 14:56, 31 October 2020
Line 4:		Line 4:
	{{Commons Import}}		{{Commons Import}}

	This template provides a [[Web Content Accessibility Guidelines\|WCAG]]/ISO-standards-compliant accessible alternative to <code><nowiki><br /></nowiki></code> separated lists, per [[Wikipedia:WP:UBLIST]] and [[Wikipedia:WP:PLIST]]		This template provides a [[Wikipedia:Web Content Accessibility Guidelines\|WCAG]]/ISO-standards-compliant accessible alternative to <code><nowiki><br /></nowiki></code> separated lists, per [[Wikipedia:WP:UBLIST]] and [[Wikipedia:WP:PLIST]]

	==Usage==		==Usage==
Line 36:		Line 36:
	\|		\|
	{{plainlist\|		{{plainlist\|
	* [[cat]]		* [[Wikipedia:cat\|cat]]
	* [[dog]]		* [[Wikipedia:dog\|dog]]
	* [[horse]]		* [[Wikipedia:horse\|horse]]
	* [[cow]]		* [[Wikipedia:cow\|cow]]
	* [[sheep]]		* [[Wikipedia:sheep\|sheep]]
	* [[pig]]		* [[Wikipedia:pig\|pig]]
	}}		}}
	}}		}}
Line 58:		Line 58:
	\|		\|
	{{plainlist}}		{{plainlist}}
	* [[cat]]		* [[Wikipedia:cat\|cat]]
	* [[dog]]		* [[Wikipedia:dog\|dog]]
	* [[horse]]		* [[Wikipedia:horse\|horse]]
	* [[cow]]		* [[Wikipedia:cow\|cow]]
	* [[sheep]]		* [[Wikipedia:sheep\|sheep]]
	* [[pig]]		* [[Wikipedia:pig\|pig]]
	{{endplainlist}}		{{endplainlist}}
	}}		}}

Caleb Cooper at 14:53, 31 October 2020

2020-10-31T14:53:47Z

← Older revision		Revision as of 14:53, 31 October 2020
Line 1:		Line 1:
	{{Documentation subpage~~}}{{Commons Import~~}}		{{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+ }~~} }}		{{#ifeq:{{FULLPAGENAME}} \| Template:Plainlist \| {{high-risk} }}
			{{Commons Import}}

	This template provides a [[Web Content Accessibility Guidelines\|WCAG]]/ISO-standards-compliant accessible alternative to <code><nowiki><br /></nowiki></code> separated lists, per [[Wikipedia:WP:UBLIST]] and [[Wikipedia: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 [[Wikipedia:WP:UBLIST]] and [[Wikipedia:WP:PLIST]]
Line 9:		Line 10:

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

Caleb Cooper: Text replacement - "CSS" to "CSS"

2020-10-21T16:28:40Z

Text replacement - "CSS" to "CSS"

← Older revision		Revision as of 16:28, 21 October 2020
Line 100:		Line 100:

	==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 [[Wikipedia:Cascading Style Sheets\|CSS]] class "plainlist" which has the following style (see [[MediaWiki:Common.css]]):
	<syntaxhighlight lang="css">		<syntaxhighlight lang="css">
	.plainlist ul {		.plainlist ul {

Caleb Cooper: Text replacement - "[[WP:" to "[[Wikipedia:WP:"

2020-10-21T08:13:05Z

Text replacement - "[[WP:" to "[[Wikipedia:WP:"

← Older revision		Revision as of 08:13, 21 October 2020
Line 3:		Line 3:
	{{#ifeq:{{FULLPAGENAME}} \| Template:Plainlist \| {{high-risk\| 171000+ }} }}		{{#ifeq:{{FULLPAGENAME}} \| Template:Plainlist \| {{high-risk\| 171000+ }} }}

	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 [[Wikipedia:WP:UBLIST]] and [[Wikipedia:WP:PLIST]]

	==Usage==		==Usage==
Line 17:		Line 17:
	}}		}}

	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 [[Wikipedia: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.
Line 83:		Line 83:
	"style": {		"style": {
	"label": "Custom CSS",		"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.",		"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.",
	"example": "border:solid 1px silver; background:lightyellow"		"example": "border:solid 1px silver; background:lightyellow"
	},		},
Line 93:		Line 93:
	}		}
	},		},
	"description": "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."		"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."
	} }}		} }}

Caleb Cooper at 11:52, 18 October 2020

2020-10-18T11:52:17Z

← Older revision		Revision as of 11:52, 18 October 2020
Line 1:		Line 1:
	{{Documentation subpage}}		{{Documentation subpage}}{{Commons Import}}
	<!-- 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+ }} }}		{{#ifeq:{{FULLPAGENAME}} \| Template:Plainlist \| {{high-risk\| 171000+ }} }}

Caleb Cooper: Created page with "{{Documentation subpage}} {{#ifeq:{{FULLPAGENAME}} | Template:Plainlist | {{high-risk| 171000+ }} }} This template p..."

2020-10-18T11:17:18Z

Created page with "{{Documentation subpage}}  {{#ifeq:{{FULLPAGENAME}} | Template:Plainlist | {{high-risk| 171000+ }} }} This template p..."

New page

{{Documentation subpage}}

{{#ifeq:{{FULLPAGENAME}} | Template:Plainlist | {{high-risk| 171000+ }} }}

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==
{{tl|plainlist}} starts a plain (i.e. unbulleted) list, such as:

{{plainlist|
* [[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 {{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.

==Examples==
{{Markup
|<nowiki>
{{plainlist|
* [[cat]]
* [[dog]]
* [[horse]]
* [[cow]]
* [[sheep]]
* [[pig]]
}}
</nowiki>
|
{{plainlist|
* [[cat]]
* [[dog]]
* [[horse]]
* [[cow]]
* [[sheep]]
* [[pig]]
}}
}}
=== Alternative syntax ===
{{Markup
|<nowiki>
{{plainlist}}
* [[cat]]
* [[dog]]
* [[horse]]
* [[cow]]
* [[sheep]]
* [[pig]]
{{endplainlist}}
</nowiki>
|
{{plainlist}}
* [[cat]]
* [[dog]]
* [[horse]]
* [[cow]]
* [[sheep]]
* [[pig]]
{{endplainlist}}
}}

==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.",
"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 [[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."
} }}

=== 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 [[span and div|div]] with the [[Cascading Style Sheets|CSS]] class "plainlist" which has the following style (see [[MediaWiki:Common.css]]):
<syntaxhighlight lang="css">
.plainlist ul {
line-height: inherit;
list-style: none none;
margin: 0;
}
.plainlist ul li {
margin-bottom: 0;
}
</syntaxhighlight>

{| 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>
</syntaxhighlight>
|}

==Redirects==
* {{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|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||

[[Category:List formatting and function templates|Plainlist]]
[[Category:Semantic markup templates]]
[[Category:Typing-aid templates|Plainlist]]
}}</includeonly>