14.1 Understanding how DITA2Go processes lists

If your DITA document includes a bookmap, by default DITA2Go uses bookmap elements that are specified as components of frontmatter and backmatter booklists to determine which lists to produce and what goes into each list; this is the preferred method.

Otherwise, DITA2Go can produce a table of contents and index for HTML output, or a table of contents for RTF output, from a ditamap, or from a bookmap that lacks booklist components; this is a legacy method.

A DITA bookmap can contain several elements that call for generated lists: toc, indexlist, figurelist, tablelist, glossarylist, bibliolist, abbrevlist, trademarklist, amendments, and booklist; the last is a general case for specialization. All are derived from topicref. By default, DITA2Go assigns element type properties List, Ref, Topic, and Map to each of these bookmap elements; see §11.2 Specifying properties of element types.

Some bookmap list elements may be authored directly, such as bibliolist, abbrevlist, trademarklist, and amendments. DITA2Go handles toc and indexlist via maps and indexitems, respectively. A glossarylist can be produced by a map of glossentry topics. However, figurelist and tablelist (and maybe abbrevlist and trademarklist) must be generated from topics.

To produce lists of tables and figures, DITA2Go collects copies of the table and figure titles, applies a user-specifiable format for the list, and adds top and bottom information.

If a DITA map element has a navtitle, DITA2Go uses that title in place of any user-specified title for a given list. If the navtitle includes an href, DITA2Go assumes the link points to a valid topic or map file, and therefore does not generate a list, but just converts the referenced file.

See also:

§27.2.1 Choosing between splitting and chunking

Previous Topic:  14. Generating lists and indexes

Next Topic:  14.2 Naming generated HTML list and index files

Parent Topic:  14. Generating lists and indexes

Sibling Topics:

14.2 Naming generated HTML list and index files

14.3 Generating a table of contents

14.4 Generating a list of figures

14.5 Generating a list of tables

14.6 Treating figure titles as table titles

14.7 Generating an index