Editing a bookmap

Last Updated : Mar 14, 2024 |

About this task

Use this procedure to add the elements required for the book. Not all steps will apply to all books. Perform the steps that are appropriate for your book. For example, do not add the legal topic in quick reference guides, articles, and video publications.

Before you begin

Create the bookmap. For more information, see Creating a map.

Procedure

  1. In Publication Manager, open the publication that includes the bookmap.
  2. Add a title for the book if one does not already exist:
    1. In the publication tree, expand Booktitle, and then right-click MainBookTitle and select XML Attributes.
    2. Type or overwrite the book title in the Insert Values for ‘Main Book Title’ dialog box and then click OK.

      For information about adding a trademark to the Main Book Title, see Adding a trademark to the mainbooktitle in a deliverable map.

  3. Optional To include a book library that displays under the book title on the cover page:
    1. Right-click the MainBook Title element and then click Insert Before > Book Library.
    2. Type or overwrite the book title in the Insert Values for ‘Book Library’ dialog box and then click OK.
  4. Optional Add a short title for the book, which displays in the document footer:
    1. In the publication tree, right-click the publication bookmap and select Check Out With.
    2. Select Oxygen XML Author.
    3. Make sure the editor is set to Full Tags.
    4. Locate the mainbooktitle element within the booktitle element.
    5. Place your cursor after the mainbooktitle element, press Enter and select the booktitlealt element.
    6. Enter the alternate book title in the booktitlealt element.
    7. Save and close the publication bookmap.
  5. In Front Matter > Notices, add the legal page.

    A few solutions have unique legal content. For most programs, select the Common Standard Legal Page topic. For more information, see Adding the common legal topic to your publication.

  6. Add chapters to the book:
    1. Right-click the Bookmap element and then click Add Within > Chapter.

      Alternatively, right-click the chapter that comes after the chapter you are adding and then click Insert Before > Chapter.

    2. In the dialog box that is displayed, click Browse, browse to and select the DITA map to add to the chapter and then click Insert.
    3. Click OK.
    Note:

    • To divide the chapters into logical groups, you can use the Part element. For example, for a large, complicated install guide or upgrade guide that contains different deployment or upgrade scenarios, you can use the Part element to create main headings for each scenario and then group the relevant chapters under the headings. See Creating chapter groupings in a bookmap by using the part element for more information.

    • Do not reference a bookmap within a bookmap because a publication can have only one bookmap added at the root level.

  7. To add an appendix to the book:
    1. Right-click Back Matter in the publication tree and then click Insert Before > Appendix.
    2. Navigate to the DITA map or topic that you want to add to the appendix.

    If required, you can add more than one appendix to the book.

  8. To add a glossary to the book:
    1. Expand Back Matter > Book Lists in the publication tree.
    2. Right-click Index List and then click Insert Before > Glossary List.

      If the book does not have an index, right-click Book Lists and then click Add Within > Glossary List.

    3. Navigate to the DITA map for the Glossary element.
    4. To add glossary topics, right-click the map and then click Add Within and navigate to the appropriate topic.
  9. Check in the bookmap when you finish working with it.