Template:Flatlist/doc: Difference between revisions

From Azupedia
Jump to navigation Jump to search
No edit summary
Tag: Reverted
No edit summary
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
<noinclude>
</noinclude>{{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}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{used in system|in [[MediaWiki:Pageinfo-header]]}}
{{used in system|in [[MediaWiki:Pageinfo-header]]}}
{{tlr|startflatlist|flt}}
{{Uses TemplateStyles|Template:Hlist/styles.css}}
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 [[MOS:HLIST]].
Lists output by {{tl|Flatlist}} and {{tl|Hlist}} are semantically and visually identical, and differ only in the wiki-markup used to create the lists.


{{Uses TemplateStyles|Template:Hlist/styles.css}}
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}}
{{TOC limit|3}}


Line 19: Line 24:
}}
}}


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.
If this template is used with no parameters, {{tl|endflatlist}} is required. 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.


== Parameters ==
== Parameters ==
Line 90: Line 95:


== Examples ==
== Examples ==
<syntaxhighlight lang="text">
<syntaxhighlight lang="wikitext">
{{flatlist|
{{flatlist|
* [[cat]]
* [[cat]]
Line 113: Line 118:


=== Alternative syntax ===
=== Alternative syntax ===
<syntaxhighlight lang="text">
<syntaxhighlight lang="wikitext">
{{startflatlist}}
{{startflatlist}}
* [[cat]]
* [[cat]]
Line 136: Line 141:


=== Syntax for ordered lists ===
=== Syntax for ordered lists ===
<syntaxhighlight lang="text">
<syntaxhighlight lang="wikitext">
{{flatlist|
{{flatlist|
# [[first]]
# [[first]]
# [[second]]
# [[second]]
# [[third]]
# [[3|third]]
# [[fourth]]
# [[fourth]]
# [[fifth]]
# [[fifth]]
Line 152: Line 157:
# [[first]]
# [[first]]
# [[second]]
# [[second]]
# [[third]]
# [[3|third]]
# [[fourth]]
# [[fourth]]
# [[fifth]]
# [[fifth]]
Line 159: Line 164:


=== Using optional parameters ===
=== Using optional parameters ===
<syntaxhighlight lang="text">
<syntaxhighlight lang="wikitext">
{{flatlist |indent=2  
{{flatlist |indent=2  
|style=border:solid 1px silver; background:lightyellow;  
|style=border:solid 1px silver; background:lightyellow;  
Line 184: Line 189:


== 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 some older browsers, notably Internet Explorer 6 and 7.
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.


{| class="wikitable"
{| class="wikitable"
Line 191: Line 196:
! HTML
! HTML
|- style="vertical-align:top;"
|- style="vertical-align:top;"
| <pre>
| <syntaxhighlight lang="wikitext">
{{flatlist|
{{flatlist|
* cat
* cat
Line 200: Line 205:
* pig
* pig
}}
}}
</pre>
</syntaxhighlight>
| {{nowiki2|tag=pre|
| {{nowiki2|tag=pre|
{{flatlist|
{{flatlist|

Latest revision as of 09:02, 3 June 2025

This template provides a WCAG/ISO-standards-compliant accessible alternative to comma- or dash- (or other single character-) separated lists, per WP:FLATLIST and MOS:HLIST.

Lists output by {{Flatlist}} and {{Hlist}} are semantically and visually identical, and differ only in the wiki-markup used to create the lists.

Usage

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

If this template is used with no parameters, {{endflatlist}} is required. 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

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Flatlist

Used to create plain (i.e. unbulleted) lists.
ParameterDescriptionTypeStatus
Content1
The list to wrap.
Contentsuggested
Extra Classesclass
Adds extra CSS classes to the containing div.
Stringoptional
CSS Stylestyle
Adds extra CSS properties to the containing div. Complex styles should not be used in articles (per MOS:DEVIATIONS) but may be acceptable on user, project and talk pages.
Example
border: solid 1px silver; background: lightyellow;
Stringoptional
Indentindent
Indents the list by a number of standard indents (one indent being 1.6em). (Useful in an indented discussion thread.)
Example
2
Numberoptional

Format: inline

Examples

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

produces:

Alternative syntax

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

produces:

Syntax for ordered lists

{{flatlist|
# [[first]]
# [[second]]
# [[3|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.

Wikitext Expanded template HTML
{{flatlist|
* cat
* dog
* horse
* cow
* sheep
* pig
}}
'"`UNIQ--templatestyles-0000001D-QINU`"'<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