Document! X & HelpStudio Bundle 2022.1
Working with Images and Tables / Tools / Project Index Editor
In This Topic
    Project Index Editor
    In This Topic

    Document! X and HelpStudio Bundle provides 2 ways in which you can work with the index keywords defined in your project:

    1. Whilst you are editing in the Topic editor you can add index keywords for that Topic directly to the Topic Keywords Editor. In the Content File Editor, you can switch to the Keywords Content Type to add index keywords for the selected item.
    2. To get an overall view of all of the Conceptual Topic keywords defined in the project you can use the Project Index Editor, described in this topic.

    Project Index Editor Fundamentals

    Open the Project Index Editor

    From the Tools tab, click the Project Index Editor button.

    Add a new Keyword

    1. Select the  New Project Index Editor toolbar button.
    2. On the displayed dialog, type the new keyword and identify the target topics that the keyword should be associated with.
    3. Select Ok to save the new keyword.

    There are a couple of other ways to create a new Keyword that don't require you to open the Project Index Editor:

    1. Right-click on a Topic in the Project Explorer and click the New Index Keyword menu item.
    2. Switch to the Index Keyword editor in a specific Topic by clicking on the Index Keywords entry on the Topic Editor view strip along the bottom edge of the Topic Editor.

    Edit a Keyword

    1. Select the Keyword you want to edit in the Project Index Editor.
    2. Type the new desired keyword in the Keyword field on the right hand side of the editor.

    Remove a Keyword

    1. Select the Keyword you want to remove in the Project Index Editor.
    2. Select the  Delete Project Index Editor Toolbar button.
    3. The selected Keyword will be removed from all Topics in which it was defined.

    Add an existing Keyword to another Topic

    You might wish to have a single index keyword point to more than one Topic in your help system.

    1. Select the Keyword in the Project Index Editor.
    2. On the Targets toolbar, select the  toolbar button.
    3. On the displayed Topic Picker dialog, select the Topic you want to add the Keyword to.
    4. Select Ok.
    5. The selected Topic will be added to the list of targets for the Keyword.

    Find a Keyword

    1. Click the  Find button on the Project Index Editor Toolbar;
    2. Type the keyword you are looking for and press Enter;
    3. If a match is found, the first keyword matching the text you typed will be selected;
    4. Press Enter again to find the next match.

    Show or Hide automatically generated keywords

    You can filter the list of keywords that are shown in the Project Index Editor to hide keywords that are automatically generated.

    To toggle between hiding and showing automatically generated keywords in the Project Index Editor, click the  Show automatically generated keywords toolbar button.