An index is an alphabetically sorted list of keywords used in your project. Keywords can include multiple levels of subkeywords. You can associate keywords and subkeywords with topics that contain them and add cross-references to other keywords. You can also use project variables while adding keywords or subkeywords. You can add condition tags to index keywords to choose which keywords to publish in a specific output. You can also publish keywords so that your end users can use the keywords to search for and access specific topics in the output.
You can work with keywords and subkeywords through the Index panel of RoboHelp.
-
In the Index Keywords field, specify a keyword and press Enter. To specify a subkeyword, use a colon : between keywords. You can use variables while specifying keywords and subkeywords.
The new keywords and subkeywords are placed below the Index Keywords field. To remove a keyword/subkeyword, click
against it.
The new keywords/subkeywords are also placed in the Index panel according to alphabetical order of keywords. To access the Index panel, click Index in the Author toolbar.
Once you've added keywords and subkeywords to an index, you can link them to specific topics. To do this, follow these steps:
-
Pastaba:
To remove or edit a linked topic, click
next to the topic or right-click the topic and select Remove or Edit, respectively.
If the linked topic is open, the Properties panel > Topic tab > Index drop-down section displays the associated keywords and subkeywords. For more information, see Index.
Once you've added keywords and subkeywords to an index, you can link them to other keywords in the index. To do this, follow these steps:
-
In the Insert Cross Reference dialog box, you can filter keywords by typing the first few alphabets. Press the upward and downward arrow keys to navigate through the list of keywords. Press Enter to insert a keyword.
The keyword is added as a cross-reference below the main keyword.
Pastaba:
To remove or edit a cross-reference, click
next to the cross-reference or right-click the cross-reference and select Remove Cross Reference or Edit Cross Reference, respectively.
You can use a single index file in all outputs and apply condition tags to specific keywords/subkeywords to publish those in specific outputs. You can apply multiple condition tags to keywords and subkeywords in an index. To do this, follow these steps:
By default, an index is published in the output. You can change this setting in RoboHelp while configuring an output preset that you want to use to generate output. To do so, follow these steps:
-
Click the Content tab.
The Include Index field is selected by default, so index is published by default. You can select or deselect this field depending on whether you want to publish an index.
Pastaba:
For WebHelp and Responsive HTML5 output types, you can also control whether to show or hide an index from the respective skins. To do so, in the Layout tab of the Skin Components panel, you can enable or disable the Show Index option.
An index, if published, appears as a panel in the output. The index panel in the output displays all keywords and serves as an additional navigational channel for your end users. In the index panel, one can filter through keywords and click a keyword to quickly navigate to the associated topic. Your end users can use index keywords to quickly search for and access topics of their choice. Index keywords have the same ranking as search keywords.