When you run HelpTag (by using the helptag command), it reads your volume.htg file and any additional source files that are included using entities. Also, graphics file names are validated.
The output from HelpTag is a set of run-time help files. These files,
plus your graphics files, are read by the HP Help System to display help
topics.
HelpTag Output. All the run-time help files have the same base name as your volume.htg file. For example, if your volume.htg is named DeskScan.htg, then each generated file will start with DeskScan.
See Also.
For more information about the files generated by HelpTag, refer to “Gathering Run-Time Help Files”.
To run `helptag' |
 |
Be sure the /usr/vhelp/bin/helptag command is in your search path. (If you're not sure how to do this, contact your system administrator.)
Change to the directory where your volume.htg file is located
Run the helptag command as follows:
helptag command-options volume parser-options
|
Where command-options are options entered before the volume name and parser-options are options entered after the volume name. “Processing HelpTag Files (`helptag')” lists all available options.
Example: Commands.
The following command processes a help volume named MyVolume:
Using the -verbose option causes
the progress of the processing to be displayed on your screen:
helptag -verbose MyVolume
|
Adding a search path enables HelpTag to find files stored in a subdirectory
(of the current directory) named graphics/:
helptag -verbose MyVolume search=graphics
|
Example: A `helptag.opt' File.
Here's a sample helptag.opt file showing that each option is on a
separate line. It would be appropriate for creating a draft version of
the volume.
memo
onerror=go
search=graphics/
search=entityFiles/
|
Before producing the final version of the help volume, you would remove
the memo and onerror=go lines.
To review and correct parser errors |
|
Look at the contents of the volume.err file after running HelpTag (where volume is the base name of your volume.htg file).
Each error listed in the volume.err file begins with a string of asterisks (*****). For example, the following error was detected at line 54 of the file actions:
*****
Line 54 of actions,
Missing end tag for LIST:
...he execution host becomes the current working directory.
<s2 id=EverythingYouNeedToKnow>E...
Current element is LIST begun on Line 28 of actions.
|
A few lines of the file are shown to give you some context for the error. Also, there is a hint that the current element is a "LIST" started on line 28 of the same file. An <s2> is not allowed within a list, so it appears that the author forgot to enter the <\list> end tag.
It's possible for a single simple error to produce several error messages. This is because the first error may cause the parser to lose track of the intended context, making it impossible to interpret subsequent markup properly.
Printable version
