Editing Help:List

{{shortcut|H:LIST}}
{{TOCright}}
This help page explains how to create and format lists on the BattleTechWiki.
== List basics ==
There are three types of lists: '''unordered lists''', '''ordered lists''', and '''description lists''' (a.k.a. ''definition lists'' or ''association lists''). In the following sections, various list types are used for different examples, but other list types will generally give corresponding results. Ordered (numbered) lists should usually be used only for list items that should be in a specific order, such as steps in a cooking recipe.

{{markup
| <syntaxhighlight lang="wikitext">* Lists are easy to do:
** start every line
* with a star
** more stars mean
*** deeper levels</syntaxhighlight>
| <nowiki />
* Lists are easy to do:
** start every line
* with a star
** more stars mean
*** deeper levels
| <syntaxhighlight lang="wikitext">* A newline
* in a list
marks the end of the list. Of course
* you can
* start again.</syntaxhighlight>
| <nowiki />
* A newline
* in a list
marks the end of the list. Of course
* you can
* start again.
| <syntaxhighlight lang="wikitext"># Numbered lists are good
## very organized
## easy to follow</syntaxhighlight>
| <nowiki />
# Numbered lists are good
## very organized
## easy to follow
| <syntaxhighlight lang="wikitext">Description (definition, association) lists:
; Term : Description
or
; Term
: Description
Can be used for more than terms and definitions ''per se''.
or
; Term
: Description Line 1
: Description Line 2
</syntaxhighlight>
| Description (definition, association) lists:
; Term : Description
or
; Term
: Description
Can be used for more than terms and definitions ''per se''.
or
; Term
: Description Line 1
: Description Line 2
| <syntaxhighlight lang="wikitext">* Or create mixed lists
*# and nest them
*#* like this.
*#*; Fruits
*#*: Apple
*#*: Blueberry</syntaxhighlight>
| <nowiki />
* Or create mixed lists
*# and nest them
*#* like this.
*#*; Fruits
*#*: Apple
*#*: Blueberry
| <syntaxhighlight lang="wikitext"># A line break in an item is done with HTML<br>like this.
# Just breaking the line will accidentally end the list
like this.
# This was supposed to be item 3, not a new list.</syntaxhighlight>
| <nowiki />
# A line break in an item is done with HTML<br>like this.
# Just breaking the line will accidentally end the list
like this.
# This was supposed to be item 3, not a new list.
| <syntaxhighlight lang="wikitext">* A new paragraph in an item is also HTML.<p>Like so.</p>
* Same goes for<blockquote>"block quotations"</blockquote>like that.
* Note that these are done without line-breaking the wikimarkup.</syntaxhighlight>
| <nowiki />
* A new paragraph in an item is also HTML.<p>Like so.</p>
* Same goes for<blockquote>"block quotations"</blockquote>like that.
* Note that these are done without line-breaking the wikimarkup.
}}

=== Common mistakes ===
There must be no blank lines between list items. Blank lines terminate a list, splitting it into two ''separate'' lists. This is most easily illustrated using an ordered list:

{{markup
|<syntaxhighlight lang="wikitext"># This is the first item.
# This is the second item.
# This is the third item.
# This is the fourth item.</syntaxhighlight>
|# This is the first item.
# This is the second item.
# This is the third item.
# This is the fourth item.
|<syntaxhighlight lang="wikitext"># This is the first item.
# This is the second item.

# This is the third item.
# This is the fourth item.</syntaxhighlight>
|# This is the first item.
# This is the second item.

# This is the third item.
# This is the fourth item.
}}In the second example above, the numbering resets after the blank line. This problem is less noticeable with other list types, but it still affects the underlying HTML code and may have disruptive effects for some readers.
In order to ''be'' a list, each line must begin the same way. This holds true for mixed lists.
{{markup
|<syntaxhighlight lang="wikitext"># If you start with
# one type of list,
#; and then a sublist
#: of a different type,
#:* the list characters
# always go in order.</syntaxhighlight>
|# If you start with
# one type of list,
#; and then a sublist
#: of a different type,
#:* the list characters
# always go in order.
|<syntaxhighlight lang="wikitext"># If you reverse
# the order,
;# everything
:# gets
*:# thrown off
# and nothing matches up.</syntaxhighlight>
|# If you reverse
# the order,
;# everything
:# gets
*:# thrown off
# and nothing matches up.
}}This mistake can also be less noticeable in some circumstances, but it creates single-item lists of different types; besides being semantically wrong, this may cause disruptive side effects for some readers.
Do not use a semicolon simply to give a list a title. Semicolons and colons make ''one'' kind of list; asterisks make another.
{{markup
|;Never do
*this
|;Never do
*this
}}

