Bookmap content elements

The <bookmap> element is a map specialization used to describe the relationships among a set of DITA topics intended to be configured as a traditional book. Bookmaps consist of references to topics organized as book content. The topic references therefore are labeled according to the book components they point to, such as booktitle, frontmatter, chapter, and appendix.

The <abbrevlist> element references a list of abbreviations. It indicates to the processing software that the author wants an abbreviation list generated at the particular location.

The <amendments> element references a list of amendments or updates to the book. It indicates to the processing software that the author wants an amendments list generated at the particular location.

The <appendices> element is an optional wrapper for <appendix> elements within a bookmap.

The <appendix> element references a topic as a appendix within a book.

The <backmatter> element contains the material that follows the main body of a document and any appendices. It may include items such as a colophon, legal notices, and various types of book lists such as a glossary or an index.

The <bibliolist> element references a topic containing a list of bibliographic entries within the book. It indicates to the processing software that the author wants a bibliography, containing links to related books, articles, published papers, or other types of material, generated at the particular location. If no href attribute is specified on the <bibliolist> element, an external processor may generate a list of bibliographic entries at this location.

The <bookabstract> element references a topic used within a bookmap as a brief summary of book content, generally output as part of the book's frontmatter. It is used to help the reader quickly evaluate the book's purpose.

The <booklibrary> element contains the library information for a book. Library entries contain information about the series, library, or collection of documents to which the book belongs.

The <booklist> element is a general purpose element, designed for use in specializations, that references a topic or map containing a list of items within the book. For example, it could be used to reference a topic that contains a list of authors for the book. When a more specific element is already available, such as <tablelist> for a list of tables, that element should be used instead.

The <booklists> element references lists of various kinds within the book. For example, it can be used within frontmatter to reference a <toc>, <tablelist>, and <figurelist>, or within backmatter to reference a <glossarylist>, <indexlist>, and <abbrevlist>. It indicates to the processing software that the author wants the lists generated at the <booklists> location.

The <booktitle> element contains the title information for a book, including the library title, main title, subtitle, and other titles (as required).

The <booktitlealt> element contains the alternative title, subtitle, or short title for a book. It may be specialized into a specific element for those or other purposes.

The <chapter> element references a topic or map as a chapter within a book.

The <colophon> element references a topic describing how this document was created. In publishing, a colophon describes details of the production of a book. This information generally includes the typefaces used, and often the names of their designers; the paper, ink and details of the binding materials and methods may also receive mention. In the case of technical books, a colophon may specify the software used to prepare the text and diagrams for publication. The colophon may appear in the frontmatter or backmatter.

The <dedication> element references a topic containing a dedication for the book, such as to a person or group.

The <draftintro> element references a topic used as an introduction to the draft of this book.

The <figurelist> element references a topic containing a list of figures in the book. It indicates to the processing software that the author wants a list of figures generated at the particular location. If no href attribute is specified on the <figurelist> element, an external processor may generate a list of figures at this location.

The <frontmatter> element contains the material that precedes the main body of a document. It may include items such as an abstract, a preface, and various types of book lists such as a <toc>, <tablelist>, or <figurelist>.

The <glossarylist> element references a list of glossary entries within the book. It indicates to the processing software that the author wants a glossary list generated at the particular location.

The <indexlist> element indicates to the processing software that the author wants an index at the particular location. If no href attribute is specified on the <indexlist> element, an external processor may generate an index at this location. If the href attribute references a topic or map, that topic or map should contain a manually created index.

The <mainbooktitle> element contains the primary title information for a book.

The <notices> element references a topic containing special notice information, for example, legal notices about supplementary copyrights and trademarks associated with the book.

The <part> element references a part topic or a map that references part topics for the book. A new part is started. Use <part> to divide a document's chapters into logical groupings. For example, in a document that contains both guide and reference information, you can define two parts, one containing the guide information and the other containing the reference information.

The <preface> element references a topic or map containing introductory information about a book, such as the purpose and structure of the document.

The <tablelist> element references a topic that contains a list of tables within the book. It indicates to the processing software that the author wants a list of tables generated at the particular location. If no href attribute is specified on the <tablelist> element, an external processor may generate a list of tables at this location.

The <toc> element indicates to the processing software that the author wants a table of contents generated at the particular location. If no href attribute is specified on the <toc> element, an external processor may generate table of contents at this location. If the href attribute references a topic or map, that topic or map should contain a manually created table of contents.

The <trademarklist> element references a topic that contains a list of trademarks within the book. It indicates to the processing software that the author wants a list of trademarks generated at the particular location. If no href attribute is specified on the <trademarklist> element, an external processor may generate a list of trademarks at this location.