You are browsing a read-only backup copy of Wikitech. The live site can be found at wikitech.wikimedia.org

Template:Flatlist/doc

From Wikitech-static
Jump to navigation Jump to search

Lua error in Module:TNT at line 159: Missing JsonConfig extension; Cannot load https://commons.wikimedia.org/wiki/Data:I18n/Uses TemplateStyles.tab. 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

Parameters

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Flatlist

<templatedata> { "description": { "en": "Used to create plain (i.e. unbulleted) lists." }, "format": "inline", "params": { "1": { "label": { "en": "Content" }, "description": { "en": "The list to wrap." }, "suggested": true, "type": "content" }, "class": { "label": { "en": "Extra Classes" }, "description": { "en": "Adds extra CSS classes to the containing div." }, "type": "string" }, "style": { "label": { "en": "CSS Style" }, "description": { "en": "Adds extra CSS properties to the containing div." }, "example": "\n border: solid 1px silver;\n background: lightyellow;\n", "type": "string" }, "indent": { "label": { "en": "Indent" }, "description": { "en": "Indents the list by a number of standard indents (one indent being 1.6em), particularly handy for inclusion in an indented discussion thread." }, "example": "2", "type": "number" } }, "paramOrder": [ "class", "style", "indent", "1" ] } </templatedata>

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 " >
* 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

Template:Navbox lists