Editing the index directly

Navigation:  Basic Working Procedures > Keywords and Indexes >

Editing the index directly

Previous pageReturn to chapter overviewNext page

Show/Hide Hidden Text

If you have the Professional or Server version of Help & Manual you can also edit the real-time index directly with the Index Tool in Project > Tools. Note that this tool is only available in the Professional and Server versions.

This tool enables you to edit keywords in all the topics where they occur simultaneously. You can also add keywords to multiple topics and delete keywords from multiple topics at the same time, in one quick operation.

 

prod_tip       Productivity Tips

Select Expanded View at the bottom of the Index Tool window to display links to the topics containing the index keywords. Double-click on the Index Tool title bar to undock or redock it.

Click to expand/collapseEditing keywords in the Index window

This method allows you to edit keywords in all the topics where they occur simultaneously. Any changes you make to the keyword in this editing dialog updates the keyword in all the topics where it is used.

1.Select the Index Tool in Project > Tools, this displays the index window to the right of the main editor pane.

IndexTool

2.Select a keyword in the index and then click on the btn_editcaption Edit Keyword tool in the Index Tool toolbar. You can select a master keyword or a child keyword.

dlg_index_editkeyword

To add the keyword to more topics select the topics on the right and click on <<

3.Edit the keyword in the Keyword: field, then click on OK to save your changes. This will save the modified keyword in all the topics whose IDs are listed in the Topic: list on the left.

Click to expand/collapseViewing Topic Options and the topic at the same time:

Working with index keywords is easier if you can see and the topic content at the same time. You can't undock the tab but you can display it next to the editor. To do this drag the tab to the right or left border of the editor (choose the border not currently occupied by the index tool). Drag back down to the tab bar to restore it to its original position.

exp_indexconfig
Drag the tab to the right or left editor margin to move it. Double-click on the Index
tool title bar to undock/redock it. Click on the "pin" icon in the Explorer title bar to pin/unpin it.

Since this can make the editor a little narrow on smaller monitors it can be helpful to undock the Index tool. To do this just double-click on the Index tool title bar. You can also get more space when you are working in this mode by pinning the Project Explorer to the left margin so that it collapses automatically when it is not needed.

See Tips & Tricks in the Project Explorer for instructions and more details on these features.

Click to expand/collapseHow to add new keywords in the Index window

New master keyword:

1.Select the Index Tool in Project > Tools to display the Index window, then select the btn_addkeyword Add Keyword tool in the Index toolbar.

dlg_addkeyword

2.Select New Master Keyword and type the keyword in the Keyword: field of the dialog displayed.

3.In the Available Topics: list select the topic IDs of the topics you want to use the keyword in. Use Ctrl+Click and Shift+Click to select multiple IDs.

4.Select BTN_Keyword_ID_Add to add the IDs to the Topics list, then click on OK to insert the new keyword in all the selected topics. You can also double-click or drag to the left to add topics to the list.

5.Click on Reload in the Index toolbar to redisplay the index.

New child keyword:

1.Select a master keyword in the Index window. The new child keyword will be added to this keyword.

2.Select the btn_addkeyword Add Keyword tool in the Index toolbar and then select New Child Keyword.

dlg_addkeywordchild

3.Enter the new child keyword in the dialog displayed and press on OK to confirm.

You can use the BTN_Keyword_ID_Add button to add the same child keyword to additional topics just select the topics in the list on the right and add them to the topics list on the left. If the master keyword is not stored in those topics it will be added too.

Click to expand/collapseHow to add keywords to additional topics

You can add selected keywords to additional topics or remove keywords from selected topics with the Index window tools.

1.Select the Index Tool in Project > Tools to display the Index window, select a keyword and open the editing dialog with the btn_editcaption Edit Keyword tool.

dlg_addkeyword

2.In the Available Topics: list select the topic IDs of the topics you want to use the keyword in. Use Ctrl+Click and Shift+Click to select multiple IDs.

3.Select BTN_Keyword_ID_Add to add the IDs to the Topics list, then click on OK to insert the new keyword in all the selected topics. You can also double-click or drag to the left to add topics to the list.

Click to expand/collapseAdding keywords to anchors

If topics contain anchors you can add keywords to the anchors instead of to the main topic.

1.Use any of the methods described above to add or edit a keyword in the Index window.

2.In the Edit Keyword dialog select the topic in the list on the left, then select the anchor in the Anchors: drop-down list in the middle. The keyword will then be assigned to the anchor for this topic instead of to the top of the topic.

Anchors will only be displayed for topics that actually contain anchors. See Anchors - jump targets for more details on how to enter and edit anchors.

Click to expand/collapseDeleting keywords

Warning: Deleting keywords in the Index window deletes the keywords from all the topics in which they occur! If you only want to remove keywords from individual topics use the btn_editcaption Edit Keyword tool or edit the keywords for the topics directly in the tab.

1.Select the Index Tool in Project > Tools to display the Index window.

2.Click on the btn_delkeyword Delete Keyword tool in the Index toolbar and confirm the prompt displayed.

See also:

IDs, Context Numbers and Keywords (Reference)

Anchors - jump targets