You are here: Features > WebHelp > Overview - Connecting WebHelp to Applications

Overview—Connecting WebHelp to an Application

You can work with your developer to "connect" a WebHelp system to a software application. The application can be connected to the basic Help output, to specific topics in the Help (context-sensitive Help), or both.

Basic Help The developer can connect the application to your basic WebHelp output, rather than to a specific topic. The Help will open in the browser window, displaying the startup topic that you designate and the navigation elements that you include.
Context-sensitive Help (CSH) The developer can use CSH to connect the application to specific topics in the WebHelp output (as long as you have created CSH in your Flare project and share the header file information with the developer).

In addition, there is flexibility in the way that specific WebHelp content can be connected to the application, including the following:

ID This is the CSH identifier that you create in Flare. This can be either the identifier name or value. The topic and skin that is associated with the ID will be used. If no skin is associated with the ID in Flare, the skin name that you provide in this command will be used. Alternatively, the ID may contain a topic path. In this case, the specified topic will be loaded with the skin that is specified in this command. You also have the option of entering "null" instead of an ID to use the Help system's default starting topic.
SkinName This is the name of the skin to use when opening the Help system. If a skin has been assigned to the ID in Flare AND you enter a skin name in this command, the skin name in the command will take precedence. You also have the option of entering "null" instead of a skin name if you want to use the Help system's default skin or to use the skin that is associated with the CSH ID in Flare.
SearchString This is an optional element that automatically performs a search for a specific string.
FirstPick This element can be used in conjunction with the "SearchString." If you use the "FirstPick" option, you can include a "true" or "false" value. If the value is "true," the first topic found with the specified search string will be opened automatically. If the value is "false," the search results will simply be displayed; the first topic will not be opened automatically.

What you need to do

Work with your developer to determine how you want to connect the Help to the application.
Create and build your WebHelp project in Flare.
Provide the developer with the output files, as well as the CSH header file (if you plan to use CSH).
Provide the developer with the information in the following topic: Connecting WebHelp—Developers.