GEOS SDK TechDocs
|
| 
4.4 Using Hyperlinks
| 
5 HelpControlClass Reference
Once the help file is created, all the contexts are defined and set, and all the hyperlinks (if any) are established, you can generate the help file. When the file is generated, it is automatically placed in USERDATA\HELP, and it will have the same name as the GeoWrite document being edited. Thus, if you are editing a file called "helpsamp," the help file would be USERDATA\HELP\ helpsamp .
The help file may be compressed or not. The default is to compress the help data to save disk space. Since help files are read-only, the help controller decompresses the data when loading it, then simply discards it when done. The "Compress Data in File" option in the Help Editor menu allows you to specify whether the help file should be compressed or not (just about the only time it should not be compressed is for Status Help).
To generate the help file, simply select "Generate Help File" in the Help Editor menu. The generation is one-way; you can not edit a help file. You should, therefore, keep your original GeoWrite documents containing the help text available in case they require editing or update .
GEOS SDK TechDocs
|
| 4.4 Using Hyperlinks
| 5 HelpControlClass Reference