Learn the basics of linking in a project and develop navigation in a Help system.

Links facilitate quick navigation from one content element to another with a simple click. While authoring in RoboHelp, you can add links to text or images and direct them to a project file, a file on your computer, webpage, or an email.

The following types of links are available in RoboHelp to help build navigation in your output:

  • Hypertext link Highlights the link in your text and opens the destination when you click it.
  • Image links A link in an image that leads you to the destination or opens a pop-up when you click the image.
  • Bookmarks A link that takes you to a specific location in a topic. 
  • Browse sequence The series of topics viewed in your output. For more information, see create and manage browse sequences.
  • Searches The topics that contain search keywords appear as links in the search results.

To create a link on text or an image, follow these steps:

  1. In an open project, select the text or image on which you want to create the link.

  2. In the standard toolbar, click the Insert Link icon .

  3. In the Link To dialog box, the Display Text field displays the selected text to which you want to insert the link. If you selected an image, this field remains blank.

    You can select the type of link that you want to insert from the following options:

    • Project Files Select this option to link to a topic within the project. Use the Search bar to search for a topic. You can also use the Recently Used panel or Contents panel to select a topic of your choice.
    • Local Files Select this option to link to a file on your computer. Click  to browse and select a .htm or .html file. You can then preview the selected file in the Link To dialog box.
    • Webpage Select this option to link to a webpage. In the Enter or paste URL field, specify the URL of the webpage that you want to link to.
    • Email Select this option to link to an email that the user can send. You can specify the email address to whom you want the user to send to, in the Address field. Optionally, you can enter the subject and body of the mail in Subject and Body, respectively. In the output, when a user clicks this link, the draft email opens in the default mail client. The user can further edit the mail before sending it.
    To link to a project file, use the Search bar or the Recently Used panel to view a topic. You can also browse your topic in the Contents panel below the Recently Used panel.
  4. Click Link.

    You can preview the inserted link when you click Preview  in the standard toolbar.


    Alternatively, you can do the following to link to a project file (topic):

    Select the text or an image in an open topic to which you want to insert the link. From the Contents panel of the authoring window, drag-and-drop a topic of your choice on the selected text or image. The destination topic is then inserted as a link. In the Preview mode or output, click the link to view the destination topic in a pop-up window.

To fix a broken link, you can replace it, that is, point it to another file (topic/image) in the project. If the broken link points to a topic file, you can replace it or create a new topic. If you create a new topic, RoboHelp automatically points the broken link to the new topic. You can fix a broken link in two ways–through the Fix Broken Links dialog box or the Broken Links report.

To fix a broken link:

  1. Do one of the following to launch the Fix Broken Links dialog box:

    The Fix Broken Links dialog box opens.

  2. In the Broken Links section, click the broken link that you want to fix.

    The Used In section displays the corresponding topic in which the broken link exists. 

    You can now do one of the following:

    • Point the broken link to an existing file in the project (refer Step 3).
    • For a broken link pointing to a topic, you can create a new topic and point the link to the new topic (refer Step 4).
  3. To point the link to another file in the project:

    1. Click Replace


      In the Broken Links report, you can directly replace a specific broken link through the Replace Link dialog box. To launch the dialog box:

      1. In the Filters panel > Order By section, select Broken Link. RoboHelp orders information in the report by broken links.
      2. In the Broken Link column, right-click a link and click Replace Link

      The Replace Link dialog box opens. 

      In the Replace Link dialog box, RoboHelp automatically opens appropriate folders depending on the type of referenced item to which the broken link points. For example, if a broken link points to an image, RoboHelp automatically opens the assets/images folder. 

    2. Locate an alternate topic/image to which you want to point the link. To do so, use the Search field or browse through the Contents or the Recently Used drop-down section. 

    3. Select the topic/image and click Link. RoboHelp fixes the broken link and removes it from the Fix Broken Links dialog box and the Broken Links report.

  4. To fix a broken link that points to a topic by creating a new topic:

    1. Click Create New.


      The Create New button is enabled only for broken links pointing to topics.

      The New Topic dialog box opens.

    2. In the New Topic dialog box, specify the properties for the topic in different sections as required.

      The New Topic dialog box has the same sections as the Topic Properties dialog box, except for the File Info section, which is specific to topic properties. For more information, see Topic properties.

    3. Click Create.

      The topic is created inside the selected folder or a subfolder in the Contents panel. RoboHelp automatically points the broken link to the new topic.

  5. Click  to save the changes.

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy