Template:Flatlist/doc

From AusMetal Guide
Jump to navigation Jump to search

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

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Flatlist

Used to create plain (i.e. unbulleted) lists.
⧼templatedata-doc-param-name⧽⧼templatedata-doc-param-desc⧽⧼templatedata-doc-param-type⧽⧼templatedata-doc-param-status⧽
Content1
The list to wrap.
⧼templatedata-doc-param-type-content⧽⧼templatedata-doc-param-status-suggested⧽
Extra Classesclass
Adds extra CSS classes to the containing div.
⧼templatedata-doc-param-type-string⧽⧼templatedata-doc-param-status-optional⧽
CSS Stylestyle
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-example⧽
border: solid 1px silver; background: lightyellow;
⧼templatedata-doc-param-type-string⧽⧼templatedata-doc-param-status-optional⧽
Indentindent
Indents the list by a number of standard indents (one indent being 1.6em). (Useful in an indented discussion thread.)
⧼templatedata-doc-param-example⧽
2
⧼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">
  • cat
  • dog
  • horse
  • cow
  • sheep
  • pig

</syntaxhighlight>

See also