Wiki-Syntax Lists

In Wiki pages and other contexts that support Wiki formatting (including articles, forums, and blogs), you can easily create bulleted, numbered, and definition lists. In numbered lists, Tiki numbers the items automatically. You can also create nested lists. The following sections explain the details; see the Quick Reference for an overview. Scroll down to Help! if something goes wrong.

In this page:

Quick Reference

To Create...	Use	Example
Bulleted list	* (asterisk)	* Item * Item * Item
Numbered list	# (hash)	# Item # Item # Item
Definition list	; (semicolon)	;term:definition

If you forget which character to use while you're editing, click the Wiki Quick Help tab.

Creating a Bulleted List

If you type an asterisk (*) at the beginning of a line, Tiki places a bullet (a black dot) at the beginning of the line. The line is indented and formatted with a hanging indent, so that second and subsequent lines are indented and aligned with the first line.

To create a bulleted list, do the following:

1. Place the insertion point at the beginning of the line.
2. Type an asterisk.
3. Type the item's text.
4. Press Enter.

Example :

• I put an asterisk at the beginning of this line
• And on the second too
• and on the third
• And you can see all the lines aligned.

Creating a Numbered List

If you type a hash mark (#) at the beginning of a line, Tiki numbers the line and indents it from the left margin. The item's text is formatted with a hanging indent, so that second and subsequent lines are indented and aligned with the first line.

To create a numbered list, do the following:

1. Place the insertion point at the beginning of the line.
2. Type a hash mark. Tiki supplies the period automatically.
3. Type the item's text.
4. Do one of the following:
   1. To continue typing items, press Enter once, and go to Step 2, above.
   2. To stop typing the list, press Enter twice.

If you place more than one numbered list in a page, the items are separately numbered.

Creating a Nested List

A nested list is a bulleted or numbered list that has more than one level — that is, some items have "sub-items". To create a nested list, type two or more asterisks (bulleted lists) or hash marks (numbered lists) at the beginning of the line, as shown in the following examples:

*Level 1 (bulleted list)
**Level 2 (bulleted list)
***Level 3 (bulleted list)

#Level 1 (numbered list)
##Level 2 (numbered list)
###Level 3 (numbered list)

Bullet list example:

• This is a Level 1 item.
• This is another Level 1 item
  • This is a Level 2 item.
• Yet another Level 1 item.
  • This is a Level 2 item.
    • Sub-items can have their own sub-items! This is Level 3.
• Back to Level 1.

In a bulleted list, you can create additional sub-levels beyond the third level, but Tiki doesn't use distinctive bullets beyond Level 3.

Numbered list example:

Here's a numbered list with nested levels:

1. This is a Level 1 item.
2. This is another Level 1 item
   1. This is a Level 2 item.
3. Yet another Level 1 item.
   1. This is a Level 2 item.
   2. Another Level 2 item. Note the numbering.
      1. Sub-items can have their own sub-items! This is Level 3.
4. Back to Level 1.

You can create deeper levels of nesting, but doing so might prove confusing to your readers.

Combined Bullet and Numbered list example:

Syntax:

*Level 1 (bulleted list)
**Level 2 (bulleted list) 
###Level 3 (numbered list) 
###Level 3 (numbered list) 
**Level 2 (bulleted list)
***Level 3 (bulleted list)
#Level 1 (numbered list) 
**Level 2 (bulleted list) 
##Level 2 (numbered list) 
##Level 2 (numbered list)

Result:

• Level 1 (bulleted list)
  • Level 2 (bulleted list)
    1. Level 3 (numbered list)
    2. Level 3 (numbered list)
  • Level 2 (bulleted list)
    • Level 3 (bulleted list)

1. Level 1 (numbered list)
   • Level 2 (bulleted list)
   1. Level 2 (numbered list)
   2. Level 2 (numbered list)

Adding Hidden Details

An expandable area allows you to display the major items in your list by default. Every item is still there, but it needs to be expanded to become visible. An expandable area is created by adding a minus - character after the star * characters.

• This is a Level 1 item.
• This Level 1 item has Hidden Details. Click the Plus [+] to open it.
  [+]
  • This is a Level 2 item. Clicking the Minus [-] will close it.
  • This Level 2 item did not need the minus character.
• Back to Level 1.

Expandable areas work with Bulleted and Numbered lists.

Text Continuation

Text can be forced to continue at the same indentation level in a list without having a bullet or a Number assigned to it. This is accomplished by having a Plus + character start each line. The number of Plus characters controls the indentation level.

• This is a Level 1 item.
  This line begins with a single Plus character
  • This is a Level 2 item.
    This line begins with a 2 Plus characters
• Back to Level 1.

Expandable areas work with Bulleted and Numbered lists.

Creating a Definition List

A definition list displays a term that is aligned flush left; the term's definition is positioned on the subsequent line and indented. Here's an example:

unordered list

A list in which the order of the items is unimportant; also called a bulleted list.

To create a definition list, do the following:

1. At the beginning of a line, type a semicolon (;).
2. Type the term to be defined.
3. Type a colon (:).
4. Type the definition.
   • Your line should look like this: ;term:definition
5. Press Enter.
6. Do one of the following:
   1. To type another item, go to Step 2, above.
   2. To end the list, press Enter again.

Better definition lists can be created using the DL plugin.

Creating a Table of Contents List

Use the {maketoc} plugin to automatically create a table of contents, based on the headings on the current wiki page.

For example, using {maketoc} on this page will produce:



You can use the following options to customize the table of contents list:

Option	Description	Valid Values
type	For backwards compatibility from older syntax: {maketoc:box} . Optional.	box
maxdepth	Defines how many heading levels to include in the list. If 0, then all headings will be included. Default = 0	Numeric
title	Title (heading) of the table of contents. Use title="" to have no title. Default = Table of Contents Note: The title will be translated, if available. Introduced in 1.9.10	Alphanumeric
showhide	Create a link that will collapse (that is, hide) the table of contents link. Default = N	Y or N
nolinks	Create the table of contents without links. Default = n (links will be created).	Y or N
nums	Specify if the items in the table of contents listing should be numbered. Default = n (use bullets instead of numbers).	Y, N, Force (same as Y)

Remarks

{maketoc:box} produces a table of contents without respect to the hierarchical order.
Example:

'index Wiki-Syntax Lists Quick Reference Creating a Bulleted List Creating a Numbered List Creating a Nested List Bullet list example: Numbered list example: Combined Bullet and Numbered list example: Adding Hidden Details Text Continuation Creating a Definition List Creating a Table of Contents List Remarks

---

picture not found img/icons2/alert.gif