View source for Template:Flatlist/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{TOClimit|3}}

This template provides a [[Web Content Accessibility Guidelines|WCAG]]/ISO-standards-compliant accessible alternative to comma- or dash- (or other single character-) separated lists, per [[WP:FLATLIST]] and [[WP:HLIST]].

==Usage==

{{tl|flatlist}} starts a horizontal list, such as:

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

The bottom margin is inherited from the current container. Normally this will be 0.5[[Em (typography)|em]]. This template can be used with or without {{tl|endflatlist}}.

For navigation boxes using {{tl|navbox}}, one can set {{para|listclass|hlist}}, and achieve the same styling without using this template.

For image captions, * (i.e. asterisk) markup does not work, so consider using {{tl|hlist}} instead.

==Examples==

<div style="padding-bottom:1.0em;">

<pre>
{{flatlist|
* [[cat]]
* [[dog]]
* [[horse]]
* [[cow]]
* [[sheep]]
* [[pig]]
}}
</pre>

produces:

{{flatlist|
* [[cat]]
* [[dog]]
* [[horse]]
* [[cow]]
* [[sheep]]
* [[pig]]
}}
</div>

===Alternative syntax===

<div style="padding-bottom:1.0em;">
<pre>
{{flatlist}}  or  {{startflatlist}}
* [[cat]]
* [[dog]]
* [[horse]]
* [[cow]]
* [[sheep]]
* [[pig]]
{{endflatlist}}
</pre>

produces:

{{flatlist}}
* [[cat]]
* [[dog]]
* [[horse]]
* [[cow]]
* [[sheep]]
* [[pig]]
{{endflatlist}}
</div>

===Syntax for ordered lists===

<div style="padding-bottom:1.0em;">
<pre>
{{startflatlist}}
# [[first]]
# [[second]]
# [[third]]
# [[fourth]]
# [[fifth]]
# [[sixth]]
{{endflatlist}}
</pre>

produces:

{{startflatlist}}
# [[first]]
# [[second]]
# [[third]]
# [[fourth]]
# [[fifth]]
# [[sixth]]
{{endflatlist}}
</div>

==Parameters==

* '''''class''''' adds a CSS class to the containing div. Use <tt>nowraplinks</tt> 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: {{para|<var>style</var>|<var>border:solid 1px silver; background:lightyellow</var>}}
* '''''indent''''' indents the list by a number of standard indents, one indent being 1.6[[Em (typography)|em]]. (Useful in an indented discussion thread.)
::Example: {{para|<var>indent</var>|<var>2</var>}}

==Technical details==

This template uses the <code>.hlist</code> 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 [[interpunct]]s 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.

==See also==

* {{tl|startflatlist}} and {{tl|endflatlist}}
* {{tl|hlist}}
* {{tl|plainlist}} and {{tl|unbulleted list}}
* {{tl|ordered list}} and {{tl|unordered list}}
* {{tl|multi-column numbered list}}
* {{tl|nowrap}}
* {{tl|pagelist}}
* [[WP:HLIST]]

<includeonly>
{{#ifeq:{{SUBPAGENAME}}|sandbox |
 | [[Category:Typing-aid templates]] [[Category:Wikipedia list formatting templates]]
}}
</includeonly>