Template:Flatlist/doc: Difference between revisions
No edit summary Tag: Reverted |
No edit summary |
||
| (18 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 --> | ||
| Line 4: | Line 6: | ||
{{tlr|startflatlist|flt}} | {{tlr|startflatlist|flt}} | ||
{{Uses TemplateStyles|Template:Hlist/styles.css}} | {{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 [[ | 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. | |||
{{TOC limit|3}} | {{TOC limit|3}} | ||
| Line 19: | Line 24: | ||
}} | }} | ||
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 == | |||
{{#switch:{{NAMESPACE}}:{{ROOTPAGENAME}}|#default= | |||
{{Format TemplateData|<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 [[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" | |||
] | |||
} | |||
</templatedata>}} | |||
|Template:Endflatlist= | |||
{{Format TemplateData|JSON= | |||
{ | |||
"description": "Ends a flat list created by {{tl|flatlist}}.", | |||
"format": "inline", | |||
"params": { | |||
} | |||
} | |||
}} | |||
}} | |||
== Examples == | == Examples == | ||
<syntaxhighlight lang=" | <syntaxhighlight lang="wikitext"> | ||
{{flatlist| | {{flatlist| | ||
* [[cat]] | * [[cat]] | ||
| Line 47: | Line 118: | ||
=== Alternative syntax === | === Alternative syntax === | ||
<syntaxhighlight lang=" | <syntaxhighlight lang="wikitext"> | ||
{{startflatlist}} | {{startflatlist}} | ||
* [[cat]] | * [[cat]] | ||
| Line 70: | Line 141: | ||
=== Syntax for ordered lists === | === Syntax for ordered lists === | ||
<syntaxhighlight lang=" | <syntaxhighlight lang="wikitext"> | ||
{{flatlist| | {{flatlist| | ||
# [[first]] | # [[first]] | ||
# [[second]] | # [[second]] | ||
# [[third]] | # [[3|third]] | ||
# [[fourth]] | # [[fourth]] | ||
# [[fifth]] | # [[fifth]] | ||
| Line 86: | Line 157: | ||
# [[first]] | # [[first]] | ||
# [[second]] | # [[second]] | ||
# [[third]] | # [[3|third]] | ||
# [[fourth]] | # [[fourth]] | ||
# [[fifth]] | # [[fifth]] | ||
| Line 93: | Line 164: | ||
=== Using optional parameters === | === Using optional parameters === | ||
<syntaxhighlight lang=" | <syntaxhighlight lang="wikitext"> | ||
{{flatlist |indent=2 | {{flatlist |indent=2 | ||
|style=border:solid 1px silver; background:lightyellow; | |style=border:solid 1px silver; background:lightyellow; | ||
| Line 118: | 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 | 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 125: | Line 196: | ||
! HTML | ! HTML | ||
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
| < | | <syntaxhighlight lang="wikitext"> | ||
{{flatlist| | {{flatlist| | ||
* cat | * cat | ||
| Line 134: | Line 205: | ||
* pig | * pig | ||
}} | }} | ||
</ | </syntaxhighlight> | ||
| {{nowiki2|tag=pre| | | {{nowiki2|tag=pre| | ||
{{flatlist| | {{flatlist| | ||