Difference between revisions of "Template:List"

From Twinsuniverse
Jump to: navigation, search
m
(updated documentation)
Line 6: Line 6:
 
       |<li>{{{ {{#var: arg}}}}}</li>}}}}</{{#ifeq: {{{numeric|false}}}|false|ul|ol}}>}}
 
       |<li>{{{ {{#var: arg}}}}}</li>}}}}</{{#ifeq: {{{numeric|false}}}|false|ul|ol}}>}}
 
}}</includeonly><noinclude>
 
}}</includeonly><noinclude>
This template wraps up to 30 non-empty strings into an (un)ordered list. If only one string is not empty, it is displayed as-is, and if no string is not empty, nothing is displayed.
+
This template wraps up to 30 non-empty strings into an (un)ordered list. The list will display the first string as-is if the second is empty, and will not display anything if the first is also empty. This is useful if the strings are yet unknown and only need to be wrapped if there are more than one not empty.
  
This is useful if the strings are yet unknown and only need to be wrapped if there are more than one not empty.
+
If the arguments are specified by their position number however, then their position number will instead be taken into account for this mechanic.
  
 
==Parameters==
 
==Parameters==
 
Thirty unnamed parameters, no parameter name, case sensitive, all default to not displayed.
 
Thirty unnamed parameters, no parameter name, case sensitive, all default to not displayed.
* '''numeric''': whether to render a numeric list instead (defaults to disc bullets, any value will render numeric bullets)
+
* '''numeric''': Whether to render a numeric (ordered) list instead (any value will do, defaults to false)
  
  
'''''Note''': The unnamed parameters should be specified non-empty in proper order, when specified by their position numbers, because the first number that is empty, terminates the list.''
+
'''''Note''': The unnamed parameters may be specified in any order and allow empty arguments between them, because of all the arguments only non-empty ones have effect.''
  
 
==Syntax==
 
==Syntax==

Revision as of 23:25, 3 June 2014

This template wraps up to 30 non-empty strings into an (un)ordered list. The list will display the first string as-is if the second is empty, and will not display anything if the first is also empty. This is useful if the strings are yet unknown and only need to be wrapped if there are more than one not empty.

If the arguments are specified by their position number however, then their position number will instead be taken into account for this mechanic.

Parameters

Thirty unnamed parameters, no parameter name, case sensitive, all default to not displayed.

  • numeric: Whether to render a numeric (ordered) list instead (any value will do, defaults to false)


Note: The unnamed parameters may be specified in any order and allow empty arguments between them, because of all the arguments only non-empty ones have effect.

Syntax

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

Examples

When specifying only five strings:

{{list
 |Ape
 |Bear
 |Chihuahua
 |Donkey
 |Eel
}}
  • Ape
  • Bear
  • Chihuahua
  • Donkey
  • Eel


If only one string is specified:

{{list|only one string this time}}
only one string this time


If the numeric parameter is specified with a nonempty value (it is ignored when only one list item is specified):

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


If all strings are empty or no string is specified, all are effectively omitted resulting in no display at all.