Difference between revisions of "Template:List"

Latest revision as of 18:20, 7 June 2014

This template creates a list of a variable amount of (only) non-empty strings. This is useful if the strings are yet to be determined by transclusion context, and only need to be included in the list if they are actually non-empty. The order of the strings will be honoured, in respect to their position number. Gaps are allowed and will be omitted.

The list will either use list bullets, or implode the items with a separator into a single string.

The list is terminated as soon as it detects an empty string, but this may be turned off for a specified range of strings.

Note: Line-breaks in the middle of any of the strings will break the list in two, restarting any numbering, so don't use them.

Parameters

Unlimited unnamed parameters are accepted, case sensitive, all default to not displayed.

• separator: The string used to glue all values together (any non-empty value will disable list bullets/numbers, which are enabled by default)
• numeric: Whether to render a numeric (ordered) list instead of the default bulleted list (any value other than false will do, defaults to false, ignored if separator is non-empty)
• range: The minimum number of elements in the list to expect, before empty strings may terminate it (any digit greater than zero, defaults to zero)

Note: The range does not define the resulting size of the list, but only the size within which strings are allowed to be empty. Its value should not be greater than necessary, for best performance.

Syntax

{{list|numeric=yes|separator=string
 |string one
 |string two
 |string three
 |...
 |string ten-whatnot
}}

Examples

When specifying only three strings:

{{list
 |Ape
 |Bear
 |Cow
}}

• Ape
• Bear
• Cow

If numeric is specified with any (empty) value other than "false":

{{list|numeric=
 |string one
 |string two
}}
{{list|numeric=sure
 |another string one
 |another string two
}}

1. string one
2. string two

1. another string one
2. another string two

If the first string is empty or not specified, the list is terminated immediately and no list bullets will be displayed:

{{list||second string is ignored}}
{{list|2=second string is ignored}}

Similarly, any other empty string will terminate the list as well, ignoring any further strings:

{{list|one|two|three||||seven}}
{{list|one|two|three|7=seven}}

1. one
2. two
3. three

1. one
2. two
3. three

But if range is specified and greater than zero, that many strings won't terminate the list even if they are empty:

{{list|range=6|one|two|three||||seven||nine}}

1. one
2. two
3. three
4. seven

Avoid using line-breaks within any of the strings, because they will totally mess up the list:

{{list|numeric=yes
 |one string that has a
multi-line value
 |another}}

1. one string that has a

multi-line value

1. another

Instead of listing the strings as individual list items, using separator will glue them together with the specified string (substitute spaces with the html-entity):

{{list|separator=, |one|two|three}}

one, two, three

To glue all strings together without a separator, specify an empty span element as separator:

{{list|separator=<span></span>|one|two|three}}

onetwothree

The value of the separator can be the result of a condition, because it will be ignored if it is empty:

{{list|separator=|one|two|three}}

1. one
2. two
3. three

If only one string is specified, it will still be bulleted or numbered:

{{list|only one string this time}}
{{list|only one string this time|numeric=yes}}

• only one string this time

1. only one string this time

This can be prevented if a single item is expected in advance, by specifying any separator:

{{list|separator=whatever|a single string doesn't get a separator}}

a single string doesn't get a separator