Difference between revisions of "Template:Flatlist/doc"

From blackwiki
Jump to navigation Jump to search
imported>Pigsonthewing
(→‎top: ce)
imported>Redrose64
(→‎Examples: no need for leading spaces, and if copypasted, they break)
 
(57 intermediate revisions by 28 users not shown)
Line 1: Line 1:
 +
{{redirect|Template:Inline list|a navbox listing templates used within lines of text to mark problems needing attention|Template:Inline cleanup tags}}
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE -->
{{TOClimit|3}}
+
{{#switch:{{FULLPAGENAME}}
 
+
| Template:Flatlist    = {{High-risk|117,000+}}
 +
| Template:Endflatlist = {{High-risk|80,000+}}
 +
}}
 
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]].
 
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]].
 +
{{TOC limit|3}}
  
 
==Usage==
 
==Usage==
 +
{{tlf|flatlist}} starts a horizontal list, such as:
  
{{tl|flatlist}} starts a horizontal list, such as:
+
{{flatlist|
 
 
{{flatlist}}
 
 
* [[cat]]
 
* [[cat]]
 
* [[dog]]
 
* [[dog]]
Line 16: Line 19:
 
* [[sheep]]
 
* [[sheep]]
 
* [[pig]]
 
* [[pig]]
{{endflatlist}}
+
}}
 +
 
 +
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, list (i.e. asterisk) markup does not work, so consider using {{tl|hlist}} instead.
  
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}}.
+
==Optional parameters==
 +
; class
 +
: Adds a CSS class to the containing div. Use <code>nowraplinks</code> to prevent links from wrapping.
  
For navigation boxes using {{tl|navbox}}, one can set {{para|listclass|hlist}}, and achieve the same styling without using this template.
+
; 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: {{para|<var>style</var>|<var>border:solid 1px silver; background:lightyellow</var>}}
  
For image captions, * (i.e. asterisk) markup does not work, so consider using {{tl|hlist}} instead.
+
; 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>}}
  
 
==Examples==
 
==Examples==
 
+
<syntaxhighlight lang="moin">
<div style="padding-bottom:1.0em;">
 
 
 
<pre>
 
 
{{flatlist|
 
{{flatlist|
 
* [[cat]]
 
* [[cat]]
Line 37: Line 45:
 
* [[pig]]
 
* [[pig]]
 
}}
 
}}
</pre>
+
</syntaxhighlight>
  
 
produces:
 
produces:
Line 49: Line 57:
 
* [[pig]]
 
* [[pig]]
 
}}
 
}}
</div>
 
  
 
===Alternative syntax===
 
===Alternative syntax===
 
+
<syntaxhighlight lang="moin">
<div style="padding-bottom:1.0em;">
+
{{startflatlist}}
<pre>
 
{{flatlist}}  or  {{startflatlist}}
 
 
* [[cat]]
 
* [[cat]]
 
* [[dog]]
 
* [[dog]]
Line 63: Line 68:
 
* [[pig]]
 
* [[pig]]
 
{{endflatlist}}
 
{{endflatlist}}
</pre>
+
</syntaxhighlight>
  
 
produces:
 
produces:
  
{{flatlist}}
+
{{startflatlist}}
 
* [[cat]]
 
* [[cat]]
 
* [[dog]]
 
* [[dog]]
Line 75: Line 80:
 
* [[pig]]
 
* [[pig]]
 
{{endflatlist}}
 
{{endflatlist}}
</div>
 
  
 
===Syntax for ordered lists===
 
===Syntax for ordered lists===
 
+
<syntaxhighlight lang="moin">
<div style="padding-bottom:1.0em;">
+
{{flatlist|
<pre>
 
{{startflatlist}}
 
 
# [[first]]
 
# [[first]]
 
# [[second]]
 
# [[second]]
Line 88: Line 90:
 
# [[fifth]]
 
# [[fifth]]
 
# [[sixth]]
 
# [[sixth]]
{{endflatlist}}
+
}}
</pre>
+
</syntaxhighlight>
  
 
produces:
 
produces:
  
