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 2 Organizing and Writing a Help Volume

A Help Volume at a Glance

» 

Technical documentation

Complete book in PDF
» Feedback
Content starts here

 » Table of Contents

 » Glossary

 » Index

The following markup illustrates important elements of a help volume and the tags used to enter them. Indentation is used to highlight the hierarchical relationship of the elements; you don't need to indent the help files that you write.

   All entity declarations go here (before any other markup).



   <helpvolume>



        <metainfo>



             <title> Volume Title



             <copyright>

             Copyright topic goes here ...



             <abstract>

             The abstract describing your help volume goes here.



                .

                .

                .  There may be other meta information topics.



        <\metainfo>



        <hometopic> Home Topic Title

                    Body of the home topic goes here ...



             <s1> Title of First Subtopic Goes Here

                  Body of the first subtopic goes here ...

   

             <s1> Title of Second Subtopic

                  Body of the second subtopic goes here ...

   

               .

               .

               .



        <glossary>

        The body of the glossary, which contains term definitions, goes here ...



   <\helpvolume>


The rest of this chapter describes how to organize your help volume. Writing individual topics is covered in the following chapter.

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