Getting Started /

Keywords

You can associate a help topic with one or multiple Keywords to build the alphabetical Index of your help system. Like the Table of Contents (TOC), the Index is an important tool providing the user with easy navigation through the help system.

The Keywords pane displays the keywords of the current help project under the "Keywords" node. If you do not see the Keywords pane, on the View tab, click Keywords to display it.

Add a New Keyword

1.On the Project tab, in the Keywords group, click Add.

2.In the Keywords pane, enter a name for the new keyword.

3.Press Enter.

Remark: By default, a new keyword is added to the same level as the currently selected keyword. However, the Add button also allows you to add a new keyword as a child item to the selected keyword.

Delete a Keyword

1.In the Keywords pane, select the keyword that you want to delete.

2.On the Project tab, in the Keywords group, click Delete.

Rename a Keyword

1.In the Keywords pane, select the keyword that you want to rename.

2.On the Project tab, in the Keywords group, click Rename.

3.Enter a new name for the selected keyword.

4.Press Enter.

Edit the Structure of Keywords

As mentioned above, an keyword can contain child keywords. If you need to move selected keywords from a parent node into another node, you can do so by using the drag-and-drop method.

Associate Topics with Keywords

You can associate a topic with any number of keywords.

To edit the associations of the currently opened topic with keywords, you can simply check or uncheck the keywords in the Keywords pane.

Also, you can edit properties of an individual keyword to edit its associations with topics:

1.In the Keywords pane, select the keyword that you need.

2.On the Project tab, in the Keywords group, click Properties.

3.In the dialog, check the topics that should be associated with the selected keyword.

4.Click OK.

Using the KLink Macro

The KLink macro allows you to insert a hyperlink that will display the list of topics associated with specific keywords. When the user clicks on such a hyperlink and the help system finds only one topic associated with the keyword(s), that topic will be displayed immediately. Alternatively, if the help system finds more than one topic, it will suggest the user to select which topic to display.

To insert a hyperlink with the KLink macro into a topic:

1.In the word processor, put the cursor where you want to insert a hyperlink.

2.On the Insert tab, click Hyperlink.

3.In the dialog, in the left sidebar, click Macro.

4.In the Text to display box, enter the hyperlink text.

5.In the Command box, select "KLink".

6.In the Keywords box, enter one or more keywords (one keyword per line) that the KLink macro will search for.
If you need to specify a nested keyword, you can use the following syntax: Keyword1,Keyword2,...,KeywordN, where Keyword1 and Keyword2 are parent keywords containing the KeywordN keyword that you want to access.

7.Click OK.

Remark: The KLink macro is supported by the HTML Help (CHM) output format only.