HTML Help - Information for the HTML Help compiler

This tool allows you to include two types of keywords in your design to facilitate both navigation and search. Both ways can function independently, but also in parallel. There are only two small tabs in the tool's window, separate for each type. We should place objects containing sets of keywords in the header of the HTML document, within the HEAD; we can combine them.

Launching

You can launch the described tool with the button marked with the icon shown above. The button to launch this window can be found in the HTML Help menu and on the HTML Help toolbar.

Keywords

Keywords are a supplement when creating the index. In order for them to be included, you need to check the "Include keywords from HTML files" option in the project editor, under the general settings tab. Note that keywords, although placed in the compilation process as index elements, are not its components registered in the index file.

Keyword
Enter a keyword in this field. We can add single keywords as well as any number of them at once. In this case, you should pay attention to two things: Keywords cannot contain spaces, and we separate them with a semicolon, also without spaces, for example: "Word; Word; Keyword". We add them using the plus button next to the field below.

Keywords
This field contains a set of keywords that have been entered. We can delete them or add new ones using the buttons next to the field.

ALink names

ALinks are keywords that represent a link between a particular document and other documents. If an ALink refers to eight documents, using it will show a list of all those documents. Practically, it looks like we put the same ALink in the selected documents, while calling it will show a list of all those documents in which it was placed.

ALink name
In this field we enter the name of the ALink. We can add both single words, as well as any number of them at once. In this case, two things should be noted: ALink names must not contain spaces, and we separate them with a semicolon, also without spaces, for example: "Name;Name;Name_ALink". We add them using the plus button next to the field below.

ALink Names
This field contains a set of ALink names that have been entered. We can delete them or add new ones using the buttons next to the field.


Related topics

To top