Table of contents

A table of contents lists the headings on a page, each one a link to its section. It is built from the headings themselves and changes as you write, so it is never out of date. Put one at the top of any page long enough to scroll: readers see at once what is there, and jump to the part they need. Here is one with its settings as they start:

Insert it

Type the command at the start of a line, or after a space, and press Enter. Or choose + on the toolbar, then Table of contents. If you had text selected, it takes its place.

It lists every heading, from Heading 1 to Heading 6, each under the heading before it that is a level higher. Click it to change its settings.

Bullet styles

Each example here lists only the four headings of Choosing which headings, further down, to keep it short: that is the Include headings with setting, described there.

Bullet, where it starts. The browser picks the marks, usually a dot, then a circle, then a square as the levels go down. Right for most pages.

Mixed: always a dot, then a circle, then a square, going down the levels. The same pattern as Bullet usually gives, fixed so that it cannot vary.

Circle: circles at every level. A lighter look.

Square: squares at every level.

Numbered: 1, 2, 3 at each level. Use it for a page read in order, such as a procedure.

None: no marks, only the indents. A clean look for a short list.

Section numbers

Include section numbers numbers the outline, 1, 2, 2.1, 2.2, 3, so readers can say “see 4.2”. Use it on long reference pages people cite. With the Numbered style, the section numbers take the place of the list’s own. This one lists the whole page:

Only the table of contents is numbered; the headings on the page are not.

A horizontal list

Display as Horizontal list puts the links on one line, separated by bars. Use it across the top of a page as a strip of links, or on a short page. Bullet styles do not apply. This one lists only this page’s main sections, using the heading levels below:

Choosing which headings

By level

Heading levels sets the highest and lowest level listed, from 1 to 6. Levels 2 to 2 lists only the main sections, as the horizontal list above does. Levels 3 to 4 lists only the smaller headings:

By name

Under Advanced, Include headings with lists only the headings that match, and Exclude headings with leaves out the ones that match. This one leaves out the sections every element page has, with Insert it|Good practice|Related elements:

Patterns

• * stands for any run of characters, and ? for any one character. Step* matches Step 1: Install and Steps.

• | separates alternatives: Setup|Install* matches either.

• The whole heading has to match. Step* does not match First step.

• Capitals count. step* does not match Step 1.

Changing its settings

Click the table of contents while you are editing and its settings open under it:

• Display as: Vertical list or Horizontal list.

• Bullet style: Bullet, Mixed, Circle, Square, Numbered or None.

• Heading levels: the highest and lowest level to list.

• Include section numbers.

• Advanced: Indent headings (how far each level steps in, such as 10px or 2em), Include headings with, Exclude headings with, a CSS class name for a site’s own styles, and Exclude in PDF export, which leaves it out of PDFs and printouts.

Changes show at once. To remove it, click it and press Delete.

Good practice

• Put it at the top, after a sentence or two saying what the page is about.

• Write headings as signposts. The table of contents is only as useful as the headings in it: “Installing on Linux” beats “Notes”.

• Keep headings in order: Heading 2 for sections, Heading 3 inside them. The list nests the way the headings do.

• Leave it off short pages. With three headings on one screen, it only pushes the content down.

Related elements

• Headings are what a table of contents lists.

• Link can point at one heading on a page, from anywhere.

• Page tree lists pages, as a table of contents lists sections.