VTS enables you to easily set up links between the topics in either a custom Windows™ Help File or a Windows™ HTML Help File and the tags in your VTS application. This section provides instructions on doing so.
Note: This section assumes that you either know how to generate custom Windows™ Help Files, and are familiar with associating topic IDs with map numbers within the help file, or have been provided with a Windows™ Help File and a list of its topic IDs and corresponding map numbers.
Terms Used in this Section
|
Term |
Description |
|
Topic ID |
A topic ID is a text string that identifies each topic in a Windows help file. Topic IDs are typically the title of the topic with all spaces and invalid characters removed. For example, if you have two topics within your original document titled, "Introduction to Programming" and "Part 1: Modules", the topic IDs will typically be "IntroductionToProgramming" and "Part1.Modules". |
|
Map Number |
A map number is a number assigned to a topic ID in a Windows help file. A map number can be referenced by an outside application (such as a VTS application) to open a specific help topic within the help file. Map numbers can be automatically assigned by help authoring software (such as Doc-to-Help or RoboHelp), or can custom numeric ranges can be assigned by the help author. (In larger systems, the VTS developer or VTS programmer may dictate the map numbers, and the help author may later assign the numbers in the help file.) |
|
.HLP File |
.HLP files are compiled Windows help files. Both .HLP and .CNT files should be shipped to customers in order that they can run and view the help file. |
|
.CHM File |
.CHM files are compiled Windows HTML help files. This is a newer format than the .HLP file. If using this format, only the .CHM file should be shipped. |
|
.CNT File |
.CNT files provide a menu of all the topics and sub-topics that can be found in a compiled Windows help file. (not a HTML help file) You will recognize a contents file by its "books" and "pages" icons. Both .HLP and .CNT files should be shipped to customers in order that they can run and view the help file. |
|
.HPJ File |
.HPJ files are the files used by a help compiler to generate a Windows help file. The .HPJ file provides the compiler with a list of instructions as to the way the Windows help file should appear, the .RTF files that should be included, and the map numbers assigned to each topic ID in the help file. The .HPJ file does not need to be shipped to customers in order that they may run and view the help file. This file is strictly used by the help author. |
|
.HHP File |
This is the HTML Help equivalent to the .HPJ file, providing the same functions. |
To link tags to topics in a custom Windows™ Help File (.HLP):
1. Assign custom map numbers to the topic IDs in your Windows™ Help File and recompile the help file. (If you have a help author who is responsible for help file generation, obtain the list of topic IDs and corresponding map numbers from your help author.)
2. Copy the .HLP (Windows™ Help File) and the .CNT (contents file) into your VTS application directory.
3. Open your VTS application's Config.ini configuration file.
4. Enter "HelpFile = " followed by the name of your custom help file. You do not need to specify the .HLP extension. For example, if your .HLP file is named, "MyCustomHelp.hlp":
[SYSTEM]
HelpFile = MyCustomHelp
5. Save and close the Config.ini file.
6. Run your VTS application.
7. Log on to the VTS application using a user account that has at least the Configure, Tag Add, and Tag Modify properties.
8. Click the Configure button. The Configuration Toolbox opens.
9. Click the Tag Browser button. The Tag Browser opens.
10. Select the tag with which you wish to associate a specific topic from the Windows™ Help File.
11. Click the Properties button. The tag properties folder for the selected tag opens and displays the properties on the ID tab.
12. Enter the map number in the Help Search Key field.
13. Click the OK button. The tag properties folder closes and you are returned to the Tag Browser.
Repeat steps 10 through 13 until you have associated all the tags in your system with a topic in the Windows™ Help File.
To link tags to topics in a custom Windows™ HTML Help File (.CHM):
1. Assign custom map numbers to the topic IDs in your Windows™ HTML Help File and recompile the help file. (If you have a help author who is responsible for help file generation, obtain the list of topic IDs and corresponding map numbers from your help author.)
2. Copy the .CHM (Windows™ HTML Help File) to your VTS application directory
3. Open your VTS application's Config.ini configuration file.
4. Enter "HelpFile = " followed by the name of your custom help file. You do need to specify the .CHM extension. For example, if your .CHM file is named, "MyCustomHelp.chm":
[SYSTEM]
HelpFile = MyCustomHelp.chm
5. Save and close the Config.ini file.
6. Run your VTS application.
7. Log on to the VTS application using a user account that has at least the Configure, Tag Add, and Tag Modify properties.
8. Click the Configure button. The Configuration Toolbox opens.
9. Click the Tag Browser button. The Tag Browser opens.
10. Select the tag with which you wish to associate a specific topic from the Windows™ HTML Help File.
11. Click the Properties button. The tag properties folder for the selected tag opens and displays the properties on the ID tab.
12. Enter the map number in the Help Search Key field.
13. Click the OK button. The tag properties folder closes and you are returned to the Tag Browser.
Repeat steps 10 through 13 until you have associated all the tags in your system with topics in the Windows™ HTML Help File.
You may choose either of the following two methods to test the help topic associations in the application:
Testing Help Topic Associations Via the Tag's Shortcut Menu
1. Place the application in operation mode (i.e. close the Configuration Toolbox).
2. Right-click each tag's graphic representation (use the tool tips to guide you). A shortcut menu with options applicable to the tag is displayed.
3. Select Help from the shortcut menu. The Windows™ Help File opens and displays the topic associated with the map number provided for the Help Search Key property.
Testing Help Topic Associations Via the Tag's Properties Folder
1. Open the Configuration Toolbox.
2. Click the Tag Browser button. The Tag Browser opens.
3. Select a tag.
4. Click the Properties button. The tag properties folder for the selected tag opens and displays the properties of the ID tab.
5. Click the Help button that appears at the bottom of the tag properties folder (between the OK and Cancel buttons.) The Windows™ Help File opens and displays the topic associated with the map number provided for the Help Search Key property.