== Paragraphs and other breaks ==
{{Anchor|Paragraphs in lists|reason=Old title, probably linked to many times.}}
All of the techniques described in this section can be used with each other and with any type of list, at any list level.

=== Paragraphs inside list items ===
For simplicity, list items in pure wiki markup cannot be more complex than a basic paragraph. A line break in the wikimarkup of a list item will end not just the item but the entire list, and reset the counter on ordered lists. Separating unordered list items with blank lines may look approximately normal on-screen, but it creates many separate one-item lists, which is a problem for people using screen readers and is discouraged by guidelines on accessibility for people with disabilities, and is also problematic for machine analysis of the article, and for reuse of content more generally.

Paragraphs can be created inside list items by using the HTML {{tag|p}} (paragraph) element around the second and subsequent paragraphs, {{em|with no line breaks in the wikimarkup}}:
{{markup
| <syntaxhighlight lang="wikitext"># Paragraph 1.<p>Paragraph 2.</p><p>Paragraph 3.</p>
# Second item.</syntaxhighlight>
| <nowiki />
# Paragraph 1.<p>Paragraph 2.</p><p>Paragraph 3.</p>
# Second item
}}

Do not use {{tag|br|s}} as a substitute for {{tag|p}}; they have different [[w:Semantic HTML|semantics]] and are not interchangeable.

For code readability (the improvement is more apparent when the paragraphs are long, rather than with short examples like these), line-breaks may be created with HTML comments, <code>&lt;!-- ... --&gt;</code>, that begin on one line against the end of that line's code and end on another line, against the beginning of ''that'' line's code:
{{markup
| <syntaxhighlight lang="wikitext"># Paragraph 1.<!--
 --><p>Paragraph 2.</p><!--
 --><p>Paragraph 3.</p>
# Second item.</syntaxhighlight>
| <nowiki />
# Paragraph 1.<!--
--><p>Paragraph 2.</p><!--
--><p>Paragraph 3.</p>
# Second item.
}}

This technique can be used with the other examples below.

=== Line breaks inside list items ===

Use a single {{tag|br|s}} for a non-paragraph line break, e.g. where using a nested list is not desired because sub-items are already preceded by numbers:

{{markup
| <syntaxhighlight lang="wikitext"># Gather ingredients:<br>1{{frac|1|2}}&nbsp;tsp eye of newt (powdered)<br>2 bat wings<br>4&nbsp;cups mandrake root juice
# Stir in cauldron over low flame for 30 minutes</syntaxhighlight>
| <nowiki />
# Gather ingredients:<br>1{{frac|1|2}}&nbsp;tsp eye of newt (powdered)<br>2 bat wings<br>4&nbsp;cups mandrake root juice
# Stir in cauldron over low flame for 30 minutes
}}

This {{strong|must}} be done with coded {{tag|br|s}} line breaks; an actual wikitext linebreak (i.e. pressing enter/return) while writing the source code) will bring the list to an end.

=== Nested blocks inside list items ===

Similar HTML usage can provide for block quotations within list items:
{{markup
| <syntaxhighlight lang="wikitext">* Beginning of first item.<blockquote>A large quotation.</blockquote>Rest of first item.
* Second item.</syntaxhighlight>
| <nowiki />
* Beginning of first item.<blockquote>A large quotation.</blockquote>Rest of first item.
* Second item.
}}

