Template:Hlist/doc
This is a documentation subpage for Template:Hlist. It contains usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 98,000 pages, so changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Please consider discussing changes on the talk page before implementing them. |
This template uses Lua: |
This template creates horizontal lists. Each item in the list may have CSS styles added to it individually, by appending a numbered parameter.
Usage
Basic usage
{{hlist|first item|second item|third item|...}}
All parameters
{{hlist |first item|second item|third item|... |class = class |style = style |list_style = style for ul tag |item_style = style for all li tags |item1_style = style for first li tag |item2_style = style for second li tag |... |indent = indent for the list }}
Parameters
- Positional parameters (
1
,2
,3
...): these are the list items. If no list items are present, the module will output nothing. class
: a custom class for the<div>...</div>
tags surrounding the list, e.g.plainlinks
.style
: a custom CSS style for the<div>...</div>
tags surrounding the list, e.g.font-size: 90%;
.list_style
: a custom CSS style for the<ul>...</ul>
tags around the list. The format is the same as for the|style=
parameter.item_style
: a custom CSS style for all of the list items (the<li>...</li>
tags). The format is the same as for the|style=
parameter.item1_style
,item2_style
,item3_style
...: custom CSS styles for each of the list items. The format is the same as for the|style=
parameter.indent
: this parameter indents the list. The value must be a number, e.g.2
. The indent is calculated in em, and is 1.6 times the value specified. If no indent is specified, the default is zero.
Examples
Markup | Renders as |
---|---|
{{hlist|entry1|entry2|entry3|entry4|entry5|entry6|entry7|entry8|entry9}} |
|
{{hlist|Winner|Runner-up|Third place|item_style=color:blue;}} |
|
{{hlist|Winner|Runner-up|Third place|item_style=color:blue;|indent=2}} |
|
{{hlist|Winner|Runner-up|Third place|item1_style=background-color:yellow;|item2_style=background-color:silver;}} |
|
Avoiding Linter errors
{{hlist}} will produce Linter errors if placed inside a template that uses <span>...</span>
tags, such as {{small}}, {{smaller}}, {{larger}}, etc. To avoid this, use the substitutions from the table below:
Incorrect markup | Correct markup |
---|---|
{{small|{{hlist|...}}}} |
{{hlist|...|style=font-size:85%}}
|
{{smaller|{{hlist|...}}}} |
{{hlist|...|style=font-size:90%}}
|
{{resize|{{hlist|...}}}} |
{{hlist|...|style=font-size:90%}}
|
{{midsize|{{hlist|...}}}} |
{{hlist|...|style=font-size:92%}}
|
{{larger|{{hlist|...}}}} |
{{hlist|...|style=font-size:110%}}
|
{{big|{{hlist|...}}}} |
{{hlist|...|style=font-size:120%}}
|
{{large|{{hlist|...}}}} |
{{hlist|...|style=font-size:large}}
|
{{huge|{{hlist|...}}}} |
{{hlist|...|style=font-size:180%}}
|
{{resize|x%|{{hlist|...}}}} |
{{hlist|...|style=font-size:x%}}
|
{{font|size=x%|{{hlist|...}}}} |
{{hlist|...|style=font-size:x%}}
|
{{nowrap|{{hlist|...}}}} |
{{hlist|...|style=white-space: nowrap}}
|