Open topic with navigation

Inserting Text Hyperlinks into Topics

A text hyperlink is one of the most basic forms of a navigation link. It is simply a hyperlink applied to text. When an end user clicks the hyperlink in the output, the location specified in the hyperlink opens. The location can be another topic in the project (including a bookmark within that topic) or a file outside of the project (such as a website on the Internet).

How to insert a text hyperlink into a topic

1. Open the topic.
2. Do one of the following:
   • In the XML Editor, highlight the text that you want to use as the link (or "hotspot"). Continue with the next step.
     
     OR
   • Make sure the Content Explorer is open. Click and drag the topic to which you want to link from the Content Explorer to the appropriate location in the topic. Skip to Step 4.

3. Select Insert>Hyperlink or click in the local toolbar.

   The Insert Hyperlink dialog opens.

4. In the Link to area, select a way to identify the topic, bookmark, or file to which you want to link. Based on the option you choose, the section to the right gives you a list of selections or additional fields to complete.

   • Place in this Document This option displays any headings and bookmarks in the current topic. After you click this option, use the section to the right to choose the topic or bookmark to which you want to link.

   • Document Currently Open This option displays all other topics that are currently open in your project. After you click this option, use the section to the right to choose the topic file to which you want to link. You can also click the Bookmark button to display and select any bookmarks within the destination topic.

   • File in Current Folder This option displays all other topics that are located in the same folder in the Content Explorer. You might have topics in various folders if you have previously organized your topics. After you click this option, use the section to the right to choose the topic file to which you want to link. You can also click the Bookmark button to display and select any bookmarks within the destination topic.

   • Recent File This option displays the most recent topics that have been opened in your project. After you click this option, use the section to the right to choose the topic file to which you want to link. You can also click the Bookmark button to display and select any bookmarks within the destination topic.

   • Topic in Project This option lets you search for a topic within your project. After you select this option, click the Topic button. In the Open File dialog, navigate to the file that you want to link to, select it, and click Open. You can also click the Bookmark button to display and select any bookmarks within the destination topic.

   • External Topic This option lets you search for a file (e.g., HTM, HTML, XML, PDF, Microsoft Office files) outside your project. This is especially useful if you want to link from one topic to another in separate project outputs, such as CHM files. After you select this option, enter the path to the file in the field next to the External Topic button.

     For more information, see Inserting Links to External Files.

     Note: Because the link usually needs to be relative, based on the final locations of your output files, it is preferable to enter the text directly into the field, rather than clicking the External Topic button.

   • Website This option lets you enter the path to an external file, such as the URL for a website. After you click this option, simply type the path in the field next to the Website field (e.g., http://www.acme.com).

   • Email This option lets you add an email address and subject line so that the user can quickly send an email.

     example

     You might use this feature to help the end user send an email to your company's technical support department. When users click the link, it opens their email program and begins a new email message for them, inserting the email address and subject line for them. After you click this option, complete the E-mail address and Subject fields to the right (or select a recent email address from the list below).

5. (Optional) The Link text field displays the text that you highlighted in the topic, which will be used as the hyperlink. Leave the text as it is, unless you decide you would like to change it. If you want to change the link text, type the new text in the field. It will replace the previously selected text in the topic.
6. (Optional) In the Target Frame field, click the drop-down arrow to select the way the linked destination will open (e.g., in another window, in a popup).
   • Page Default The destination file will open in the same window as the output window.
   • Parent Frame The destination file will open in the parent frame of the current topic while hiding that topic.
   • New Window The destination file will open in a new browser window.
   • Same Frame The destination file will open in the same window frame as the current topic.
   • Top Frame The destination file will open in the same output window, removing all other framesets. You might use this option, for example, if the destination topic has its own frameset.
   • Popup Window The destination file will open in a popup box on top of the current topic.
7. (Optional) In the Screen Tip field, you can type a phrase that will appear when the end user hovers over the hyperlink in the output.
8. (Optional) Next to the Style Class field, click the Select button. This opens the Select Class dialog, which lets you apply one of the defined hyperlink styles from your style sheet to the link. You can change the appearance of the link by modifying the style in the Stylesheet Editor. After you select a style class in the dialog, click OK. The Style Class field displays the selected style. (If you do not specify a style class, Flare uses the parent <a> tag.)

9. Click OK.

   The hyperlink is added to the topic.

10. Press CTRL+S or click to save your work.

See Also

Open topic with navigation