Another case like this is small nested code blocks:
{{markup
| <syntaxhighlight lang="wikitext">The {{tnull|fnord}} template has two parameters:
# {{para|foo}} This indicates the ''foo'' level:<pre>{{fnord|foo=20}}</pre>
# {{para|bar}} This indicates...</syntaxhighlight>
|The {{tnull|fnord}} template has two parameters:
# {{para|foo}} This indicates the ''foo'' level:<pre>{{fnord|foo=20}}</pre>
# {{para|bar}} This indicates...
}}

Here, linebreaks still cannot occur inside the list item, even if they are inside {{tag|pre|o}}, and the HTML comment trick does not work inside {{tag|pre|o}}, which is why this technique is only suitable for {{em|short}} code examples.  For longer ones, see [[mw:Extension:SyntaxHighlight|the {{tag|syntaxhighlight|o}} MediaWiki tag]].

The HTML comment trick does work {{em|between}} elements inside the same list item:
{{markup
| <syntaxhighlight lang="wikitext">* Beginning of first item.<!--
--><blockquote>A large quotation.</blockquote><!--
-->Rest of first item.
* Second item.</syntaxhighlight>
| <nowiki />
* Beginning of first item.<!--
--><blockquote>A large quotation.</blockquote><!--
-->Rest of first item.
* Second item.
}}

=== Continuing a list item after a sub-item ===

In HTML, a list item may contain several sublists, not necessarily adjacent; thus there may be parts of the list item not only before the first sublist, but also between sublists, and after the last one.

In wikimarkup, unfortunately, sublists follow the same rules as sections of a page: the only possible part of the list item not in sublists is before the first sublist.

In the case of an unnumbered first-level list in wikimarkup, this limitation can be somewhat worked around by splitting the list into multiple lists; indented text between the partial lists may visually serve as part of a list item after a sublist. However, many readers find this confusing, as the indentation makes it look more like a continuation of the last sublist item.  Also, this technique may give, depending on CSS, a blank line before and after each list, in which case, for uniformity, every first-level list item could be made a separate list although this further complicates the code.  For complex lists like this, it is recommended to use the {{tl|ordered list}} or {{tl|bulleted list}} technique, and to replace instances of the "quick and dirty" wikimarkup version with the {{tl|ordered list}} version.

