For Cerner’s support and commitment to our clients regarding COVID-19, see the Cerner COVID-19 Response Center page on Cerner.com to access Cerner Recommendations, FAQs, and Lessons From the Field and visit the COVID-19 Client Collaboration Forum to ask questions and share experiences.
uCern is migrating to a new platform effective May 4, 2021 There will be no downtime. Cerner Wiki is not impacted by this migration.
uCern Help


Cerner Wiki Help

uCern Help

uCern System Requirements

Child pages
  • Table of Contents Macro
Skip to end of metadata
Go to start of metadata
The version of this page that you are viewing is the most current, approved content.

The Table of Contents macro scans the headings on the current Confluence page to create a table of contents based on those headings. This helps readers find their way around lengthy pages, by summarizing the content structure and providing links to headings.

Using the Table of Contents macro

Hint: For quick access from the editor toolbar, choose Insert > Table of Contents.

To add the Table of Contents macro to a page:  

  1. From the editor toolbar, choose (Insert) > Other Macros
  2. Find and select the required macro

Speed it up with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. In this example we're inserting the cheese macro.

To edit an existing macro: Click the macro placeholder and choose Edit. This will open the macro details, so you can edit the macro parameters.

Macro parameters

Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example).

 

Parameter

Default

Description

Output Type
(type)

list

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

Display Section Numbering
(outline) 

clear

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

List Style
(style) 

disc

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, alphabetized (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
(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
(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
(minLevel) 

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
(maxLevel) 

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
(include) 

 

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
(exclude) 

 

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

 

Printable
(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
(class) 

 

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.

Absolute URL
(absoluteURL )		 By default, the links in the TOC are relative URLs pointing to the current page. If checked, the links in the TOC will be full URLs. This setting is useful when you are including a page with a Table of Contents in another page, and want to control where the links should take the user.

 

 

Examples

The examples below are based on this table of contents:

Filtered Table of Contents

This example filters the headings to include those that contain 'Favorite', but excludes headings which end with 'Things'. The list is styled with Roman numerals.

 

ParameterValue
List Styleupper-roman
Include Headings
Favourite.*
Exclude Headings
.*Things

 

The resulting table of contents is:

Flat List

This example filters all headings to render a flat list of 'Unknowns' enclosed in square brackets (the default list style).

 

ParameterValue
Output Type
flat
Maximum Heading Level
2
Include Headings
Unknown.*

 

The resulting table of contents is: