Template:Flatlist/doc: Difference between revisions
From Guild of Archivists
m (1 revision imported) |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | ||
This template provides a [[w:Web Content Accessibility Guidelines|WCAG]]/ISO-standards-compliant accessible alternative to comma- or dash- (or other single character-) separated lists. | |||
This template provides a [[Web Content Accessibility Guidelines|WCAG]]/ISO-standards-compliant accessible alternative to comma- or dash- (or other single character-) separated lists | |||
==Usage== | ==Usage== | ||
| Line 14: | Line 7: | ||
{{flatlist| | {{flatlist| | ||
* [[ | * [[Atrus]] | ||
* [[ | * [[Catherine]] | ||
* [[ | * [[Sirrus]] | ||
* [[ | * [[Achenar]] | ||
* [[ | * [[Yeesha]] | ||
* [[ | * [[Ti'ana]] | ||
}} | }} | ||
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. | |||
==Examples== | ==Examples== | ||
<pre> | <pre> | ||
{{flatlist| | {{flatlist| | ||
* [[ | * [[Atrus]] | ||
* [[ | * [[Catherine]] | ||
* [[ | * [[Sirrus]] | ||
* [[ | * [[Achenar]] | ||
* [[ | * [[Yeesha]] | ||
* [[ | * [[Ti'ana]] | ||
}} | }} | ||
</pre> | </pre> | ||
| Line 39: | Line 32: | ||
{{flatlist| | {{flatlist| | ||
* [[ | * [[Atrus]] | ||
* [[ | * [[Catherine]] | ||
* [[ | * [[Sirrus]] | ||
* [[ | * [[Achenar]] | ||
* [[ | * [[Yeesha]] | ||
* [[ | * [[Ti'ana]] | ||
}} | }} | ||
===Syntax for ordered lists=== | ===Syntax for ordered lists=== | ||
<pre> | <pre> | ||
{{flatlist| | {{flatlist| | ||
# [[ | # [[Atrus]] | ||
# [[ | # [[Catherine]] | ||
# [[ | # [[Sirrus]] | ||
# [[ | # [[Achenar]] | ||
# [[ | # [[Yeesha]] | ||
# [[ | # [[Ti'ana]] | ||
}} | }} | ||
</pre> | </pre> | ||
| Line 85: | Line 55: | ||
{{flatlist| | {{flatlist| | ||
# [[ | # [[Atrus]] | ||
# [[ | # [[Catherine]] | ||
# [[ | # [[Sirrus]] | ||
# [[ | # [[Achenar]] | ||
# [[ | # [[Yeesha]] | ||
# [[ | # [[Ti'ana]] | ||
}} | }} | ||
==Parameters== | ==Parameters== | ||
* '''''class''''' adds a CSS class to the containing div. Use <tt>nowraplinks</tt> to prevent links from wrapping. | * '''''class''''' adds a CSS class to the containing div. Use <tt>nowraplinks</tt> to prevent links from wrapping. | ||
* '''''style''''' adds CSS styling to the containing div. Complex styles should not be used in articles | * '''''style''''' adds CSS styling to the containing div. Complex styles should not be used in articles, but may be acceptable on user, project and talk pages. | ||
::Example: {{para|<var>style</var>|<var>border:solid 1px silver; background:lightyellow</var>}} | ::Example: {{para|<var>style</var>|<var>border:solid 1px silver; background:lightyellow</var>}} | ||
* '''''indent''''' indents the list by a number of standard indents, one indent being 1. | * '''''indent''''' indents the list by a number of standard indents, one indent being 1.6em. (Useful in an indented discussion thread.) | ||
::Example: {{para|<var>indent</var>|<var>2</var>}} | ::Example: {{para|<var>indent</var>|<var>2</var>}} | ||
==Technical details== | ==Technical details== | ||
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 | 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 dots 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. | ||
==See also== | ==See also== | ||
* {{tl|hlist}} | * {{tl|hlist}} | ||
* | * {{tl|unbulleted list}} | ||
* {{tl|nowrap}} | * {{tl|nowrap}} | ||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| | ||
Latest revision as of 07:34, 11 July 2016
 | This is a documentation subpage for Template:Flatlist. It contains usage information, categories and other content that is not part of the original template page. |
This template provides a WCAG/ISO-standards-compliant accessible alternative to comma- or dash- (or other single character-) separated lists.
Usage[edit]
{{flatlist}} starts a horizontal list, such as:
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.
Examples[edit]
{{flatlist|
* [[Atrus]]
* [[Catherine]]
* [[Sirrus]]
* [[Achenar]]
* [[Yeesha]]
* [[Ti'ana]]
}}
produces:
Syntax for ordered lists[edit]
{{flatlist|
# [[Atrus]]
# [[Catherine]]
# [[Sirrus]]
# [[Achenar]]
# [[Yeesha]]
# [[Ti'ana]]
}}
produces:
Parameters[edit]
- 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, but may be acceptable on user, project and talk pages.
- Example:
|style=border:solid 1px silver; background:lightyellow
- Example:
- indent indents the list by a number of standard indents, one indent being 1.6em. (Useful in an indented discussion thread.)
- Example:
|indent=2
- Example:
Technical details[edit]
This template uses the .hlist 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 dots 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.
See also[edit]
- {{hlist}}
- {{unbulleted list}}
- {{nowrap}}
