The Helpview application can be used to display any help volume. It supports
all types of hyperlinks except application-defined links (because it cannot
know how your links are to be interpreted).
If you are writing application help and your application is ready to use,
you can also view your help by running your application, then requesting
help just as a user would.
To run `helpview' |
 |
If the volume.hv file for the volume you want to display is either in the current directory or has been "registered," execute this command:
helpview -helpVolume volume &
|
Or, if the volume.hv is in another directory (and hasn't
been registered), execute this command:
helpview -helpVolume /full-path/volume.hv &
|
Or, if you are using HP VUE 3.0 (or later), open a File Manager view of the directory where the volume.hv file is and double-click its icon. The default action for a .hv file is to run helpview.
The -helpVolume parameter can be shortened to -h in any of these commands.
Example. Suppose you just edited your help volume. You would first
process it with the HelpTag software:
If no errors occurred, you could then display it with this command:
Example: A Personal Help Directory.
During a project, you may want to access the help volume you are developing, but not expose it to all users on your system. For example, suppose your working directory is /projects/rivers/help/ and your help volume is named Myvolume.
First, create a personal help directory in your home directory where you can register the volume:
mkdir -p $HOME/vhelp/volumes/C
|
Now create a symbolic link to the Myvolume.hv file (which is created by the HelpTag software):
ln -s /projects/rivers/help/Myvolume.hv $HOME/vhelp/volumes/C/Myvolume.hv
|
You can now display the volume with the following command (regardless of your current working directory) because the vhelp/volumes/C/ directory within your home directory is one of the first places the help system looks for help volumes.
helpview -helpVolume Myvolume &
|
To display the online version of the guide you are now reading, you can execute this command from any directory:
helpview -helpVolume HPHelpKit &
|
See Also.
Printable version
