### Topic (the page)

The page with a topic is displayed always, when you edit the item of contents or the keyword.

The table of contents navigation panel (resp. 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 help contents (or the index of keywords).

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

Information:
Unless otherwise specified, the following described actions and options are available as when editing the content item, so when editing the keyword in the index.

Preview and Source

At the bottom of the topic page you can find two tabs - Preview and Source. With the help of them you can switch between the topic preview and the built-in editor of its source code. Switching can also be done by using the keyboard shortcut F12. This shortcut switches also into the TOC tree (or Index tree), that allows an easier navigation between these three elements of the user interface, using the keyboard. If you want to switch only between the preview and the source code, use Shift+F12 shortcut.

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)
- 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.

Saving the topic as a template

- 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.

Selecting a topic - content editing options

- Include another contents - merges the current structure with an external table of contents. You can choose another contents file (.hhc), or the link to the table of contents, that is a part of the external help file.
- Clear (make heading) - cleans the topic link, so the item becomes a heading

Selecting a topic - index editing options

- 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.

Topic editor (embedded)

Editor offers regularly used options such as

- Search and replace text
- Syntax highlighting - currently used syntax highlighting scheme can be change in Options dialog. The scheme itself is defined inside a special configuration file. You can create your own, customized configuration files for syntax highlighting, code completion and keyboard shortcuts.
- Code completion window - it is displayed automatically or by the Ctrl+Space hot-key. The completion items are defined inside the current syntax highlighting scheme configuration file.
- Special keyboard shortcuts - they allows you to insert the text and code snippets by pressing some of the predefined hot-keys. For example, Ctrl+B inserts or applies the bold tag to the selected text, Alt+End ends the current tag, etc. The shortcuts are defined inside the current syntax highlighting scheme configuration file.
- Application extensions (add-ons) - ie. "Insert current date", HTML Tidy, etc. Add-ons are available through the editor context menu, as well as via the code completion window.

Other features can be found in the editor's context menu.

More topic editing options

- Inspector - shows the Object Inspector, where you can edit properties of current topic as well as the properties of whole table of contents (resp. index of keywords)
- 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).
- Keywords - panel in the Object Inspector tab, that is used for quick assignment of keywords. You can simply check the keyword to assign it to a topic, or you can add a new keywords via the panel popup menu.
- Tip:
  When you select a text anywhere in displayed topic, and then you select the option Add key in the "Keywords panel", the selected text will be added as a new keyword.
- 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 table of contents with currenlty displayed topic

Topic properties in Object Inspector (editing the contents)

- Label - label of the content item
- Icon - the content item icon
- Icon as new - the "new flag" for an icon (a small star image will be displayed in the icon)
- Merged contents - link to merged table of contents (see Include another contents)

Topic properties in Object Inspector (editing the index)

- Keyword - the keyword text in the index
- Link to another keyword - the linked keyword text for items with "Is link to another keyword" flag (see above)

Other topic properties

- Context ID - integer identifiers of context-sensitive help (read-only). Click on the associated button (or double-click on the field) to navigate at this topic in the Context help editor.
- Symbolic ID - symbolic identifiers (aliases) of context-sensitive help (read-only). Click on the associated button (or double-click on the field) to navigate at this topic in the Context help editor.
- Link (topic file or url) - the filename or the url that current topic links to
- Alternate link - alternate link, that will be used in case of unavailability of the main link
- Window ID - the window type identifier, where the topic will be displayed
- Frame ID - the frame identifier, where the topic will be displayed
- Comment - author's comment about the content item (resp. the index item)
- Not implemented - section with parameters, that are listed here, because of the full support of HHP format only. Unfortunately the support for these parameters is not fully implemented even in the system CHM Help viewer.

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