Difference between revisions of "Help:Lists"

From Twinsuniverse
Jump to: navigation, search
(updated to reference list-template)
(Variable lists: added examples)
 
Line 80: Line 80:
  
 
==Variable lists==
 
==Variable lists==
Maybe you want to render a list of items that are rendered by a template, and you don't know which items will be non-empty. You will want to prevent empty bullets from being rendered, so in that case the above syntax would not work. Using conditional mechanics could become quite tedious, so for that you could use the {{templatelink|list}} template, read its own documentation on how to use it.
+
Maybe you want to render a list of items that are rendered by a template or template parameter, and you don't know which items will be non-empty. You will want to prevent empty bullets from being rendered, so in that case the above syntax would not work. Using conditional mechanics could become quite tedious, so instead you could use the {{templatelink|list}} template.
  
The list template can omit empty list items automatically. It renders the items with bullets or numbers, or as a single-line string with separators. It does not support multiple levels of indentation though, and it cannot be embedded safely either.
+
The list template can omit empty list items automatically. It renders the items with bullets or numbers, or as a single-line string with separators. It does not fully support multiple levels of indentation though, and it cannot be embedded safely either.
 +
 
 +
The following bulleted example assumes we are in a template, which is then called with parameters '''one=some''' and '''two=thing''':
 +
<nowiki>{{list|range=5
 +
|{{{first|}}}
 +
|{{{one|}}}
 +
|{{{second|}}}
 +
|{{{two|}}}
 +
|{{{third|}}}
 +
}}</nowiki>
 +
 
 +
{{list|range=5||some||thing|}}
 +
 
 +
 
 +
Alternatively, the template can also be used to separate things on a single line. This could be useful if manual separation becomes too repetitive:
 +
<nowiki>Available fruit: {{list|separator=<span style{{=}}"color:blue"> • </span>
 +
|Apple
 +
|Banana
 +
|Lemon
 +
|Orange
 +
|Peach
 +
}}</nowiki>
 +
Available fruit: {{list|separator=<span style{{=}}"color:blue"> • </span>
 +
|Apple
 +
|Banana
 +
|Lemon
 +
|Orange
 +
|Peach
 +
}}
 +
 
 +
For further details on how to use this template, see its [[Template:list|documentation page]].

Latest revision as of 21:54, 11 June 2014

Help Contents
Lists are very easy to create here at the Twinsuniverse. There are two main types of lists: numbered and bulleted. Unlike paragraphs, to separate lines of lists you only need one line break, and not two.

Bulleted lists

To make a bulleted list, simply put an asterisk (*) at the beginning of each line:

* Twinsen
* Zoé
* Baldino
  • Twinsen
  • Zoé
  • Baldino


To indent one level in a list, simply add more asterisks:

* Quetches
** Twinsen
** Zoé
* Grobos
** Baldino
** Zed
  • Quetches
    • Twinsen
    • Zoé
  • Grobos
    • Baldino
    • Zed

Numbered lists

Numbered lists are the same, except that the # sign is used instead of *:

# Twinsen
# Zoé
# Baldino
  1. Twinsen
  2. Zoé
  3. Baldino

Indenting is also similar:

# Quetches
## Twinsen
## Zoé
# Grobos
## Baldino
## Zed
  1. Quetches
    1. Twinsen
    2. Zoé
  2. Grobos
    1. Baldino
    2. Zed

Combinations

Lists can have more than two levels as well. Now you know listing is really easy, here is a more complex combination example:

* Quetches
*# Twinsen
*#* Melee
*#* Ranged
*#* Magic
*#* Explosive
*# Zoé
*#* Melee
* Grobos
*# Baldino
*#* Melee
*#* Ranged
*# Zed
*#* Mushrooms
  • Quetches
    1. Twinsen
      • Melee
      • Ranged
      • Magic
      • Explosive
    2. Zoé
      • Melee
  • Grobos
    1. Baldino
      • Melee
      • Ranged
    2. Zed
      • Mushrooms

Variable lists

Maybe you want to render a list of items that are rendered by a template or template parameter, and you don't know which items will be non-empty. You will want to prevent empty bullets from being rendered, so in that case the above syntax would not work. Using conditional mechanics could become quite tedious, so instead you could use the {{list}} template.

The list template can omit empty list items automatically. It renders the items with bullets or numbers, or as a single-line string with separators. It does not fully support multiple levels of indentation though, and it cannot be embedded safely either.

The following bulleted example assumes we are in a template, which is then called with parameters one=some and two=thing:

{{list|range=5
 |{{{first|}}}
 |{{{one|}}}
 |{{{second|}}}
 |{{{two|}}}
 |{{{third|}}}
}}

  • some
  • thing


Alternatively, the template can also be used to separate things on a single line. This could be useful if manual separation becomes too repetitive:

Available fruit: {{list|separator=<span style{{=}}"color:blue"> • </span>
 |Apple
 |Banana
 |Lemon
 |Orange
 |Peach
}}

Available fruit: AppleBananaLemonOrangePeach


For further details on how to use this template, see its documentation page.