Difference between revisions of "Template:Plainlist"
LaneFrost23 (talk | contribs) (Created page with "<div class="plainlist {{{class|}}}" {{#if:{{{style|}}}{{{indent|}}}|style="{{#if:{{{indent|}}}|margin-left: {{#expr:{{{indent}}}*1.6}}em;}} {{{style|}}}"}}>{{#if:{{{1|}}}| {{{...") |
(add tstyles here) |
||
| Line 1: | Line 1: | ||
| − | <div class="plainlist {{{class|}}}" {{#if:{{{style|}}}{{{indent|}}}|style="{{#if:{{{indent|}}}|margin-left: {{#expr:{{{indent}}}*1.6}}em;}} {{{style|}}}"}}>{{#if:{{{1|}}}| | + | <templatestyles src="Plainlist/styles.css"/><div class="plainlist {{{class|}}}" {{#if:{{{style|}}}{{{indent|}}}|style="{{#if:{{{indent|}}}|margin-left: {{#expr:{{{indent}}}*1.6}}em;}} {{{style|}}}"}}>{{#if:{{{1|}}}| |
{{{1}}} | {{{1}}} | ||
</div>}}<noinclude></div> | </div>}}<noinclude></div> | ||
{{documentation}} | {{documentation}} | ||
</noinclude> | </noinclude> | ||
Revision as of 18:45, 12 December 2022
Template documentation| 40px | This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
This template provides a WCAG/ISO-standards-compliant accessible alternative to <br /> separated lists, per WP:UBLIST and WP:PLIST
Contents
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
TemplateData for Plainlist
| ⧼templatedata-doc-param-name⧽ | ⧼templatedata-doc-param-desc⧽ | ⧼templatedata-doc-param-type⧽ | ⧼templatedata-doc-param-status⧽ | |
|---|---|---|---|---|
| List content | 1 | 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. | ⧼templatedata-doc-param-type-content⧽ | ⧼templatedata-doc-param-status-suggested⧽ |
| CSS classes | class | Adds a CSS class to the containing div.
| ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-optional⧽ |
| Custom CSS | style | 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.
| ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-optional⧽ |
| Indent level | indent | Indents the list by a number of standard indents (one indent being 1.6em), particularly handy for inclusion in an indented discussion thread.
| ⧼templatedata-doc-param-type-number⧽ | ⧼templatedata-doc-param-status-optional⧽ |
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
. Detailed reasons for using this template can be found at WP:UBLIST.",
"params":{ "1":{"suggested":true,"type":"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.","label":"List content"},
"class":{"description":"Adds a CSS class to the containing div.","type":"string","default":"The class \"plainlist\" is always applied.","label":"CSS classes"},
"style":{"type":"string","example":"border:solid 1px silver; background:lightyellow","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.","label":"Custom CSS"},
"indent":{"type":"number","example":"2","description":"Indents the list by a number of standard indents (one indent being 1.6em), particularly handy for inclusion in an indented discussion thread.","label":"Indent level"} }
}</templatedata>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 following style (see MediaWiki:Common.css):
.plainlist ul {
line-height: inherit;
list-style: none;
margin: 0;
}
.plainlist ul li {
margin-bottom: 0;
}
| 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>
|
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}}
- Lua error in package.lua at line 80: module 'strict' not found. for more information on creating lists within the Infobox family of templates, with examples in the following Lua error in package.lua at line 80: module 'strict' not found.
