Difference between revisions of "Template:Flatlist/doc"

From blackwiki
Jump to navigation Jump to search
imported>Jonesey95
m (Fix Linter errors using AutoEd)
imported>WOSlinker
m (change source to syntaxhighlight)
Line 36: Line 36:
  
 
==Examples==
 
==Examples==
<source lang="moin">
+
<syntaxhighlight lang="moin">
 
  {{flatlist|
 
  {{flatlist|
 
  * [[cat]]
 
  * [[cat]]
Line 45: Line 45:
 
  * [[pig]]
 
  * [[pig]]
 
  }}
 
  }}
</source>
+
</syntaxhighlight>
  
 
produces:
 
produces:
Line 59: Line 59:
  
 
===Alternative syntax===
 
===Alternative syntax===
<source lang="moin">
+
<syntaxhighlight lang="moin">
 
  {{startflatlist}}
 
  {{startflatlist}}
 
  * [[cat]]
 
  * [[cat]]
Line 68: Line 68:
 
  * [[pig]]
 
  * [[pig]]
 
  {{endflatlist}}
 
  {{endflatlist}}
</source>
+
</syntaxhighlight>
  
 
produces:
 
produces:
Line 105: Line 105:
  
 
=== Using optional parameters ===
 
=== Using optional parameters ===
<source lang="moin">
+
<syntaxhighlight lang="moin">
 
  {{flatlist |indent=2  
 
  {{flatlist |indent=2  
 
  |style=border:solid 1px silver; background:lightyellow;  
 
  |style=border:solid 1px silver; background:lightyellow;  
Line 116: Line 116:
 
  * [[Alpine skiing at the 1964 Winter Olympics]]
 
  * [[Alpine skiing at the 1964 Winter Olympics]]
 
  }}
 
  }}
</source>
+
</syntaxhighlight>
  
 
produces:
 
produces:

Revision as of 12:40, 7 July 2020

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:

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.

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. 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. (Useful in an indented discussion thread.)
Example: |indent=2

Examples

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

produces:

Alternative syntax

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

produces:

Template:Startflatlist

Syntax for ordered lists

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

produces:

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 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 all 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>

Redirects

See also