### Context help

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.
It is divided into three sections - Topics filter, Identifiers filter and Other options.

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.

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 editor options description is provided here.

Context help panel options

- Topics filter:
- Content topics - displays topics from table of contents
- Index topics - displays topics from index of keywords
- Files topics - displays topics from included files list
- Other topics - displays all other topics, that does not meet the previous conditions
- Text popups - displays text popups
- Identifiers filter:
- Duplicit IDs - displays only rows, that have duplicated context or symbolic identifier
- No context IDs - displays only rows without context identifier
- No symbolic IDs - displays only rows without symbolic identifier
- Comments - displays only rows with comments
- Other options:
- Mark duplicit items - a useful option, that helps with finding duplicities in the table. Cells with duplicate identifiers will be marked with a red tilde (see also "Identifiers filter - Duplicit IDs" above)
- Automatically assign IDs - if you do not want to assign identifiers automatically in the batch process (see the "Assign identifiers" below), but you would appreciate some form of automation of this activity, you can use this option. It allows to assign identifiers (and their sources) automatically only for the table row that is currently editing. So, by pressing the SPACEBAR and then the ENTER key (on any other column then the first) you can get the automatically assigned context-sensitive help definition for currently selected row.
- Show advanced columns - this is the option to setup a working mode. If it is checked, you have the full control over the definition (you see and can edit the topics, identifiers, sources and comments). If it is unchecked, you see and can edit only two of most important columns (topic and the context identifier) and the rest of the definition is generated automatically (regardless of the option "Automatically assign IDs").
- Show all items ... - this action will turn on all the filters in Topics filter and Identifiers filter sections (see above)
- Assign identifiers ... - this action will perform a batch assignment of identifiers (only cells without the definition are filled). Also when the editor page is closing, it performs some checks, so you will be informed about the bad or missing definition.

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-2010 Precision software & consulting. All rights reserved.