Jump to content United States-English
HP.com Home Products and Services Support and Drivers Solutions How to Buy
» Contact HP
More options
HP.com home
Common Desktop Environment: Help System Author's and Programmer's Guide > Chapter 2 Organizing and Writing a Help Volume

Adding a Nonhierarchical Topic

» 

Technical documentation

» Feedback
Content starts here

 » Table of Contents

 » Glossary

 » Index

Topics entered with the Chapter, Sect1, Sect2, Sect3, Sect4, Sect5 element tags automatically appear in the topic tree. When a title is selected in the topic tree, the corresponding help topic is displayed in a general help dialog box.

Sometimes you may want to create and display a topic independent of the structural hierarchy you have created. These nonhierarchical topics are useful for creating custom definition links that pop-up a topic in a quick help dialog box.

Appendix is the tag for a free-floating heading not tied to the Sect hierarchy. It may contain inline elements.

Appendix has the common attributes, including the ID attribute and the XRefLabel atttribute, and also the Label attribute. When using the Appendix element for nonhierarchical topics, the value of the Role attribute should be "notoc".

To Add a Nonhierarchical Topic

  • Add the nonhierarchical topic using the BridgeHead element as follows:

    <Appendix id="bh-some-id" role="notoc">
    text of the topic
    </Appendix>

Presumably, a definition link to display this topic will exist within some other topic in the help volume.

The link might look like this:

Here's a sample of a pop-up <link linkend="bh-some-id">
definition link.</link>

The words "definition link" become the active hyperlink and will be displayed with a dashed underline. Selecting the link displays the text of the topic in a quick help dialog box.

Printable version
Privacy statement Using this site means you accept its terms Feedback to webmaster
© Hewlett-Packard Development Company, L.P.