{{startflatlist}}
+
{{flatlist|
 
# [[first]]
 
# [[first]]
 
# [[second]]
 
# [[second]]
Line 100: Line 102:
 
# [[fifth]]
 
# [[fifth]]
 
# [[sixth]]
 
# [[sixth]]
{{endflatlist}}
+
}}
</div>
+
 
 +
=== Using optional parameters ===
 +
<syntaxhighlight lang="moin">
 +
{{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]]
 +
}}
 +
</syntaxhighlight>
  
==Parameters==
+
produces:
  
* '''''class''''' adds a CSS class to the containing div. Use <tt>nowraplinks</tt> to prevent links from wrapping.
+
{{flatlist |indent=2 |style=border:solid 1px silver; background:lightyellow; |class=nowraplinks |
* '''''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.
+
* [[Alpine skiing at the 1936 Winter Olympics]]
::Example: {{para|<var>style</var>|<var>border:solid 1px silver; background:lightyellow</var>}}
+
* [[Alpine skiing at the 1948 Winter Olympics]]
* '''''indent''''' indents the list by a number of standard indents, one indent being 1.6[[Em (typography)|em]]. (Useful in an indented discussion thread.)
+
* [[Alpine skiing at the 1952 Winter Olympics]]
::Example: {{para|<var>indent</var>|<var>2</var>}}
+
* [[Alpine skiing at the 1956 Winter Olympics]]
 +
* [[Alpine skiing at the 1960 Winter Olympics]]
 +
* [[Alpine skiing at the 1964 Winter Olympics]]
 +
}}
  
 
==Technical details==
 
==Technical details==
 +
This template uses the <code>.hlist</code> [[Cascading Style Sheets|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 [[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.
  
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.
+
{| class="wikitable"
 +
! Wikitext
 +
! Expanded template
 +
! HTML
 +
|- style="vertical-align:top;"
 +
| <pre>
 +
{{flatlist|
 +
* cat
 +
* dog
 +
* horse
 +
* cow
 +
* sheep
 +
* pig
 +
}}
 +
</pre>
 +
| {{nowiki2|tag=pre|
 +
{{flatlist|
 +
* cat
 +
* dog
 +
* horse
 +
* cow
 +
* sheep
 +
* pig
 +
}}
 +
}}
 +
| <syntaxhighlight lang="html">
 +
<div class="hlist">
 +
<ul><li>cat</li>
 +
<li>dog</li>
 +
<li>horse</li>
 +
<li>cow</li>
 +
<li>sheep</li>
 +
<li>pig</li></ul>
 +
</div>
 +
</syntaxhighlight>
 +
|}
 +
 
 +
==Redirects==
 +
* {{tl|startflatlist}}
 +
* {{tl|endflatlist}}
 +
* {{tl|flt}}
  
 
==See also==
 
==See also==
 
* {{tl|startflatlist}} and {{tl|endflatlist}}
 
 
* {{tl|hlist}}
 
* {{tl|hlist}}
 
* {{tl|plainlist}} and {{tl|unbulleted list}}
 
* {{tl|plainlist}} and {{tl|unbulleted list}}
* {{tl|ordered list}} and {{tl|unordered list}}
+
* {{tl|bulleted list}}
 +
* {{tl|ordered list}}
 
* {{tl|multi-column numbered list}}
 
* {{tl|multi-column numbered list}}
 
* {{tl|nowrap}}
 
* {{tl|nowrap}}
 
* {{tl|pagelist}}
 
* {{tl|pagelist}}
 
* [[WP:HLIST]]
 
* [[WP:HLIST]]
 
+
{{HTML lists}}
<includeonly>
+
<includeonly>{{Sandbox other||
{{#ifeq:{{SUBPAGENAME}}|sandbox |
+
<!-- CATEGORIES HERE, THANKS -->
| [[Category:Typing-aid templates]] [[Category:Wikipedia list formatting templates]]
+
[[Category:Typing-aid templates|Flatlist]]
}}
+
[[Category:List formatting and function templates|Flatlist]]
</includeonly>
+
}}</includeonly>

Latest revision as of 09:57, 29 December 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