Template:Hlist/doc

From Pantonian Republic Wiki
< Template:Hlist
Revision as of 17:12, 26 January 2022 by wikipedia>Jonesey95 (→‎Avoiding Linter errors: rm smaller post-merge)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This template creates horizontal lists. Each item in the list may be individually styled with CSS.

Usage

Basic usage

{{hlist|first item|second item|third item|...}}

All parameters

{{hlist
|first item|second item|third item|...
|class       = class for div tag
|style       = style for div tag
|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      = the number of tabs to indent
}}

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] tags surrounding the list. Set to inline when using {{hlist}} inside text.
  • style: a custom CSS style for the[div] tags surrounding the list, e.g. font-size: 90%;.
  • list_style: a custom CSS style for the[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] 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: the number of tabs to indent the list. Default value is 0.

Examples

Markup Renders as
{{hlist|entry1|entry2|entry3|entry4|entry5|entry6|entry7|entry8|entry9}}
  • entry1
  • entry2
  • entry3
  • entry4
  • entry5
  • entry6
  • entry7
  • entry8
  • entry9
Giant planets ({{hlist|[[Jupiter|J]]|[[Saturn|S]]|[[Uranus|U]]|[[Neptune|N]]}}).
Giant planets ().
Giant planets ({{hlist|class=inline|[[Jupiter|J]]|[[Saturn|S]]|[[Uranus|U]]|[[Neptune|N]]}}).
Giant planets ().
{{hlist|Winner|Runner-up|Third place|indent=2}}
  • Winner
  • Runner-up
  • Third place
{{hlist|Winner|Runner-up|Third place|item_style=color:blue;}}
  • Winner
  • Runner-up
  • Third place
{{hlist|Winner|Runner-up|Third place|item1_style=background-color:yellow;|item2_style=background-color:silver;}}
  • Winner
  • Runner-up
  • Third place

Avoiding Linter errors

{{hlist}} will produce Linter errors if placed inside a template that uses[span] tags, such as {{small}}, {{larger}}, etc. To avoid this, use the substitutions from the table below:

Incorrect markup Correct markup
{{small|{{hlist|...}}}} {{hlist|...|style=font-size:85%}}
{{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}}