14.5 Generating a list of tables

DITA2Go produces a list of tables when your DITA source includes a bookmap tablelist element. DITA2Go includes in the list of tables the title element under each table element or element derived from table (unless you assign to it element types that do not include table), provided the table element has an id attribute. Requiring the id attribute gives you a way to exclude items from the list: DITA2Go omits the titles of table elements that have no @id.

If your project includes more than one <tablelist>, you can override the settings in this section with equivalent settings specific to each list of tables; see §14.9 Configuring variant booklist components.

The properties you can specify for a list of tables include:

File name and suffix

Text of the list title

Output formats.

File name and suffix

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

To specify a file name for the list of tables (HTML output only):

[ListOfTables]
; LOTFile = base name to use for output file, plus suffix LOT
LOTFile = mapnameLOT
; LOTSuffix = suffix for the base file name, default LOT
LOTSuffix = LOT

If you specify a value for LOTFile, LOTSuffix is ignored. See §14.2 Naming generated HTML list and index files.

Text of the list title

To specify a title for the list of tables, in the language configuration file referenced by your project:

[ListOfTablesText]
; LOTTitle = title text for list of tables
LOTTitle = List of Tables

Each DITA2Go-supplied language configuration file includes a default setting for LOTTitle; see §8.9 Localizing output headings, labels, and names. The value shown here is the default value specified in d2g_lang_en.ini.

Output formats

To specify formats for the list of tables:

[ListOfTables]
; LOTTitleFormat = format for LOT title
LOTTitleFormat = TableListTitle
; LOTFormat = default format to use for LOT entries
LOTFormat = TableListItem
; LOTTOCFormat = format for TOC entry for list of tables title
LOTTOCFormat = LOT
; LOTXrefFormat = format for cross references to LOT
LOTXrefFormat = TableTitleXref

All values here are the default format names, specified in configuration template d2g_config.ini, located in directory %OMSYSHOME%\d2g\config. If you change any format names, you must either alias your names to the default names, or provide your own definitions in a format configuration file; see §7. Configuring output formats.

Previous Topic:  14.4 Generating a list of figures

Next Topic:  14.6 Treating figure titles as table titles

Parent Topic:  14. Generating lists and indexes

Sibling Topics:

14.1 Understanding how DITA2Go produces lists

14.2 Naming generated HTML list and index files

14.3 Generating a table of contents

14.4 Generating a list of figures

14.6 Treating figure titles as table titles

14.7 Producing a glossary

14.8 Producing an index

14.9 Configuring variant booklist components

Table of ContentsIndex