Help:List

From the AARoads Wiki: Read about the road before you go
Jump to navigation Jump to search
For the corresponding Manual of Style, see Wikipedia:Manual of Style/Lists.
This help page is about how to create and format lists of items in an article. For articles that are lists of things themselves, see Wikipedia:Stand-alone lists.

This help page explains how to create and format lists on the English Wikipedia.

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 Renders as 
* Lists are easy to do:
** start every line
* with a star
** more stars mean
*** deeper levels
  • Lists are easy to do:
    • start every line
  • with a star
    • more stars mean
      • deeper levels
* A newline
* in a list
marks the end of the list. Of course
* you can
* start again.
  • A newline
  • in a list

marks the end of the list. Of course

  • you can
  • start again.
# Numbered lists are good
## very organized
## easy to follow
  1. Numbered lists are good
    1. very organized
    2. easy to follow
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

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
* Or create mixed lists
*# and nest them
*#* like this.
*#*; Fruits
*#*: Apple
*#*: Blueberry
  • Or create mixed lists
    1. and nest them
      • like this.
        Fruits
        Apple
        Blueberry
# 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.
  1. A line break in an item is done with HTML
    like this.
  2. Just breaking the line will accidentally end the list

like this.

  1. This was supposed to be item 3, not a new list.
* 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.
  • A new paragraph in an item is also HTML.

    Like so.

  • Same goes for

    "block quotations"

    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 Renders as 
# This is the first item.
# This is the second item.
# This is the third item.
# This is the fourth item.
  1. This is the first item.
  2. This is the second item.
  3. This is the third item.
  4. This is the fourth item.
# This is the first item.
# This is the second item.

# This is the third item.
# This is the fourth item.
  1. This is the first item.
  2. This is the second item.
  1. This is the third item.
  2. 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; see WP:LISTGAP for details.

In order to be a list, each line must begin the same way. This holds true for mixed lists.

Markup Renders as 
# If you start with
# one type of list,
#; and then a sublist
#: of a different type,
#:* the list characters
# always go in order.
  1. If you start with
  2. one type of list,
    and then a sublist
    of a different type,
    • the list characters
  3. always go in order.
# If you reverse
# the order,
;# everything
:# gets
*:# thrown off
# and nothing matches up.
  1. If you reverse
  2. the order,
  1. everything
  2. gets
    1. thrown off
  1. 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 Renders as 
;Never do
*this
Never do
  • this

Paragraphs and other breaks

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 the guideline on accessibility for people with disabilities, and is also problematic for machine analysis of the article, and for reuse of Wikipedia content more generally.

Paragraphs can be created inside list items by using the HTML <p>...</p> (paragraph) element around the second and subsequent paragraphs, with no line breaks in the wikimarkup:

Markup Renders as 
# Paragraph 1.<p>Paragraph 2.</p><p>Paragraph 3.</p>
# Second item.
  1. Paragraph 1.

    Paragraph 2.

    Paragraph 3.

  2. Second item

Do not use <br> as a substitute for <p>...</p>; they have different 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, <!-- ... -->, 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 Renders as 
# Paragraph 1.<!--
 --><p>Paragraph 2.</p><!--
 --><p>Paragraph 3.</p>
# Second item.
  1. Paragraph 1.

    Paragraph 2.

    Paragraph 3.

  2. Second item.

This technique can be used with the other examples below.

Line breaks inside list items

Use a single <br> 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 Renders as 
# 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
  1. Gather ingredients:
    11⁄2 tsp eye of newt (powdered)
    2 bat wings
    4 cups mandrake root juice
  2. Stir in cauldron over low flame for 30 minutes

This must be done with coded <br> 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 Renders as 
* Beginning of first item.<blockquote>A large quotation.</blockquote>Rest of first item.
* Second item.
  • Beginning of first item.

    A large quotation.

    Rest of first item.
  • Second item.

Another case like this is small nested code blocks:

Markup Renders as 
The {{tnull|fnord}} template has two parameters:
# {{para|foo}} This indicates the ''foo'' level:<pre>{{fnord|foo=20}}</pre>
# {{para|bar}} This indicates...

The {{fnord}} template has two parameters:

  1. |foo= This indicates the foo level:
    {{fnord|foo=20}}
  2. |bar= This indicates...

