### Context help (the editor)

The context-sensitive help editor gives you the full control over assigning context IDs, alias IDs, source files and commentaries. Possibility to work in simple mode is advantageous for users who do not want to deal with detailed definitions.

This editor allows you to also enter so-called text popups, a visual indication of duplicities and last but not least copying and pasting the selected items to and from the clipboard (for easy collaboration with other applications).

Context help navigation panel is used for filtering the items, selecting the working mode and for setting an additional editor parameters. It also allows the batch assignment of context identifiers to all help topics.

Editor itself is located on the "Context help page", that shows the table of topics, context help identifiers, source files and comments. All editing and assignment can be performed directly in this table, so the creation of context-sensitive help in the Precision Helper is similar to the work in spreadsheet editor.

The table can be also filtered by the text, this with help of the Search field (in the top right corner of the page).

Editor offers wide clipboard support, where it is possible to transfer the entire selected rows or only the columns of data, and this is for application itself (and its instances), as well as for interaction between Precision Helper and other applications (ie. development tool, spreadsheet editor, etc.)

Note:
The table of context-sensitive help identifiers is automatically pre-filled with all topics defined anywhere in the project. You do not have to manualy add or remove topics, but only assign the identifiers. Saved are only the rows of context-sensitive help table, having completed the necessary data.

The context help navigation panel description is provided here.

Context-sensitive help editor options

- Add text popup - adds new "text popup" item (unlike the topics, the text popups cannot be pre-filled, so you have to manage them manualy)
- Add topic - as mentioned above, all topics are already pre-filled, but if you want to add some topic file, that is not defined somewhere in the project yet, you can use this option.
- Remove - this action removes the context help definition from selected rows of the table. For topics this mean the cleaning of all columns except the first, the selected "text popups" rows are removed completely.
- By pressing F2 key (or by starting write the text) you start the editing of selected cell. Different cells provide different support controls to enter desired data (ie. column "Source file" contains a combo box with all source files listed in this column, etc.).
- Copy to clipboard - selected cells are copied to the clipboard. Selection in the topics column (the first column) can be realized by mouse or by the keyboard, selection in other columns can be handled by the SHIFT and the CTRL keys. All rows in current column can be selected by CTRL+A hot key. If the cells in the first column (the topics) are selected, to the clipboard are copied whole rows (all columns), otherwise only the selected column for all selected rows are copied. Copying whole rows can be useful for transfer the definition to your development tool, this is when you do not use the header source files (.h, .ali).
- Paste from clipboard - this option has a very extensive possibilities (and consequences), depending on what information is placed in the clipboard and what cell is selected (focused).
  - When the clipboard contains whole definition rows - always set focus on the first column (otherwise the data will be pasted into the irrelevant columns). The data from the clipboard will be inserted always from the row on which you stand, until the END OF THE CLIPBOARD DATA (so a new rows could be added).
  - If you want to add the clipboard data as a new rows - use the option "Paste as new ..." described below
  - When the clipboard contains only "one column" of data (rows in the clipboard are separated by CRLF characters and columns are separated by TAB character) - set focus to this column in which you want to insert data. The data from the clipboard will be inserted always from the row on which you stand, until the END OF YOUR TABLE (or to the end of the clipboard data).
  - In contrast to standard editing, the pasting from the clipboard does not check the data in any way. The check is carried out subsequently, on completion of work with the editor (closing the page).
- Paste as new ... - this option inserts the data from the clipboard as a new rows and it is available only on the first column of the table. The new rows are inserted as a "text popups" or as a topics, depending on a character of inserted data (if the first column of data has a filename character, the topic is inserted).
- Assign IDs to selected - this option is a variant of the action "Assign identifiers". It assigns identifiers for selected rows only.
- Go to ... - go to the selected topic at the content, index, or included files
- Duplicit item ... - if duplicities exist for the selected item, use this option for navigation to them
- API Tester - opens the API Tester tool (to quickly verify the definition of context help identifiers)
- Inspector - shows the Object Inspector, where the topic preview or text popup preview is displayed

Used terminology

- context identifier - integer identifier (also known as "MAP ID" or "HelpContext") that is used to link the application and the help. Help for the topic (with context identifier assigned) can be displayed directly from your application (your development tool must support the help and application linking - see also API Tester).
- symbolic identifier - symbolic name (an alfanumeric identifier also known as "ALIAS ID") that is used as an interface between the context identifier and the topic if necessary (ie. when the topic file has the spaces in his name, etc.)
- source file - this means the physical storage of context or symbolic identifier. Identifiers can be stored directly in the project file, or in the separate so-called "header" files (see also Options - External tools - MS Html Help).
- text popup - text popups are short descriptions, that are displayed to the end user when he hover the mouse over some application element. These items of context-sensitive help are always stored separately from project file, so they always have assigned the source files (resp. at least the symbolic ID source file).

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