Template:Flatlist/doc

This is a documentation subpage for Template:Flatlist.
It may contain usage information, categories and other content that is not part of the original template page.

Usage change

{{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.

Examples change

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

Alternative syntax

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

Syntax for ordered lists

{{flatlist | class=hnum |
# [[first]]
# [[second]]
# [[third]]
# [[fourth]]
# [[fifth]]
# [[sixth]]
}}

Parameters change

class – adds a CSS class to the containing div. Passing hnum will cause ordered lists to have numbers.
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.

Example: |style=border:solid 1px silver; background:lightyellow

indent – indents the list by a number of standard indents (one indent being 1.6em), particularly handy for inclusion in an indented discussion thread.

Example: |indent=2

Technical details change

This template uses the .hlist CSS class defined in Common.css to generate horizontal lists. It causes ordinary html list items to be dispayed 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.

Bugs change

There are some situations where the .hlist class will fail in one or more browsers:

Internet Explorer 8 and 9: If a horizontal list is embedded in a table (such as a navbox), and the list items start with an image, IE will fail to wrap the list to the next line, causing it to display beyond the page boundaries. This can be fixed by adding   in front of the images.
All browsers: When a horizontal list, built using wiki markup, is displayed on Special: pages (where it may be transcluded from MediaWiki: pages), horizontal lists will not wrap to the next line. This is due to HTML Tidy not being active on these pages. This may be fixed in the future (Bugzilla:39617). As a workaround, use HTML instead of wiki markup to build the lists.