Book map

The DITA bookmap specialization represents the key markup requirements for managing DITA content through book-oriented publication processes, including book metadata and book structures for organizing content.

Purpose

Book maps enable authors to produce documents that are structured like traditional print-oriented media. They also provide metadata for recording information about the book, including authors, owners, versions, and production history.

Content model

A book map can contain the following document structures:

  • Titles
  • Metadata
  • DITAVAL references for filtering
  • Map resources
  • Front matter
  • Parts
  • Chapters
  • Appendixes
  • Back matter
  • Relationship tables

Other components of a book map enable authors to specify that artifacts such as a table of contents (TOC) or an index should be generated.

The bookmap module has a dependency on two domains from the base specification. The <mapresources> element comes from the mapgroup-domain module, and can be used to group resources such as key definitions near the start of the map. The <ditavalref> element comes from the DITAVAL-reference domain module, and can be used to support branch filtering for the entire book.

Example

The following code sample contains some common markup for a book map:

<bookmap id="taskbook">
  <booktitle>
    <mainbooktitle>Product tasks</mainbooktitle>
    <booktitlealt>Tasks and what they do</booktitlealt>
  </booktitle>
  <bookmeta>
    <author>John Doe</author>
    <bookrights>
      <copyrfirst>
        <year>2020</year>
      </copyrfirst>
    </bookrights>
  </bookmeta>
  <mapresources>
    <!-- Key definitions used for the map -->
  </mapresources>
  <frontmatter>
    <preface href="task-preface.dita"/>
  </frontmatter>
  <chapter format="ditamap" href="installing.ditamap"/>
  <chapter href="configuring.dita"/>
  <chapter href="maintaining.dita">
    <topicref href="maintain-storage.dita"/>
    <topicref href="maintain-server.dita"/>
    <topicref href="maintain-database.dita"/>
  </chapter>
  <appendix href="task-appendix.dita"/>
</bookmap>