14.1 Understanding how DITA2Go produces lists

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. The DITA rule is simple: if the booklist element is present, and has no @href, the processor (in this case DITA2Go) must generate the specified list. If you do not want a particular list, remove the booklist element from the bookmap, or condition it out.

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. To produce multiple variations of any of these booklist types, see §14.9 Configuring variant booklist components.

Some bookmap list elements may be authored directly, such as bibliolist, abbrevlist, trademarklist, and amendments. DITA2Go handles toc via maps and indexlist via indexterms. 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 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 processes the referenced file.

Elements with content to be included as entries in lists or indexes must have id attributes. You can omit an element from a list by eliminating its id attribute.

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 Producing a glossary

14.8 Producing an index

14.9 Configuring variant booklist components