
Documentation
Word Exporter for ConfluenceBrowse
Documentation
Word Exporter for ConfluenceTable of Contents
Add a Word table of contents built from the headings in your exported pages.
Overview
When enabled, a table of contents is inserted after the cover page (if there is one) and before the main content. It is a real Word table of contents field (TOC), built from the Word heading styles in the document, so it works like a contents page you added in Word yourself.
Enabling the Table of Contents
The table of contents is configured per template:
- Go to Confluence Settings → Word Exporter
- Open a template to edit (or create a new one)
- Turn on Table of Contents
- Set the Depth (see below)
- Save the template
Depth Setting
Control how many heading levels appear in the table of contents:
| Depth | Headings Included |
|---|---|
| 1 | Heading 1 only |
| 2 | Heading 1 and Heading 2 |
| 3 | Heading 1, Heading 2 and Heading 3 |
A depth of 2 is a good default for most documents. Use depth 3 for technical documentation where sub-sections are important for navigation.
Opening the Document
Word fills in the contents and their page numbers when it opens the file.
- Word may ask: "This document contains fields that may refer to other files. Update the fields?" Choose Yes.
- After you edit the document, right-click the table of contents and choose Update Field to refresh it.
- In other apps, such as Google Docs or Pages, the table of contents can appear empty. Right-click it and update the table of contents.
The export dialog's preview doesn't show the table of contents or page numbers. They appear once the file is opened in Word.
Multi-Page Exports
In One merged Word document, the table of contents covers all exported pages in order. Child pages are nested one heading level below their parent, so the contents follows your page tree.
Table of Contents and Cover Page
If both a cover page and a table of contents are enabled, the order is:
- Cover page
- Table of contents
- Content pages
Stuck on something this page does not cover? Ask the developers.