Template:Flatlist

Template documentation[view] [edit] [history] [purge]

"Template:Inline list" redirects here. For a navbox listing templates used within lines of text to mark problems needing attention, see Template:Inline cleanup tags.

This template provides a WCAG/ISO standards-compliant accessible alternative to comma-, dash- or other single character-delimited lists, per Manual of Style/Lists § Horizontal lists and Manual of Style:Accessibility § Horizontal lists.

Lists output by {{Flatlist}} and {{Hlist}} are semantically and visually identical, differing only in the underlying wiki-markup they expect as input to create the lists.

Usage

{{Flatlist}} starts a horizontal list, such as:

• cat
• dog
• horse
• cow
• sheep
• pig

If this template is used with no parameters, {{Endflatlist}} is required. 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. leading 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. See a monthly parameter usage report for Template:Flatlist in articles based on its TemplateData.

TemplateData for Flatlist

Used to create horizontal bulleted lists.

⧼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-example⧽ border: solid 1px silver; background: lightyellow; color: black;	⧼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-example⧽ 2	⧼templatedata-doc-param-type-number⧽	⧼templatedata-doc-param-status-optional⧽

Format: block

Examples

<syntaxhighlight lang="wikitext">

• cat
• dog
• horse
• cow
• sheep
• pig

</syntaxhighlight>

…produces:

• cat
• dog
• horse
• cow
• sheep
• pig

Alternative syntax

<syntaxhighlight lang="wikitext">

• cat
• dog
• horse
• cow
• sheep
• pig

</syntaxhighlight>

…produces:

• cat
• dog
• horse
• cow
• sheep
• pig

Syntax for ordered lists

<syntaxhighlight lang="wikitext">

1. first
2. second
3. third
4. fourth
5. fifth
6. sixth

</syntaxhighlight>

…produces:

1. first
2. second
3. third
4. fourth
5. fifth
6. sixth

Using optional parameters

<syntaxhighlight lang="wikitext">

• Alpine skiing at the 1936 Winter Olympics
• Alpine skiing at the 1948 Winter Olympics
• Alpine skiing at the 1952 Winter Olympics
• Alpine skiing at the 1956 Winter Olympics
• Alpine skiing at the 1960 Winter Olympics
• Alpine skiing at the 1964 Winter Olympics

</syntaxhighlight>

…produces:

• Alpine skiing at the 1936 Winter Olympics
• Alpine skiing at the 1948 Winter Olympics
• Alpine skiing at the 1952 Winter Olympics
• Alpine skiing at the 1956 Winter Olympics
• Alpine skiing at the 1960 Winter Olympics
• Alpine skiing at the 1964 Winter Olympics

Technical details

This template uses the <syntaxhighlight lang="text" class="" style="" inline="1">.hlist</syntaxhighlight> CSS class defined in Template:Hlist/styles.css to generate horizontal lists. It causes ordinary HTML list items to be displayed inline (horizontally), where normally they would be displayed as block elements (vertically). The class also generates the interpuncts between list items and parentheses around nested lists.

Wikitext	Expanded template	HTML
<syntaxhighlight lang="wikitext"> cat dog horse cow sheep pig </syntaxhighlight>	'"`UNIQ--templatestyles-0000001E-QINU`"'<div class="hlist " > * cat * dog * horse * cow * sheep * pig </div>	<syntaxhighlight lang="html"> cat dog horse cow sheep pig </syntaxhighlight>

Maintenance categories

• Category:Pages using flatlist with unknown parameters (0)

See also

• {{Endflatlist}}
• {{Hlist}}
• {{Plainlist}} and {{Unbulleted list}}
• {{Bulleted list}}
• {{Ordered list}}
• {{Nowrap}}
• {{Pagelist}}
• Manual of Style:Accessibility § Horizontal lists

The above documentation is transcluded from Template:Flatlist/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.