14.4 Generating a list of figures

DITA2Go produces a list of figures by default:

[ListOfFigures]
; GenerateLOF = Yes (default, generate for topics in map) or No
GenerateLOF = Yes

By default, DITA2Go includes in the list of figures the title element under 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. This gives you a way to exclude items from the list: DITA2Go omits the titles of fig elements that have no @id.

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 = mapnameLOT
; 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.

To specify a title for the list of figures, in a language configuration file:

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

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

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.

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
; LOFXrefFormat = format for cross references to LOF
LOFXrefFormat = FigureTitleXref

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.

The default format is whatever is specified for [ListOfFigures]LOFFormat.

Previous Topic:  14.3.5 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 processes 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 Generating an index