Template:Flatlist/doc View history

Revision as of 06:51, 29 June 2014 by Kentsmith9 (talk | contribs) (Created initial doc)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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.

Template:TOClimit

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:

The bottom margin is inherited from the current container. Normally this will be 0.5em. 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, * (i.e. asterisk) markup does not work, so consider using {{hlist}} instead.

Examples

{{flatlist|
* [[cat]]
* [[dog]]
* [[horse]]
* [[cow]]
* [[sheep]]
* [[pig]]
}}

produces:

Alternative syntax

{{flatlist}}  or  {{startflatlist}}
* [[cat]]
* [[dog]]
* [[horse]]
* [[cow]]
* [[sheep]]
* [[pig]]
{{endflatlist}}

produces:

Syntax for ordered lists

{{startflatlist}}
# [[first]]
# [[second]]
# [[third]]
# [[fourth]]
# [[fifth]]
# [[sixth]]
{{endflatlist}}

produces:

Parameters

  • class adds a CSS class to the containing div. Use nowraplinks to prevent links from wrapping.
  • style adds CSS styling. Complex styles should not be used in articles (per WP:Deviations) but may be acceptable on user, project and talk pages.
Example: |style=border:solid 1px silver; background:lightyellow
  • indent indents the list by a number of standard indents, one indent being 1.6em. (Useful in an indented discussion thread.)
Example: |indent=2

Technical details

This template uses the .hlist CSS class defined in 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. In these cases, JavaScript in Common.js generates the interpuncts and parentheses.