Difference between revisions of "Template:List"

Revision as of 14:03, 7 June 2014

This template wraps a variable amount of (only) non-empty strings into an (un)ordered list. This is useful if the strings are yet to be determined by transclusion context, and only need to render list bullets 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 skipped.

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 the numbering, so don't use them.

Parameters

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

• numeric: Whether to render a numeric (ordered) list instead of the default bulleted list (any value will do, defaults to false)
• 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
 |string one
 |string two
 |string three
 |...
 |string ten-whatnot
}}

Examples

When specifying only three strings:

{{list
 |Ape
 |Bear
 |Cow
}}

• Ape
• Bear
• Cow

If only one string is specified, it is still bulleted in a list ^{(previously it wasn't)}:

{{list|only one string this time}}

• only one string this time

If the numeric parameter is specified with a non-empty value:

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

1. only one string this time also

1. string one
2. and another

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