### Index of keywords

Index is an important part of the help, as providing a quick way to find desired information by the specified keyword. This navigation panel is a place where you can easily define the keywords, structure and appearance of the index for your help.

When you select the keyword in the index, an appropriate page is automatically displayed, where you can select, create (or open for editing) the topic file, that you want to be linked with current keyword. Alternatively you can set the "popup list", "popup item" or the "link" flag for current keyword.

The index of keywords navigation panel and the topic page is closely linked, and in fact constitute a whole, that can quickly and effectively define the index of keywords for your help.

The most important options and actions, concerning the editing of index and topics, are available also at ribbon bar (the Index tab).

In addition to the standard editing features, the Precision Helper offers a wide support of the clipboard and drag & drop functions. And not only in the context of the application and its instances, but also between Precision Helper and other applications (see below).

See also the description about the automatic insertion of keywords into the index and description about the contents editing.

Note:
If there is a more indices of keywords in the project file (eg, in window type definitions), a button for easy switching between them is displayed in the navigation panel.

Editing the Index of keywords

- Add key - adds a new keyword to the index. You can immediately edit the text in the offered inline edit field.
- Rename - renaming the selected index item (changing the keyword text). Precision Helper allows automatic detection of the topic title and its assignment to the keyword (see Options - General - Editing - Always use topic title).
- Delete - deletes the selected keywords (including potential subkeywords)
- Cut - cuts the selected keywords to the clipboard. Cut is fully functioning within the index of Precision Helper (and its instances) only. When transferring to another application, this action behaves as a "copy to the clipboard" (words in the index are not removed, after pasting from the clipboard in another application).
  Note: Selecting multiple items in the index is constrained to one level of items.
- Copy - copies the selected keywords to the clipboard (including the subitems when used within the Precision Helper)
- Paste - pasting the keywords from the clipboard
- Duplicate - duplicates selected keywords. This is actually the conjunction of events Copy + Paste.
- Dragging the mouse - you can freely drag the items (words, lists) both in the same index and / or between different instances of Precision Helper, and between Precision Helper and other applications (eg. text editor, spreadsheet processor, etc.)
- Tip:
  When you paste the list of files from the clipboard (such as copied in Windows Explorer, in a text editor, etc.) Precision Helper creates the keywords, including links to the files and inlcuding automatic detection of topic file titles.
- Move up - moves selected keywords up in the structure
- Move down - moves selected keywords down in the structure
- Move left - moves selected keywords left in the structure
- Move right - moves selected keywords right in the structure
- Sort - sorts the whole index alphabetically
- Expand all - expands all keywords (and subitems)
- Collapse all - collapses all keywords (hides subitems)
- Quick search - if you want to find a keyword in the index (according to the text or the topic file), use the Search field (in the top right corner)
- Go to ... - goes to the topic, that is assigned to the selected keyword, at the content
- API Tester - opens the API Tester tool (to quickly verify the definition of context help identifiers or the definition of keyword)
- Auto add keywords - opens the wizard for automatic insertion of keywords into the index

Selecting a topic

- Select file in project - selecting a topic via Project file selection dialog
- Select file - selecting a topic via system open file dialog
- Enter path or url - entering the topic path or the url manualy (the dialog contains also the combo box with all the topics defined anywhere in the project)
- Create a new topic from template - creates a new topic file, based on selected template, in the location, that you choose. Template selection dialog is displayed first, and then the system file dialog is displayed to select the file name and the path for newly created topic.
- Create a new topic from existing file - creates a new topic file in location, that you select, by copying an existing topic file, that you choose. For the existing topic file selection is displayed the Project file selection dialog and then the system open file dialog is displayed to select the file name and the path for newly created topic.
- Create a new blank topic - creates a new blank topic file in location, that you select
- Select from external help - selecting a topic, that is a part of the external help file (see the Project file selection dialog)
- Is a popup list of topic links - this option defines the current index item as popup list
- Is an item of popup list - this option defines the current index item as a child of the popup list (see above)
- Is a link to another keyword - defines the selected keyword as a link to another keyword. Linked keyword can be edited in the Object Inspector.
- Note:
  Precision Helper remembers the last "Select a topic" option (except the option "Include another contents") and offers this as the default in whole application.
- Save as template - by this option you can save any topic as a template for later use. Precision Helper automatically detects the styles, images, and other files, that are used in the topic, and saves them together with the topic file into the folder of newly created template.

More topic editing options

- Inspector - shows the Object Inspector, where you can edit properties of current keyword as well as the properties of the whole index
- Edit - opens the current topic in associated external editor. In drop down menu of the "Edit" button, there are all associated applications available (this means the predefined editor and browser and applications that are associated with the extension of currently selected file).
- Print - prints the current topic
- Preview - print preview of current topic
- Find - finds text on currently shown topic page
- Text size - option for displayed text size of current topic page
- Zoom in - zooms the topic page in
- Zoom out - zooms the topic page out
- Backward - goes backward in the browsing history of displayed topics
- Forward - goes forward in the browsing history of displayed topics
- Refresh - refreshes current topic view
- Synchronize - synchronizes the index of keywords with currenlty displayed topic

Style of the index (in Object Inspector)

- Default font - the default font for the index of the resulting help
- Frame ID - the default frame identifier, where the index items will be displayed (see also Other topic properties)
- Window ID - the default window type identifier, where the index items will be displayed (see also Other topic properties)

Copyright © 2008-2011 Precision software & consulting. All rights reserved.