Skip to end of metadata
Go to start of metadata

The Table of Contents macro helps you navigate lengthy pages by summarizing the content structure and providing links to headings used on the page. Headings are indented progressively.


Step-by-step guide

  1. Choose Insert > Table of Contents in the editor toolbar.


  2. Adjust any of the Table of Contents parameters to best fit your page content.


  3. Click on the macro placeholder and choose Edit to display the parameters for this macro in the Macro Browser if you need to make further changes.

Parameters

Parameters are options that you can set for Expert Wiki macros to control the content or format of the macro output. The table below lists parameters that can be set in the Macro Browser for the Table of Contents.

Suggested Settings

It is suggested that the default settings are used so that all the pages have a similar Table of Contents.

 

Parameter

Default

Description

Output Type

list

  • list — produces a typical list type TOC.
  • flat — produces a horizontal menu-type series of links.

Display Section Numbering

clear

Select the check box to apply outline numbering to your headings, for example: 1.1, 1.2, 1.3.

List Style

none

Select the style of bullet point for each list item.  You can use any valid CSS style.  For example:

  • none — no list style is displayed
  • circle —  the list style is a circle
  • disc — the list style is a filled circle. This is the typical bullet list, and is used for this example list.
  • square — the list style is a square
  • decimal — the list is numbered (1, 2, 3, 4, 5)
  • lower-alpha — the list is lower-case, alphabetised (a, b, c, d, e)
  • lower-roman — the list style is lower roman numerals (i, ii, iii, iv, v, vi)
  • upper-roman — the list style is upper roman numerals (I, II, III, IV, V, VI)

Heading Indent

 

Sets the indent for a list according to CSS quantities. Entering 10px will successively indent heading groups by 10px. For example, level 1 headings will be indented 10px and level 2 headings will be indented an additional 10px.

Separator

brackets

This parameter applies to flat lists only.  You can enter any of the following values:

  • brackets — Each item is enclosed by square brackets: [ ].
  • braces — Each item is enclosed by braces: { }.
  • parens — Each item is enclosed by parentheses: ( ).
  • pipe — Each item is separated by a pipe:
  • anything — Each item is separated by the value you enter. You can enter any text as a separator, for example "***". If using a custom separator, be aware that text displays exactly as entered, with no additional white space to further separate the characters.

Minimum Heading Level

1

Select the highest heading level to start your TOC  list.  For example, entering 2 will include levels 2, and lower, headings, but will not include level 1 headings.

Maximum Heading Level

7

Select the lowest heading level to include.  For example, entering 2 will include levels 1 and 2, but will not include level 3 headings and below.

Include Headings

 

Filter headings to include according to specific criteria. You can use wildcard characters. See Sun's Regex documentation for examples of constructing regular expression strings.

 

Exclude Headings

 

Filter headings to include according to specific criteria. You can use wildcard characters.

Printable

checked

By default, the TOC is set to print. If you clear the check box, the TOC will not be visible when you print the page.

CSS Class Name

 

If you have custom TOC styles in your CSS style sheet, use this parameter to output the TOC inside <div> tags with the specified class attribute.

 


For questions or comments, contact the Computer Services Help Desk
HelpDesk@MissouriState.edu
417-836-5891