Help:List

src: i.ytimg.com

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

Video Help:List

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.

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:

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.

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.

Maps Help:List

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:

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:

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:

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:

Another case like this is small nested code blocks:

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

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, with further complicates the code. For complex lists like this, it is recommended to use the {{ordered 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, consist of multiple, nested lists. Unnumbered lists give a corresponding result, except that the problem of restarting with 1 is not applicable.

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:

See also m:Template:List demo (backlinks edit) and subdivisions.

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

src: www.pennyphang.com

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:

Or, using HTML:

src: i.ytimg.com

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.

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.

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.

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.

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).

src: blog.pensoft.net

Specifying a starting value

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

Or:

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:

This does not work inside <ol>...</ol>.

src: i.ytimg.com

Comparison with a table

Apart from providing automatic numbering, the numbered list also aligns the contents of the items, comparable with using table syntax:

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

gives

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.

src: www.latimes.com

Multi-column bulleted list

  {{col-begin|width=auto}}  {{col-break}}  * 1  * 2  {{col-break}}  * 3  * 4  * 5  {{col-end}}  

gives:

Note: The {{col-begin}}/{{col-end}} method conflicts with WP:LISTGAP guidelines. The template {{Columns-list}} is both easier and more flexible, and does not break a single list into multiple lists.

  {{columns-list|colwidth=10em|  * 1  * 2  * 3  * 4  * 5  }}  

src: www.patuakhalinews.com

Multi-column numbered list

Specifying a starting value is useful for a numbered list with multiple columns, to avoid restarting from one in each column. As mentioned above, this is only possible with HTML-syntax (for the first column either wiki-syntax or HTML-syntax can be used).

In combination with the extra indentation, using the |gap= parameter:

  {{col-begin|width=auto}}  {{col-break|gap=2em}}  {{ordered list|start=125|a|bb|ccc}}  {{col-break|gap=2em}}  {{ordered list|start=128|ddd|ee|f}}  {{col-end}}  

gives

Using {{multi-column numbered list}} the computation of the starting values can be automated, and only the first starting value and the number of items in each column except the last has to be specified. Adding an item to, or removing an item from a column requires adjusting only one number, the number of items in that column, instead of changing the starting numbers for all subsequent columns.

{{multi-column numbered list|125|a<li>bb<li>ccc|3|<li>ddd<li>ee<li>f}}

gives

{{multi-column numbered list|lst=lower-alpha|125|a<li>bb<li>ccc|3|<li>ddd<li>ee|2|<li>f}}

gives

{{multi-column numbered list|lst=lower-roman|125|a<li>bb<li>ccc|3|<li>ddd<li>ee|2|<li>f}}

gives

{{multi-column numbered list|lst=disc|125|a<li>bb<li>ccc|3|<li>ddd<li>ee|2|<li>f}}

gives

Note that the starting values of each column (125, +3, +2) have no effect when the disc list type is used.

src: media.buzzle.com

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

List bullets and numbers can sometimes overlap left-floating images or Infoboxes, for example:

Placing the list inside <div class="flowlist">...</div> tags, or using the {{flowlist}} template, enables lists to stay clear of these left-floating objects:

[[File:Bad Title Example.png|left|thumb|100px|Test image]]   <div class="flowlist">    <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>  </div>

Renders as:

This method will not work inside of a table, and if your list is longer than the floated element, then the list will not flow around the image like normal, but instead be one block, leaving white space below the floated element.

Manipulating lists with user stylesheets

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. 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

• MOS:PLIST, which explains the formatting of unbulleted lists.
• Wikipedia:Manual of Style/Lists, for suggested styles of lists.
• List formatting templates category.
• ( {{·}} and {{o}}, dots (interpuncts) and bullets that can be used to separate items in horizontal lists without the use of HTML list mark-up.)
  A more accessible, manageable and semantically robust method is to use {{flatlist}} or the class "hlist".
• Wikipedia:Line break handling, including how to handle line wrapping in horizontal lists.
• Wikipedia:Help desk, to ask questions about using lists in articles if you weren't able to find the information you need here.

Source of the article : Wikipedia