Reference chapter in a multilevel structure

Add & manage content

Platform_KC
Cloud

A reference chapter can be added to the product guide to provide detailed information for advanced users. A group is created in the structure when a parent/child relationship is created by demoting a rule beneath the Reference Chapter rule.

Content or style guide rules

  • The reference chapter can be added before or after the FAQ chapter, but it must be added to the book after the First Chapter and User Guide chapters.
  • Each product guide can include several reference guides, if topics for different parts of the product need to be kept separate.
  • When the Reference chapter is included in the book it must contain at least one reference topic.

Structure rules

Reference Chapter Rules

Group settings

The group settings are taken from the Reference Chapter Rule. The group is optional. The group has a flexible sequence and is listed adjacent to the FAQ Chapter group in the structure, so the order of the FAQ group and the Reference group can be swapped in the book.

Rules

  • Rule 14: Reference Chapter

    The Reference Chapter is optional, but when used only one occurrence of chapter can be added to the book. Location sequence is set to Flexible - can be used in the book before or after the FAQ Chapter, but cannot be used before the User Guide chapters or after the Glossary or Index.

  • Rule 15: Reference Topic

    At least one Reference topic must be used when the Reference Chapter is added to the book. The location sequence is Fixed - the topics must be added after the Reference Chapter topic, and be demoted to child topics in the book's content pane.