Template:Flatlist

Template documentation

This documentation is  transcluded from Template:Flatlist/doc. (Edit | history)
Note to editors: Please don't categorize this template by editing it directly. Instead, place the category in its documentation page, in its "includeonly" section.

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:

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

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, list (i.e. asterisk) markup does not work, so consider using {{hlist}} instead.

Parameters

{{#switch:Template: Flatlist |#default=

 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. Complex styles should not be used in articles (per {{Wikipedia|MOS:DEVIATIONS}}) but may be acceptable on user, project and talk pages."
			},
			"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.6[[em (typography)|em]]). (Useful in an indented discussion thread.)"
			},
			"example": "2",
			"type": "number"
		}
	},
	"paramOrder": [
		"class",
		"style",
		"indent",
		"1"
	]
}

Examples

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

produces:

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

Alternative syntax

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

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:

• 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

Technical details

This template uses the .hlist  CSS class defined in  MediaWiki: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 some older browsers, notably Internet Explorer 6 and 7.

Wikitext	Expanded template	HTML
{{flatlist| * cat * dog * horse * cow * sheep * pig }}	Template:Nowiki2	<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

• {{endflatlist}}
• {{hlist}}
• {{plainlist}} and {{unbulleted list}}
• {{bulleted list}}
• {{ordered list}}
• {{nowrap}}
• {{pagelist}}
• WP:HLIST

Flat	{{hlist}} {{hlist |item1 |item2 |...}} item1 item2 ...	{{flatlist}} {{flatlist| * item1 * item2 * ...}} item1 item2 ...	{{cslist}} {{cslist |item1 |item2 |...}} {{bold list}} {{bold list |item1 |item2 |...}}
Bulleted and Ordered	{{bulleted list}} {{bulleted list |item1 |item2 |...}}		{{ordered list}} {{Ordered list |list_style_type=lower-alpha |first |second |...}}
Unbulleted	{{unbulleted list}} {{unbulleted list |item1 |item2 |...}} item1 item2 ...	{{plainlist}} {{plainlist| * item1 * item2 * ...}} item1 item2 ...	{{glossary}} (glossary, description, definition, association) {{glossary}} {{term|first term}} {{defn|first description}} {{term|second term}} {{defn|second description}} {{term|...}} {{defn|....}} {{glossary end}} first term Template:Defn second term Template:Defn ... Template:Defn Template:Glossary end
Other	{{flowlist}} [[File:Bad Title Example.png|left|thumb|100px]] {{flowlist| *item1 *item2 *...}}	{{columns-list}} {{columns-list|colwidth=5em| # first # second # third # ...}}