Template:Flatlist/doc
 | This is a documentation subpage for Template:Flatlist. It contains usage information, categories and other content that is not part of the original template page. |
 | This template is used in MediaWiki:Pageinfo-header, and on approximately 299,000 pages, or roughly 7511% of all pages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them. |
This template provides a WCAG/ISO-standards-compliant accessible alternative to comma- or dash- (or other single character-) separated lists, per WP:FLATLIST and WP:HLIST.
Usage
{{flatlist}} starts a horizontal list, such as:
This template can be used with or without {{endflatlist}}. For navigation boxes using {{navbox}}, one can set |listclass=hlist, and achieve the same styling without using this template. For image captions, list (i.e. asterisk) markup does not work, so consider using {{hlist}} instead.
Parameters
TemplateData for Flatlist
| ⧼templatedata-doc-param-name⧽ | ⧼templatedata-doc-param-desc⧽ | ⧼templatedata-doc-param-type⧽ | ⧼templatedata-doc-param-status⧽ | |
|---|---|---|---|---|
| Content | 1 | The list to wrap. | ⧼templatedata-doc-param-type-content⧽ | ⧼templatedata-doc-param-status-suggested⧽ |
| Extra Classes | class | Adds extra CSS classes to the containing div. | ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-optional⧽ |
| CSS Style | style | Adds extra CSS properties to the containing div. Complex styles should not be used in articles (per MOS:DEVIATIONS) but may be acceptable on user, project and talk pages.
| ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-optional⧽ |
| Indent | indent | Indents the list by a number of standard indents (one indent being 1.6em). (Useful in an indented discussion thread.)
| ⧼templatedata-doc-param-type-number⧽ | ⧼templatedata-doc-param-status-optional⧽ |
Format: inline
Examples
<syntaxhighlight lang="moin">
</syntaxhighlight>
produces:
Alternative syntax
<syntaxhighlight lang="moin">
</syntaxhighlight>
produces:
Syntax for ordered lists
<syntaxhighlight lang="moin">
</syntaxhighlight>
produces:
Using optional parameters
<syntaxhighlight lang="moin">
</syntaxhighlight>
produces:
Technical details
This template uses the .hlist CSS class defined in MediaWiki:Common.css to generate horizontal lists. It causes ordinary html list items to be displayed inline (horizontally), where they would normally display as block elements (vertically). The class also generates the interpuncts between list items and parentheses around nested lists. Some of the CSS used is not compatible with all browsers, notably Internet Explorer 6 and 7.
| Wikitext | Expanded template | HTML |
|---|---|---|
{{flatlist|
* cat
* dog
* horse
* cow
* sheep
* pig
}}
|
<div class="hlist hlist-separated " > * cat * dog * horse * cow * sheep * pig </div> |
<syntaxhighlight lang="html">
</syntaxhighlight> |
See also
- {{endflatlist}}
- {{hlist}}
- {{plainlist}} and {{unbulleted list}}
- {{bulleted list}}
- {{ordered list}}
- {{nowrap}}
- {{pagelist}}
- WP:HLIST
