14.3.1 Specifying a file name and title for the TOC

If your project requires producing more than one TOC, you can override the settings described in this section with equivalent settings specific to each variant TOC; see §14.9 Configuring variant booklist components.

For HTML output, DITA2Go creates a separate file for the TOC; you can specify a file name, or you can simply allow DITA2Go to name the file after the map from which the TOC is generated, with suffix TOC. For RTF output, no separate file is produced.

TOC file name

To specify a file name for the table of contents (HTML output only):

[Contents]
; TOCFile = base name to use for output TOC file, with suffix TOC
TOCFile = mapnameTOC
; TOCSuffix = suffix for the base file name, default TOC
TOCSuffix = TOC

If you specify a value for TOCFile, DITA2Go ignores TOCSuffix. See §14.2 Naming generated HTML list and index files. To keep the TOC with any material that precedes it in output, see §27.2.3 Providing a page break between title and TOC.

TOC title

To specify the text of a title for the table of contents, in the language configuration file referenced by your project:

[ContentsText]
; TOCTitle = title text for TOC
TOCTitle = Table of Contents

Each DITA2Go-supplied language configuration file includes a setting for TOCTitle; see §8.9 Localizing output headings, labels, and names. The value shown here is the default value specified in d2g_lang_en.ini. The <toc> @navtitle overrides the value of TOCTitle.

Previous Topic:  14.3 Generating a table of contents

Next Topic:  14.3.2 Deciding what to include in the TOC

Parent Topic:  14.3 Generating a table of contents

Sibling Topics:

14.3.2 Deciding what to include in the TOC

14.3.3 Specifying formats for TOC title, entries, and references

14.3.4 Including navigation titles from maps in the TOC