Creating Links to WebHelp and WebHelp Plus Topics

Important WebHelp and WebHelp Plus are deprecated in Flare, which means that they are slated to be removed in a future version.

You can create links to specific topics in WebHelp and WebHelp Plus output. You can also create links that incorporate search strings and skin references.

How to Create Links to WebHelp and WebHelp Plus Topics

  1. Perform the steps for creating one of the following kinds of links:
  2. In the dialog that opens for creating the link, click the Link to field and select Website.
  3. Enter the path to the website. You can also include a specific topic, a search string, and/or skin. When inserting the link, you can use the following structure.

    Copy
    http://[website]/[main entry file]_CSH.htm?[search string]|FirstPick#[path/name of topic]|[skin name]
    • Main entry file_CSH.htm This is the main entry file for your output. The file name is determined by whatever you enter into the Output File field in the General tab of the Target Editor. If you do not provide a name in this field, the name "Default" will be used. After the file name, it is important that you add an underscore followed by "CSH."

      Note You do not need to include the "_CSH" portion in the file name of the topic in Flare. You only need to add " _CSH" to the web page hyperlink connecting to that topic.

    • Search string This is an optional element that automatically performs a search for a specific string.
    • First pick This element can be used in conjunction with the search string. If you include the first pick option, the first topic found with the specified search string will be opened automatically. If you do not include this element, the search results will simply be displayed; the first topic will not be opened automatically.
    • Skin name You can specify a skin directly in the link, which will override the skin associated with that topic in the CSH alias file.

In the following examples, these values are used:

  • Default.htm = main entry file name
  • Soccer.htm = topic in the project, located in subfolder called "Sports"
  • World Cup Standings = search term
  • Green = skin name
Copy
<a href="http://my.mycompany.com/Default_CSH.htm#Sports/Soccer.htm|Green">Click here to open</a>
Copy
<a href="http://my.mycompany.com/Default_CSH.htm?World Cup Standings|FirstPick">Click here to open</a>

Note You can complete similar URL link steps with context-sensitive Help (CSH) identifiers. See CSH Calls for WebHelp and WebHelp Plus.