Numbered lists illustrate that what should look like one list may, for the software (and thus for users of screen readers for the visually impaired) actually result in multiple, nested lists. Unnumbered lists give a corresponding result, except that the problem of restarting with 1 is not applicable.
{{markup
| <syntaxhighlight lang="html">
<ol>
  <li>list item A1
    <ol>
      <li>list item B1</li>
      <li>list item B2</li>
    </ol>continuing list item A1
  </li>
  <li>list item A2</li>
</ol></syntaxhighlight>
| <ol>
  <li>list item A1
    <ol>
      <li>list item B1</li>
      <li>list item B2</li>
    </ol>continuing list item A1
  </li>
  <li>list item A2</li>
</ol>
| <syntaxhighlight lang="wikitext">
{{ordered list
  | list item A1 {{ordered list
       | list item B1 
       | list item B2 
    }} continuing list item A1
  | list item A2
}}</syntaxhighlight>
| {{ordered list
  | list item A1 {{ordered list
       | list item B1 
       | list item B2 
    }} continuing list item A1
  | list item A2
}}
| <syntaxhighlight lang="wikitext"># list item A1
## list item B1
## list item B2
#: continuing list item A1?
# list item A2</syntaxhighlight>
| <nowiki />
# list item A1
## list item B1
## list item B2
#: continuing list item A1?
# list item A2
}}
The last of these is visually confusing and results in invalid markup. It caused the creation of an embedded but improperly formed description list (the {{tag|dl|o}} HTML element): it has a definition, indicated by <code>:</code> (in HTML that's {{tag|dd|o}}), but no term (the missing <code>;</code> element, which corresponds to HTML {{tag|dt|o}}).


One level deeper, with a sublist item continuing after a sub-sublist, one gets even more blank lines; however, the continuation of the first-level list is not affected:
{{markup
| <syntaxhighlight lang="html">
<ol>
  <li>list item A1
    <ol>
      <li>list item B1
        <ol>
          <li>list item C1
        </ol>continuing list item B1
      </li>
      <li>list item B2</li>
    </ol>
  </li>
  <li>list item A2</li>
</ol></syntaxhighlight>
| <ol>
  <li>list item A1
    <ol>
      <li>list item B1
        <ol>
          <li>list item C1
        </ol>continuing list item B1
      </li>
      <li>list item B2</li>
    </ol>
  </li>
  <li>list item A2</li>
</ol>
| <syntaxhighlight lang="wikitext">
{{ordered list
  | list item A1 {{ordered list
       | list item B1 {{ordered list
         | list item C1
       }} continuing list item B1
       | list item B2 
    }}
  | list item A2
}}
</syntaxhighlight>
| {{ordered list
  | list item A1 {{ordered list
       | list item B1 {{ordered list
         | list item C1
       }} continuing list item B1
       | list item B2 
    }}
  | list item A2
}}
| <syntaxhighlight lang="wikitext"># list item A1
## list item B1
### list item C1
##: continuing list item B1?
## list item B2
# list item A2</syntaxhighlight>
| <nowiki />
# list item A1
## list item B1
### list item C1
##: continuing list item B1?
## list item B2
# list item A2
}}
Again, the third example is not desirable, as it produces broken markup and is visually confusing anyway.

{{crossref|printworthy=y|See also [[meta:Template:List demo]].}}

=== Spacing between items ===

For an ordered list with items that are more than one paragraph long, using the HTML comment trick mentioned above to add a blank line between items {{em|in the wikicode}} may be necessary to avoid editor confusion. This is done with a commented-out line:
<syntaxhighlight lang="wikitext">

# First item<!--
                                                 -->
# Second item
</syntaxhighlight>
This doesn't produce unwanted visible spacing or bad list code in the rendered page like adding a plain blank line would:
# First item<!--
                                                 -->
# Second item
The comment must begin on the same line on which the preceding item ends, and the comment must end on its own line.

Wrong:
<syntaxhighlight lang="wikitext">
# First item
<!--
                                                -->
# Second item
</syntaxhighlight>
Wrong:
<syntaxhighlight lang="wikitext">
# First item
<!--

-->#Second item

</syntaxhighlight>

If the {{em|rendered text}} has a readability problem due to complex list items, or for some other reason space is desired between list items, simply add a pair of explicit HTML line-breaks to the end of the list items:
<syntaxhighlight lang="wikitext">
# Item 1<br><br>
# Item 2<br><br>
</syntaxhighlight>

gives
# Item 1<br><br>
# Item 2<br><br>

Compare the version without the spacing:
# Item 1
# Item 2

== Changing the list type ==

The list type (which type of marker appears before the list item) can be changed in CSS by setting the [https://developer.mozilla.org/en-US/docs/Web/CSS/list-style-type list-style-type] property. This can be done using the {{tl|Ordered list}} template:

{{markup
|<nowiki>{{ordered list|type=lower-roman
  | About the author
  | Foreword to the first edition
  | Foreword to the second edition
}}</nowiki>
|{{ordered list|type=lower-roman
  | About the author
  | Foreword to the first edition
  | Foreword to the second edition
}}
}}

Or, using HTML:
{{markup
|<syntaxhighlight lang="html"><ol style="list-style-type: lower-roman;">
  <li>About the author</li>
  <li>Foreword to the first edition</li>
  <li>Foreword to the second edition</li>
</ol></syntaxhighlight>
|2=<ol style="list-style-type: lower-roman;">
  <li>About the author</li>
  <li>Foreword to the first edition</li>
  <li>Foreword to the second edition</li>
</ol>
}}

== Extra indentation of lists ==

In a numbered list in a large font, some browsers do not show more than two digits (2 spaces width) of indentation, unless extra indentation is applied (if there are multiple columns: for each column). This is fixed by increasing the default indentation of 3.2em by 2em more, and it can be done in multiple ways:

When using explicit HTML {{tag|li|open}} list items, use an explicit CSS margin spacing of 4em to double the default 2em spacing. Though not the simplest, this is {{em|the [[w:Web standards|cleanest]] and most versatile method}}, as it does not rely on any peculiarities of the parser, nor on abusing any [[w:Semantic HTML|semantic markup]] for purely visual purposes. It allows starting with a number other than 1 (''see below''). It is {{strong|the recommended method for complex lists}}.

{{markup
|1=<syntaxhighlight lang="html"><ol style="margin-left: 5.2em;">
  <li>abc</li>
  <li>def</li>
  <li>ghi</li>
</ol>
</syntaxhighlight>
|2=<ol style="margin-left: 5.2em;">
  <li>abc</li>
  <li>def</li>
  <li>ghi</li>
</ol>
|3=<nowiki>{{ordered list|style=margin-left: 2em
  | abc
  | def
  | ghi
}}
</nowiki>
|4={{ordered list|style=margin-left: 2em
  | abc
  | def
  | ghi
}}
}}

The parser translates an ordered list, {{tag|ol|open}}, without any list items, {{tag|li|open}} (in this case, it contains just another {{tag|ol|open}}) into a {{tag|div|open}} with a <code>style="margin-left: 2em;"</code>, causing indentation of the contents. This is {{strong|a versatile but potentially confusing method}}, as it allows starting with a number other than 1 (''see below''). While the parser corrects it on-the-fly, only MediaWiki experts know this, with the result that other editors are likely to try to "correct" it by removing what looks like redundant {{tag|ol|open}} code.
{{markup
|<syntaxhighlight lang="html"><ol>
  <ol>
    <li>abc</li>
    <li>def</li>
    <li>ghi</li>
  </ol>
</ol>
</syntaxhighlight>
|2=<ol>
  <ol>
    <li>abc</li>
    <li>def</li>
    <li>ghi</li>
  </ol>
</ol>
}}

Just put an explicit HTML {{tag|ol}} around wiki-markup list items. It functions the same as the previous example with the content of the "ordered list without any list items", which itself is an ordered list, expressed with # codes; the HTML produced, and hence the rendering, is the same. This is {{strong|the simplest method, and recommended when starting a simple list with number 1}}.
{{markup
|<syntaxhighlight lang="wikitext"><ol>
# abc
# def
# ghi
</ol>
</syntaxhighlight>
|2=<ol>
# abc
# def
# ghi
</ol>
}}

A list of one or more lines starting with a colon creates an HTML5 ''description list'' (formerly ''definition list'' in HTML4 and ''association list'' in draft HTML5), without terms to be defined/described/associated, but with the items as descriptions/definitions/associations, hence indented. However, if the colons are in front of the codes "*" or "#" of an unordered or ordered list, the list is treated as one description/definition, so the whole list is indented. 

{{strongbad|Deprecated method}}: The technique below produces poorly formed (though technically [[w:Validator#HTML validator|DTD-validating]]) markup and abuses the [[w:semantic HTML]] purpose of description lists for a purely visual effect, and is thus a usability and accessibility problem.

{{markup
|1=<nowiki>
:# abc
:# def
:# ghi
 </nowiki>
|2=<nowiki />
:# abc
:# def
:# ghi
}}

The page [[meta:Help:List demo]] demonstrates that several of these methods show all digits of 3-digit numbers (i.e., can handle lists of up to 999 items without display problems even in fairly large fonts).

== Specifying a starting value ==

Specifying a starting value is possible with the {{tl|ordered list}} template by using the <code>start</code> and <code>value</code> attributes.

{{markup
|<nowiki>
{{ordered list|start=9
| Amsterdam
| Rotterdam
| The Hague
}}</nowiki>
|2=
{{ordered list|start=9
| Amsterdam
| Rotterdam
| The Hague
}}
}}

Or:
{{markup
|<nowiki>
{{ordered list
| item1_value=9 | 1 = Amsterdam
| item2_value=8 | 2 = Rotterdam
| item3_value=7 | 3 = The Hague
}}</nowiki>
|2=
{{ordered list
| item1_value=9 | 1 = Amsterdam
| item2_value=8 | 2 = Rotterdam
| item3_value=7 | 3 = The Hague
}}
}}

Alternatively, only the list item whose value is being set needs to be written in HTML, the rest of the list may use wiki syntax:
{{markup
|<syntaxhighlight lang="wikitext">
# <li value="9">Amsterdam</li>
# Rotterdam
# The Hague</syntaxhighlight>
|2=<nowiki />
# <li value="9">Amsterdam</li>
# Rotterdam
# The Hague
}}
This does not work inside {{tag|ol}}.

== Comparison with a table ==

Apart from providing automatic numbering, the numbered list also aligns the contents of the items, comparable with using table syntax:
<syntaxhighlight lang="wikitext">
{|
|-
| style="text-align: right" |  9. || Amsterdam
|-
| style="text-align: right" | 10. || Rotterdam
|-
| style="text-align: right" | 11. || The Hague
|}
</syntaxhighlight>
gives
{|
|-
| style="text-align: right" |  9. || Amsterdam
|-
| style="text-align: right" | 10. || Rotterdam
|-
| style="text-align: right" | 11. || The Hague
|}

This non-automatic numbering has the advantage that if a text refers to the numbers, insertion or deletion of an item does not disturb the correspondence.

== Multi-column lists ==
{{Anchor|Multi-column bulleted list}}
Wrap a list in {{tl|Columns-list}} to add columns.
{{col-begin}}
|+ Example: multi-column list
{{col-2}}
<pre>
{{columns-list|colwidth=10em|
* 1
* 2
* 3
* 4
* 5
}}
</pre>
{{col-2}}
{{columns-list|colwidth=10em|
* 1
* 2
* 3
* 4
* 5
}}
{{col-end}}

This setup also works with numbered lists.

{{col-begin}}
|+Example: multi-column ordered list
{{col-2}}
<pre>
{{columns-list|colwidth=10em|
# a
# b
# c
# d 
# e
}}
</pre>
{{col-2}}
{{columns-list|colwidth=10em|
# a
# b
# c
# d 
# e
}}
{{col-end}}

{{tl|columns-list}} is ''the'' general solution. You can combine it with any other type of list formatting, including but not limited to every type of list syntax mentioned on this page. It works with content that are not lists as well.

== Streamlined style or horizontal style ==

It is also possible to present short lists using very basic formatting, such as:

 <nowiki>''Title of list:''</nowiki> example 1, example 2, example 3

''Title of list:'' example 1, example 2, example 3

This style requires less space on the page, and is preferred if there are only a few entries in the list, it can be read easily, and a direct edit point is not required. The list items should start with a lowercase letter unless they are proper nouns.

== Tables ==

A one-column table is very similar to a list, but it allows sorting. If the wikitext itself is already sorted with the same sortkey, this advantage does not apply.
A multiple-column table allows sorting on any column.

See also [[Help:Table]].

== See also ==
* [[:Category:List formatting and function templates|List formatting templates]] category.
* {{smaller|(&thinsp;{{tn|·}} and {{tn|•}}, dots ([[w:interpunct|interpunct]]s) and bullets that can be used to separate items in horizontal lists without the use of HTML list mark-up.)}}<br><!--
-->A more accessible, manageable and semantically robust method is to use {{tl|flatlist}} or {{tl|hlist}}.
* [[BattleTechWiki:Line break handling]], including how to handle line wrapping in horizontal lists.

[[Category:Help]]