Creating chapter groupings in a bookmap by using the part element

Last Updated : Apr 08, 2024 |

To divide a document's chapters into logical groupings, you can use the part element to provide a title and optional introduction to group the chapter under. The part element will typically be used with larger books that contain different types or categories of information. Do not use just to get another level of hierarchy in a standard book. A good example would be a large, complicated install guide or upgrade guide that contains different deployment or upgrade scenarios. In this case, you can use the part element to create main headings for each scenario and then group the relevant chapters under the headings.

About this task

Consider the following rules and restrictions when using part elements in a bookmap.

  • If you use the part element, always have more than one part element. Otherwise, there is no reason to use it.

  • You can include chapters in a bookmap before a part element, but you cannot include a chapter after a part element in a bookmap. Chapter elements must either be in part elements or before the first part element. This makes sense because of the way that part is intended to be used. Do not use as just another level of hierarchy. Rather, use for major separations in a book.

  • Each part element must have a navtitle or a topic at the top level. If you want to provide just a title, apply the navtitle directly to the part element. Or, if you want a topic at the top level of the part to be used as a target for links, you can add the href directly to the part element.

  • If you use a topic at the top level of a part, ensure the topic contains only a title without any content. This way, you can link to the part in the output. Including text in a topic at the top level of a part element might give unexpected results. If you choose to include text in a topic at the top level of a part element, and you experience issues, remove the text.

Procedure

  1. Check out the bookmap in which you want to insert the part elements.
  2. Right-click the element before which you want to add the part element and select Insert Before > Part.

    Remember that you can have chapters before the first part element but you cannot have chapters after the first part element. Usually, you will be inserting a part element before an Appendix element or Back Matter element.

  3. Specify the title or introduction topic for the part:

    • To include just a title and not an introduction topic for the part, right-click the part element, select XML Attributes, and then type the title in the Navigation Title field of the XML Attributes dialog box.

    • To include an introduction topic, right-click the part element, select XML Attributes. In the XML Attributes dialog box, click Browse, browse to and select the topic, and then click OK.

  4. Nest the appropriate chapter elements under the part.
  5. Repeat steps 2 through 4 for each part element that you want to include.
  6. Check in the bookmap when you finish working with it.

    If an error occurs while you save and check in the bookmap, address the error. Do not just accept it and continue the check in.