Template:Ordered list/sandbox

This is the template sandbox page for Template:Ordered list (diff).
See also the companion subpage for test cases.

Template documentation[view] [edit] [history] [purge]

This template is used on approximately 5,200 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

Module:List (sandbox)

Shortcut

{{olist}}

Usage

This template creates an ordered list, which is similar to a numbered list but may display other characters, such as roman numbers or alphabet letters, instead of the decimal enumerator.

Syntax

Simple: {{Ordered list |entry1 |entry2| ... }}
Offset starting value: {{Ordered list |start=start|entry1 |entry2 |... |item1_style=CSS1 |item2_style=CSS2| ... }}
Changing the symbol style: {{Ordered list |list_style_type=type |entry1 |entry2 |... }}
With CSS style: {{Ordered list |item_style=CSS-all |entry1 |entry2 |... }}
With separate CSS styles for each item: {{Ordered list |entry1 |item1_style=CSS1 |entry2 |item2_style=CSS2 |... }}
With custom values for each item: {{Ordered list |item1_value=value1 |entry1 |item2_value=value2 |entry2 |... }}

Parameters' description
Parameter	Description
`list_style_type` or `list-style-type` type	This parameter indicates the list style type. Popular acceptable parameters include: `decimal (1, 2, 3, 4, ...)` `lower-roman (i, ii, iii, iv, ...)` `upper-roman (I, II, III, IV, ...)` `lower-alpha (a, b, c, d, ...)` `upper-alpha (A, B, C, D, ...)` For a full list, see the following section.
Positional parameters entry1 entry2 ...	The contents of each list item, as unnamed or positional parameters. There is no restriction on content, except equal signs (=) must be escaped or replaced with `{{=}}`, lest it will be interpreted a named parameter.
`itemn_value` value1 value2 ...	Ordinal or label for a specific list item; a positive integer.
`start`	Ordinal or label for the first item in the list; a positive integer (default is 1).
`itemn_style` CSS1 CSS2 ...	Cascading Style Sheet (CSS) styles that are set on a specific list item. (User must know CSS syntax.) For example, individual labels can be hidden by setting `itemn_style=list-style-type:none;`
`item_style` CSS-all	CSS styles that are set on each list item. (User must know CSS syntax.) When present, any `itemn_style` are disregarded.

References

Make an ordered list. The default is a numbered list, but you can change it to a list with roman numbers or letters of the English, Greek, Armenian or Georgian alphabets, instead of the decimal enumerator.

Template parameters[Edit template data]
This template prefers block formatting of parameters.
Parameter		Description	Type	Status
First item to list	`1`	no description	Unknown	required
Second item to list	`2`	no description	Unknown	optional
Third item to list	`3`	no description	Unknown	optional
Fourth item to list	`4`	no description	Unknown	optional
Fifth item to list	`5`	no description	Unknown	optional
Sixth item to list	`6`	no description	Unknown	optional
Seventh item to list	`7`	no description	Unknown	optional
Eighth item to list	`8`	no description	Unknown	optional
Ninth item to list	`9`	no description	Unknown	optional
Tenth item to list	`10`	no description	Unknown	optional
Type of list	`list_style_type`	no description Suggested values `none` `disc` `circle` `square` `decimal` `decimal-leading-zero` `lower-roman` `upper-roman` `lower-alpha` `upper-alpha` `lower-greek` `armenian` `georgian` `hebrew` `cjk-ideographic` `hiragana` `katakana` `hiragana-iroha` `katakana-iroha` Default decimal	Unknown	optional
Starting value	`start`	no description	Unknown	optional
CSS style	`item_style`	no description	Unknown	optional

The above documentation is transcluded from Template:Ordered list/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.