### 14.4 Generating a list of figures

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

DITA2Go supports title elements in imagemap elements, despite the DITA prohibition against this. If you put titles in image maps, those titles can be included in the list of figures. The DITA topic file containing the image map will no longer be valid DITA, but it will be well formed DITA.

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

The properties you can specify for a list of figures 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 figures; you can specify a file name, or you can simply allow DITA2Go to name the file after the map from which the list of figures is generated, with suffix LOF. For RTF output, no separate file is produced.

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

    [ListOfFigures]
    ; LOFFile = base name to use for output file, plus suffix LOF
    LOFFile = mapnameLOF
    ; LOFSuffix = suffix for the base file name, default LOF
    LOFSuffix = LOF

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

Text of the list title

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

    [ListOfFiguresText]
    ; LOFTitle = title text for list of figures
    LOFTitle = List of Figures

Each DITA2Go-supplied language configuration file includes a setting for LOFTitle; 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 figures:

    [ListOfFigures]
    ; LOFTitleFormat = format for LOF title
    LOFTitleFormat = FigureListTitle
    ; LOFFormat = default format to use for LOF entries
    LOFFormat = FigureListItem
    ; LOFTOCFormat = format for TOC entry for list of figures title
    LOFTOCFormat = LOF
    ; LOFXrefFormat = format for cross references to LOF
    LOFXrefFormat = FigureTitleXref

All values here are the default format names. 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.3.4 Including navigation titles from maps in the TOC

Next Topic: 14.5 Generating a list of tables

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.5 Generating a list of tables

14.6 Treating figure titles as table titles

14.7 Producing a glossary

14.8 Producing an index

14.9 Configuring variant booklist components