Difference between revisions of "Template:Ordered list"
From BSC Policy
Jump to navigationJump to searchLine 1: | Line 1: | ||
− | {{ | + | {{Documentation subpage}} |
+ | {{lua|Module:List}} | ||
+ | {{Template shortcut|olist}} | ||
+ | <!-- Categories and interwikis go at the bottom of this page. --> | ||
+ | |||
+ | == Usage == | ||
+ | This template creates an ordered list, which is similar to a [[WP:L#Numbered lists|numbered list]] but may display other characters, such as roman numbers or alphabet letters, instead of the decimal enumerator. | ||
+ | |||
+ | == Syntax == | ||
+ | ;Simple:<code><nowiki>{{</nowiki>Ordered list |''entry1'' |''entry2''| ... <nowiki>}}</nowiki></code> | ||
+ | ;Offset starting value:<code><nowiki>{{</nowiki>Ordered list |start=''start''|''entry1'' |''entry2'' |... |item1_style=''CSS1'' |item2_style=''CSS2''| ... <nowiki>}}</nowiki></code> | ||
+ | ;Changing the symbol style:<code><nowiki>{{</nowiki>Ordered list |list_style_type=''type'' |''entry1'' |''entry2'' |... <nowiki>}}</nowiki></code> | ||
+ | ;With CSS style:<code><nowiki>{{</nowiki>Ordered list |item_style=''CSS-all'' |''entry1'' |''entry2'' |... <nowiki>}}</nowiki></code> | ||
+ | ;With separate CSS styles for each item:<code><nowiki>{{</nowiki>Ordered list |''entry1'' |item1_style=''CSS1'' |''entry2'' |item2_style=''CSS2'' |... <nowiki>}}</nowiki></code> | ||
+ | ;With custom values for each item:<code><nowiki>{{</nowiki>Ordered list |item1_value=''value1'' |''entry1'' |item2_value=''value2'' |''entry2'' |... <nowiki>}}</nowiki></code> | ||
+ | |||
+ | {| class="wikitable" | ||
+ | |+ Parameters' description | ||
+ | |- | ||
+ | ! Parameter !! Description | ||
+ | |- | ||
+ | | <code>list_style_type</code> or<br /><code>list-style-type</code> | ||
+ | ''type'' | ||
+ | | This parameter indicates the list style type. Popular acceptable parameters include: | ||
+ | |||
+ | * <code>decimal (1, 2, 3, 4, ...)</code> | ||
+ | * <code>lower-roman (i, ii, iii, iv, ...)</code> | ||
+ | * <code>upper-roman (I, II, III, IV, ...)</code> | ||
+ | * <code>lower-alpha (a, b, c, d, ...)</code> | ||
+ | * <code>upper-alpha (A, B, C, D, ...)</code> | ||
+ | For a full list, see the following section. | ||
+ | |- | ||
+ | | Positional parameters | ||
+ | {{nowrap|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 <code><nowiki>{{=}}</nowiki></code>, lest it will be interpreted a named parameter. | ||
+ | |- | ||
+ | | <code>item''n''_value</code> | ||
+ | {{nowrap|value1 value2 ...}} | ||
+ | | Ordinal or label for a specific list item; a positive integer. | ||
+ | |- | ||
+ | | <code>start</code> | ||
+ | | Ordinal or label for the first item in the list; a positive integer (default is 1). | ||
+ | |- | ||
+ | | <code>item''n''_style</code> | ||
+ | {{nowrap|CSS1 CSS2 ...}} | ||
+ | | [[Cascading Style Sheet]] (CSS) styles that are set on a specific list item. (User must know CSS syntax.) | ||
+ | |- | ||
+ | | <code>item_style</code> | ||
+ | CSS-all | ||
+ | | CSS styles that are set on each list item. (User must know CSS syntax.) When present, any <code>item''n''_style</code> are disregarded. | ||
+ | |} | ||
+ | |||
+ | ===Acceptable list style type values and supported web browsers === | ||
+ | {{CSS list-style-type values}} | ||
+ | |||
+ | == See also == | ||
+ | {{navbox lists}} | ||
+ | |||
+ | == References == | ||
+ | {{Reflist}} | ||
+ | |||
+ | <includeonly>{{Sandbox other|| | ||
+ | <!-- Categories and interwikis go here: --> | ||
+ | [[Category:List formatting and function templates]] | ||
+ | }}</includeonly> |
Revision as of 10:48, 28 October 2020
Template:Documentation subpage Template:Lua Template:Template shortcut
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 |... }}
Parameter | Description |
---|---|
list_style_type orlist-style-type
type |
This parameter indicates the list style type. Popular acceptable parameters include:
For a full list, see the following section. |
Positional parameters | 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
|
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
|
Cascading Style Sheet (CSS) styles that are set on a specific list item. (User must know CSS syntax.) |
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.
|
Acceptable list style type values and supported web browsers
Template:CSS list-style-type values
See also
References