Template:Flatlist/doc: Difference between revisions

From Celestial Lance Universe Wiki
Jump to navigation Jump to search
(Created page with "{{Documentation subpage}} <!-- Add categories where indicated at the bottom of this page --> {{used in system|in MediaWiki:Pageinfo-header}} {{tlr|startflatlist|flt}} {{Uses TemplateStyles|Template:Hlist/styles.css}} This template provides a Web Content Accessibility Guideline (WCAG)/ISO-standards-compliant accessible alternative to comma- or dash- (or other single character-) separated lists. Lists output by {{tl|Flatlist}} and {{tl|Hlist}} are semantically and vis...")
 
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 57: Line 57:
},
},
"description": {
"description": {
"en": "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."
"en": "Adds extra CSS properties to the containing div. "
},
},
"example": "\n border: solid 1px silver;\n background: lightyellow;\n",
"example": "\n border: solid 1px silver;\n background: lightyellow;\n",
Line 67: Line 67:
},
},
"description": {
"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.)"
"en": "Indents the list by a number of standard indents (one indent being 1.6em). (Useful in an indented discussion thread.)"
},
},
"example": "2",
"example": "2",
Line 95: Line 95:
<syntaxhighlight lang="wikitext">
<syntaxhighlight lang="wikitext">
{{flatlist|
{{flatlist|
* [[cat]]
* [[Sol system]]
* [[dog]]
* [[Alpha Centauri system]]
* [[horse]]
* [[Procyon system]]
* [[cow]]
* [[Hawkeye system]]
* [[sheep]]
* [[Casey system]]
* [[pig]]
* [[Ikeda system]]
}}
}}
</syntaxhighlight>
</syntaxhighlight>
Line 107: Line 107:


{{flatlist|
{{flatlist|
* [[cat]]
* [[Sol system]]
* [[dog]]
* [[Alpha Centauri system]]
* [[horse]]
* [[Procyon system]]
* [[cow]]
* [[Hawkeye system]]
* [[sheep]]
* [[Casey system]]
* [[pig]]
* [[Ikeda system]]
}}
}}


Line 118: Line 118:
<syntaxhighlight lang="wikitext">
<syntaxhighlight lang="wikitext">
{{startflatlist}}
{{startflatlist}}
* [[cat]]
* [[Sol system]]
* [[dog]]
* [[Alpha Centauri system]]
* [[horse]]
* [[Procyon system]]
* [[cow]]
* [[Hawkeye system]]
* [[sheep]]
* [[Casey system]]
* [[pig]]
* [[Ikeda system]]
{{endflatlist}}
{{endflatlist}}
</syntaxhighlight>
</syntaxhighlight>
Line 130: Line 130:


{{startflatlist}}
{{startflatlist}}
* [[cat]]
* [[Sol system]]
* [[dog]]
* [[Alpha Centauri system]]
* [[horse]]
* [[Procyon system]]
* [[cow]]
* [[Hawkeye system]]
* [[sheep]]
* [[Casey system]]
* [[pig]]
* [[Ikeda system]]
{{endflatlist}}
{{endflatlist}}


Line 141: Line 141:
<syntaxhighlight lang="wikitext">
<syntaxhighlight lang="wikitext">
{{flatlist|
{{flatlist|
# [[first]]
# [[Sol system]]
# [[second]]
# [[Alpha Centauri system]]
# [[3|third]]
# [[Procyon system]]
# [[fourth]]
# [[Hawkeye system]]
# [[fifth]]
# [[Casey system]]
# [[sixth]]
# [[Ikeda system]]
}}
}}
</syntaxhighlight>
</syntaxhighlight>
Line 153: Line 153:


{{flatlist|
{{flatlist|
# [[first]]
# [[Sol system]]
# [[second]]
# [[Alpha Centauri system]]
# [[3|third]]
# [[Procyon system]]
# [[fourth]]
# [[Hawkeye system]]
# [[fifth]]
# [[Casey system]]
# [[sixth]]
# [[Ikeda system]]
}}
}}


Line 179: Line 179:
{{flatlist |indent=2 |style=border:solid 1px silver; background:lightyellow; |class=nowraplinks |
{{flatlist |indent=2 |style=border:solid 1px silver; background:lightyellow; |class=nowraplinks |
* [[Sol system]]
* [[Sol system]]
* [[Alpha Centauri]]
* [[Alpha Centauri system]]
* [[Procyon system]]
* [[Procyon system]]
* [[Hawkeye system]]
* [[Hawkeye system]]

Latest revision as of 18:07, 10 April 2025

This template provides a Web Content Accessibility Guideline (WCAG)/ISO-standards-compliant accessible alternative to comma- or dash- (or other single character-) separated lists.

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.
Content1
The list to wrap.
Extra Classesclass
Adds extra CSS classes to the containing div.
CSS Stylestyle
Adds extra CSS properties to the containing div.
Example
border: solid 1px silver;
background: lightyellow;
Indentindent
Indents the list by a number of standard indents (one indent being 1.6em). (Useful in an indented discussion thread.)
Example
2

Examples

{{flatlist|
* [[Sol system]]
* [[Alpha Centauri system]]
* [[Procyon system]]
* [[Hawkeye system]]
* [[Casey system]]
* [[Ikeda system]]
}}

produces:

Alternative syntax

{{startflatlist}}
* [[Sol system]]
* [[Alpha Centauri system]]
* [[Procyon system]]
* [[Hawkeye system]]
* [[Casey system]]
* [[Ikeda system]]
{{endflatlist}}

produces:

Syntax for ordered lists

{{flatlist|
# [[Sol system]]
# [[Alpha Centauri system]]
# [[Procyon system]]
# [[Hawkeye system]]
# [[Casey system]]
# [[Ikeda system]]
}}

produces:

Using optional parameters

{{flatlist |indent=2 
|style=border:solid 1px silver; background:lightyellow; 
|class=nowraplinks |
* [[Sol system]]
* [[Alpha Centauri system]]
* [[Procyon system]]
* [[Hawkeye system]]
* [[Casey system]]
* [[Ikeda system]]
}}

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-0000001B-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