Difference between revisions of "Help:List"

Revision as of 14:32, 30 August 2018

This page deals with creating lists in Knowledge Management system

List basics

Knowledge Management system offers three types of lists: ordered lists, unordered lists, and definition lists. In the following sections, ordered lists are used for examples. Unordered lists would give corresponding results.

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

# Numbered lists are good
## very organized
## easy to follow

* You can also
** break lines
** like this

; Definition lists
; item : definition
; semicolon plus term
: colon plus definition

; Mixed definition lists
; item 1 : definition
:; sub-item 1 plus term
:: two colons plus definition
:; sub-item 2 : colon plus definition
; item 2
: back to the main list

* Or create mixed lists
*# and nest them
*#* like this
*#*; definitions
*#*: work:
*#*; apple
*#*; banana
*#*: fruits

Paragraphs in lists

For simplicity, list items in Knowledge Management system markup cannot be longer than a paragraph. A following blank line will end the list and reset the counter on ordered lists. Separating unordered list items usually has no noticeable effects.

...

For a list with items of more than one paragraph long, adding a blank line between items may be necessary to avoid confusion.

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; however, in Knowledge Management system-syntax, 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 Knowledge Management system text code this limitation can be overcome 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, this 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.

Numbered lists illustrate that what should look like one list may, for the software, consist of multiple lists; unnumbered lists give a corresponding result, except that the problem of restarting with 1 is not applicable.

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

#list item A1
##list item B1
##list item B2
#:continuing list item A1
#list item A2

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:

#list item A1
##list item B1
###list item C1
##:continuing list item B1
##list item B2
#list item A2

gives

1. list item A1
   1. list item B1
      1. list item C1

      continuing list item B1

   2. list item B2
2. list item A2

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:

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

<ol style="list-style-type:lower-alpha">
  <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, unless extra indentation is applied (if there are multiple columns: for each column). This can be done with CSS:

ol { margin-left: 2cm}

or alternatively, like below.

:#abc
:#def
:#ghi
 

<ul>
  <ol>
    <li>abc</li>
    <li>def</li>
    <li>ghi</li>
  </ol>
</ul>

<ul>
#abc
#def
#ghi
</ul>

to demonstrate that all three methods show all digits of 3-digit numbers

Specifying a starting value

<ol start="9">
<li>Amsterdam</li>
<li>Rotterdam</li>
<li>The Hague</li>
</ol>

Or:

<ol>
<li value="9">Amsterdam</li>
<li value="8">Rotterdam</li>
<li value="7">The Hague</li>
</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:

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

Multi-column bulleted list

<div style="column-count:2;-moz-column-count:2;-webkit-column-count:2">
* apple
* carpet
* geography
* mountain
* nowhere
* postage
* ragged
* toast
</div>

gives:

<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* apple
* carpet
* geography
* mountain
* nowhere
* postage
* ragged
* toast
</div>

gives:

Multi-column numbered list

<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
#apple
#carpet
#geography
#mountain
#nowhere
#postage
#ragged
#toast
</div>

gives:

Below a starting value is specified, with HTML-syntax (for the first column either Knowledge Management-syntax or HTML-syntax can be used).

In combination with the extra indentation explained in the previous section:

{| valign="top"
|-
|<ul><ol start="125"><li>a<li>bb<li>ccc</ol></ul>
|<ul><ol start="128"><li>ddd<li>ee<li>f</ol></ul>
|}

gives:

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


gives:


<table>

<tr>
<td valign="top"><ul><ol start="125" style="list-style-type:lower-roman"><li>a</li><li>bb</li><li>ccc</li></ol></ul>
</td>
<td valign="top"><ul><ol start="128" style="list-style-type:lower-roman"><li>ddd</li><li>ee</li></ol></ul>
</td>
<td valign="top"><ul><ol start="130" style="list-style-type:lower-roman"><li>f</li></ol></ul>
</td></tr></table>

<pre>{{Multi-column numbered list|lst=disc||a<li>bb<li>ccc||<li>ddd<li>ee||<li>f}}

gives:

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.

Tables

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

Changing unordered lists to ordered ones

With the 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 Knowledge Management system text
• 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 User contributions and What links here.

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.