Template:Flatlist/doc

From xx network wiki
Jump to navigation Jump to search
This is a community contributed page

This template provides a WCAG/ISO-standards-compliant accessible alternative to comma or dash (or other single character) separated lists.

Usage

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

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

Optional parameters

class
Adds a CSS class to the containing div. Use nowraplinks to prevent links from wrapping.
style
Adds CSS styling to the containing div.
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

Examples

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

produces:

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

Syntax for ordered lists

{{flatlist|
# first
# second
# third
# fourth
# fifth
# sixth
}}

produces:

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

Using optional parameters

 {{flatlist |indent=2 
 |style=border:solid 1px silver; background:lightyellow; 
 |class=nowraplinks |
 * 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
 }}

produces:

Technical details

This template uses the .hlist CSS class defined in the TemplateStyles 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.

Wikitext Expanded template HTML
{{flatlist|
* cat
* dog
* horse
* cow
* sheep
* pig
}}
<div class="hlist hlist-separated " >
* cat
* dog
* horse
* cow
* sheep
* pig

</div>
<div class="hlist">
<ul><li>cat</li>
<li>dog</li>
<li>horse</li>
<li>cow</li>
<li>sheep</li>
<li>pig</li></ul>
</div>

See also