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
HP Help System Developer's Guide

Chapter 3 Writing a Help Topic

» 

Technical documentation

Complete book in PDF
» Feedback
Content starts here

 » Table of Contents

 » Glossary

 » Index

Each topic you write should have an element that marks the start of the topic:

   <element id=id> Topic Title

   The body of the topic

Where element is one of the following: chapter, s1, s2, ..., s9. The body of the topic may begin on any line after the Topic Title.

The topic's position within the topic hierarchy is determined by the element used to start the topic and by the element used to start the immediately preceding topic. For example, a topic that starts with <s2> and immediately follows a topic that starts with <s1> makes the<s2> topic a subtopic of the <s1> topic.

The id is required if the topic is to be accessed either from the application (if you are writing application help) or from a hyperlink.

The Topic Title can be any string. If the title string occupies more than one line in your source file, end all but the last line with an ampersand (&). To force a line break at a particular place within the Topic Title, use a backslash character (\).

Example. The following line marks the start of a topic using the <s1> tag:

   <s1 id=welcome>Welcome to My Application

To force the title to be displayed on two lines, you use a backslash (\) like this:

   <s1 id=welcome>Welcome to \ My Application

See Also. 

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