Here, linebreaks still cannot occur inside the list item, even if they are inside <pre>, and the HTML comment trick does not work inside <pre>, which is why this technique is only suitable for short code examples. For longer ones, see the <syntaxhighlight> MediaWiki tag.

The HTML comment trick does work between elements inside the same list item:

Markup Renders as 
* Beginning of first item.<!--
--><blockquote>A large quotation.</blockquote><!--
-->Rest of first item.
* Second item.
  • Beginning of first item.

    A large quotation.

    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 {{ordered list}} or {{bulleted list}} technique, and to replace instances of the "quick and dirty" wikimarkup version with the {{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 Renders as 
<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>
  1. list item A1
    1. list item B1
    2. list item B2
    continuing list item A1
  2. list item A2
{{ordered list
  | list item A1 {{ordered list
       | list item B1 
       | list item B2 
    }} continuing list item A1
  | list item A2
}}
  1. list item A1
    1. list item B1
    2. list item B2
    continuing list item A1
  2. list item A2
# list item A1
## list item B1
## list item B2
#: continuing list item A1?
# list item A2
  1. list item A1
    1. list item B1
    2. list item B2
    continuing list item A1?
  2. 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 <dl> HTML element): it has a definition, indicated by : (in HTML that's <dd>), but no term (the missing ; element, which corresponds to HTML <dt>).


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 Renders as 
<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>
  1. list item A1
    1. list item B1
      1. list item C1
      continuing list item B1
    2. list item B2
  2. list item A2
{{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
}}
  1. list item A1
    1. list item B1
      1. list item C1
      continuing list item B1
    2. list item B2
  2. list item A2
# list item A1
## list item B1
### list item C1
##: continuing list item B1?
## list item B2
# list item A2
  1. list item A1
    1. list item B1
      1. list item C1
      continuing list item B1?
    2. list item B2
  2. list item A2

Again, the third example is not desirable, as it produces broken markup and is visually confusing anyway.

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 in the wikicode may be necessary to avoid editor confusion. This is done with a commented-out line: 

# First item<!--
                                                 -->
# Second item

This doesn't produce unwanted visible spacing or bad list code in the rendered page like adding a plain blank line would:

  1. First item
  2. 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: 

# First item
<!--
                                                -->
# Second item

Wrong: 

# First item
<!--

-->#Second item

If the 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: 

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

gives

  1. Item 1

  2. Item 2

Compare the version without the spacing:

  1. Item 1
  2. 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 list-style-type property. This can be done using the {{Ordered list}} template:

Markup Renders as 
{{ordered list|type=lower-roman
  | About the author
  | Foreword to the first edition
  | Foreword to the second edition
}}
  1. About the author
  2. Foreword to the first edition
  3. Foreword to the second edition

Or, using HTML:

Markup Renders as 
<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>
  1. About the author
  2. Foreword to the first edition
  3. Foreword to the second edition

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 <li> list items, use an explicit CSS margin spacing of 4em to double the default 2em spacing. Though not the simplest, this is the cleanest and most versatile method, as it does not rely on any peculiarities of the parser, nor on abusing any semantic markup for purely visual purposes. It allows starting with a number other than 1 (see below). It is the recommended method for complex lists.

Markup Renders as 
<ol style="margin-left: 5.2em;">
  <li>abc</li>
  <li>def</li>
  <li>ghi</li>
</ol>
  1. abc
  2. def
  3. ghi
{{ordered list|style=margin-left: 2em
  | abc
  | def
  | ghi
}}
  1. abc
  2. def
  3. ghi

The parser translates an ordered list, <ol>, without any list items, <li> (in this case, it contains just another <ol>) into a <div> with a style="margin-left: 2em;", causing indentation of the contents. This is a versatile but potentially confusing method, as it allows starting with a number other than 1 (see below). It is kludgey, unnecessarily complex, and looks like invalid HTML. 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 <ol> code.

Markup Renders as 
<ol>
  <ol>
    <li>abc</li>
    <li>def</li>
    <li>ghi</li>
  </ol>
</ol>
    1. abc
    2. def
    3. ghi

Just put an explicit HTML <ol>...</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 the simplest method, and recommended when starting a simple list with number 1.

Markup Renders as 
<ol>
# abc
# def
# ghi
</ol>
    1. abc
    2. def
    3. ghi

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.

Deprecated method: The technique below produces poorly formed (though technically DTD-validating) markup and abuses the semantic HTML purpose of description lists for a purely visual effect, and is thus a usability and accessibility problem. It will work in a hurry, but should be replaced with cleaner code; see WP:Manual of Style/Glossaries for several approaches.

Markup Renders as 
:# abc
:# def
:# ghi
  1. abc
  2. def
  3. ghi

Specifying a starting value

Specifying a starting value is possible with the {{ordered list}} template by using the start and value attributes.

Markup Renders as 
{{ordered list|start=9
| Amsterdam
| Rotterdam
| The Hague
}}
  1. Amsterdam
  2. Rotterdam
  3. The Hague

Or:

Markup Renders as 
{{ordered list
| item1_value=9 | 1 = Amsterdam
| item2_value=8 | 2 = Rotterdam
| item3_value=7 | 3 = The Hague
}}
  1. Amsterdam
  2. Rotterdam
  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 Renders as 
# <li value="9">Amsterdam</li>
# Rotterdam
# The Hague
  2. Amsterdam
  3. Rotterdam
  4. The Hague

This does not work inside <ol>...</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: 

{|
|-
| style="text-align: right" |  9. || Amsterdam
|-
| style="text-align: right" | 10. || Rotterdam
|-
| style="text-align: right" | 11. || The Hague
|}

gives

9. Amsterdam
10. Rotterdam
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

Wrap a list in {{Columns-list}} to add columns.

This setup also works with numbered lists.

{{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: 

''Title of list:'' 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.

See also WP:HLIST.

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.

Interaction with floating elements

{{#section-h:Wikipedia:Extended image syntax|Interaction between left-floating images and lists}}

Manipulating lists with user stylesheets

Further information: Help:User contributions § User styles

Virtually anything about how lists are displayed can be customized at the user end with CSS. Some of the more useful tweaks are outlined below. Of course, you enter the code in Text Editor mode — if you enter it in WYSIWYG mode, it is entered using escape characters. Also, if you enter HTML in the Text Editor and switch to WYSIWYG mode, the HTML is lost and re-converted to markdown without styles.

Extra indentation

As noted above, in a numbered list in a large font, some browsers do not show more than two digits of indentation width, unless extra indentation is applied (if there are multiple columns; then indentation for each column). While this should be fixed in the wikicode, user stylesheet CSS can work around the problem for as long as it is present, by increasing the default indentation of 3.2em by 2em more: 

 ol { margin-left: 5.2em;}

Changing unordered lists to ordered ones

With the following user style CSS, ul { list-style: decimal; }, unordered lists are changed to ordered ones for sighted users (but not users who must use assistive technology). This applies (as far as the CSS selector does not restrict this) to all ul-lists in the HTML source code:

  • those produced with *
  • those with <ul> in the wikitext
  • those produced by the system

Since each special page, like other pages, has a class based on the pagename, one can separately specify for each type whether the lists should be ordered, see Help:User contributions#User styles and Help:What links here#User styles.

However, it does not seem possible to make all page history lists ordered (unless one makes all lists ordered), because the class name is based on the page for which the history is viewed.

How to find entries for a list

The easiest way to find relevant articles for a new list or missing entries in an existing one is by finding the most relevant category and checking its entries. Sometimes lists are about things that are intersections of categories for which the PetScan tool can be used.

More relevant articles may also be found linked in the list's topic's article and the articles already featured in the list − most often in their "See also" sections (if existent) and the automatically suggested "RELATED ARTICLES" below them.

Other ways to find relevant articles include searching Wikipedia for the lists' topic and searching the Web for the topic in quotes " (with synonyms also in quotes and appended after an OR) and appending the word wiki or Wikipedia or site:Wikipedia.org to them.

Lastly the "What links here"-tool can be used on the list's topic's article to find relevant articles.

For lists that do not require the entries to have a Wikipedia article there are additional ways of finding relevant entries such as lists on external websites (e.g. Goodreads for books) − typically involving Web searches.

See also

Retrieved from "https://wiki.aaroads.com/w/index.php?title=Help:List&oldid=438894"