See Also
There are several ways that your Flare DotNet Help system can be "connected" to a software application. Features that are available include the following:
Detached Help or integrated Help The Help system can be connected so that the Help opens in a window separate from your software application (detached Help).
example
To see an example of detached Help in Flare's online Help, select Project>Add Topic and then press F1. The topic for that dialog opens in a separate window.
Alternatively, the Help can be connected so that the Help opens within the software application (integrated Help).
example
To see an example of integrated Help in Flare's online Help, select Help>Contents. The TOC for the Help opens within the application. If you click a topic page in the TOC, the topic opens in the application to the right.
Same process or different process The Help system can be connected so that it uses the same process as the software application (embedded). If the Help uses the same process, the Help will close when the application is closed. The online Help in Flare is connected so that it uses the same process as Flare.
Alternatively, the Help system can be connected so that it uses a different process than the software application. If the Help uses a different process, the Help can remain open even if the application is closed.
Basic Help or context-sensitive Help (CSH) The developer can connect the application to your basic DotNet Help output, rather than to a specific topic. For example, you might want a standalone version of the Help Viewer to open separately from the software application, displaying your startup topic and showing panes for the navigation elements (e.g., TOC, Index, Search, Browse Sequences) that you have created. Or maybe you want users to be able to open the different navigation elements within the application and access topics from each one.
example
To see an example of this in Flare's online Help, select Help>Contents. The TOC for the Help opens within the application. If you click a topic page in the TOC, the topic opens in the application to the right.
Alternatively, the developer can use CSH to connect the application to specific topics in the DotNet Help output (as long as you have created CSH in your Flare project and share the header file information with the developer).
example
To see an example of CSH in Flare's online Help, select Project>Add Topic and then press F1. The topic for that specific dialog opens.
Dynamic Help The developer can also incorporate your Help into the application using a unique feature called "Dynamic Help." This is a type of CSH where a Help window automatically displays topics from a Help system as an individual uses the application. It does not require any other action from the user (e.g., clicking a button or pressing a shortcut key). The Help system simply follows the actions of the user, automatically providing the appropriate Help content based on the area of the interface that is being clicked.
example
To see an example of Dynamic Help in in Flare's online Help, select Help>Dynamic Help. Then start clicking anywhere in the Flare interface. As you do so, the Help topic changes accordingly.
F1 Help The developer can connect the application to the Help in such a way that the Help opens when a user presses the F1 key.
example
To see an example of this in Flare's online Help, simply click in any area of the interface or open any dialog. Then press F1. The appropriate Help topic for that area of the interface displays.
Dialog's Help button The developer can connect the application to the Help in such a way that the Help opens when a user clicks the dialog's Help button (i.e., the "question mark" button).
example
To see an example of this in Flare's online Help, select Project>Add Topic. Then click the ? button in the upper-right corner of the dialog.