User Guide Cancel

Managing references in Adobe RoboHelp project

Search
Robohelp

Robohelp

Open app
  1. RoboHelp User Guide
  2. Introduction
    1. Get to know RoboHelp workspace
    2. What's new in RoboHelp 2022 release
      1. What's new in Update 5
      2. What's new in Update 4
      3. What's new in Update 3
      4. What's new in Update 2
      5. What's new in Update 1
    3. Fixed Issues in RoboHelp
    4. RoboHelp System Requirements
    5. Download RoboHelp on Windows and macOS
    6. Download and install Adobe app
    7. RoboHelp FAQs
    8. What's new in RoboHelp 2020 release
      1. What's new in Update 8
      2. What's new in Update 7
      3. What's new in Update 6
      4. What's new in Update 5
      5. What's new in Update 4
      6. What's new in Update 3
      7. What's new in Update 2
      8. What's new in Update 1
  3. Projects
    1. Plan your RoboHelp project
    2. Create a project
    3. Manage projects
    4. Work with topics and folders
    5. Generate reports
    6. Work with context-sensitive help
    7. Manage References
    8. Set preferences in RoboHelp
  4. Collaborate with authors
    1. Collaborate using Git
    2. Collaborate using SharePoint Online
    3. Collaborate using Azure DevOps (Team Foundation Server)
  5. PDF Layout
    1. PDF templates
    2. Design a page layout
    3. Publish PDF output
    4. Work with the common content styles
    5. Components of a PDF template
    6. Support for language variables
    7. Customize PDFs
  6. Editing and formatting
    1. Format your content
    2. Create and manage cross-references
    3. Create and manage links
    4. Single-source with snippets
    5. Work with images and multimedia
    6. Create and use variables for easy updates
    7. Work with Variable Sets
    8. Use Find and Replace
    9. Auto save your content
    10. Side-by-side editing in Split View
    11. Use the Spell Check feature
    12. Create and Edit Bookmarks
    13. Insert and update fields
    14. Switch between multiple views
    15. Autonumbering in CSS
  7. Import and linking
    1. Import Markdown files into a project
    2. Import Word documents into a project
    3. Import FrameMaker documents into a project
  8. TOCs, indexes, glossaries, and citations
    1. Create and manage a Table of Contents
    2. Create and manage an index
    3. Create and manage a glossary
    4. Create and manage citations
    5. Create and manage browse sequences
    6. Work with See Also and Related Topics
  9. Conditional content
    1. What is conditional content
    2. Create and apply condition tags
    3. Configure output presets for conditional content
    4. Optimize and manage conditional content
  10. Microcontent
    1. Microcontent
  11. Review and Collaboration
    1. Review and Collaboration
  12. Translation
    1. Translating content to multiple languages
    2. Configure a translation framework for a service provider
  13. Generating output
    1. Generate output
    2. Generate Frameless output
    3. Generate Knowledge Base output
    4. Generate PDF output
    5. Generate Responsive HTML5 output
    6. Generate Word Document output
    7. Generate Content Only output
    8. Generate eBook output
    9. Generate Microsoft HTML Help output
    10. Generate Mobile App output
  14. Publish output
    1. Publish to a RoboHelp Server
    2. Publish to an FTP server, a Secure FTP server, or a File System
    3. Publish to SharePoint Online
    4. Publish to Zendesk Help Center
    5. Publish to Salesforce Knowledge Base
    6. Publish to ServiceNow Knowledge Base
    7. Publish to Zoho Knowledge Base
    8. Publish to Adobe Experience Manager
    9. Publish to Atlassian Confluence Knowledge Base
  15. Appendix
    1. Adobe RoboHelp Scripting Reference
    2. RoboHelp keyboard shortcuts

Learn how to view the incoming and outgoing links in each topic.

The Topic References report provides a detailed summary of all references in your topic or project. References such as Topic, Title, Folder, Outgoing Links, and Incoming Links are included in the report . In addition, you can customize the fields and download it for future access.

Open a report

To open the References report, do the following:

  1. In an open project, click Reports  on the Author toolbar.

  2. In the Reports panel, double-click the Topic References tab to open the report. Alternatively, click Options  next to the Topic References tab and choose Open. 

Customize a report

You can customize the Topic References report using the Filters panel on the right side of the screen. In this panel, you can view the  report in different formats, filter information, use browse sequence, and various columns. To customize your report for Table or Graph view, use the following options in the Filters panel:

Table view

When you view the report in Table, RoboHelp displays data in rows and columns, as in a spreadsheet. 

TYPE

Under Type, you can view the type of report that is open. For example, Topic References.

VIEW

By default, the Topic References report is shown as Table. Use the options under View to change the appearance of the report.

FILTER

Under Filter, use the drop-down list of various project components to include information in your report. You can also select multiple options in the drop-down list.

COLUMNS

Following are the types of information that can be included in your report.

  • Topic Displays the name of the topic with a link. You can navigate to the target topic by clicking on the link.
  • Title Displays the title of the topic.
  • Folder Displays the location of the topic.
  • Outgoing Links Lists all the occurrences of outgoing links that are referenced from the topic. Outgoing links are meant to drive the users to additional sources of information on a specific topic. 
  • Incoming Links Lists all the occurrences of  incoming links that are referenced to the topic. Incoming links are links from other topics that, when clicked, reach to the current topic. 

Select a column to view it and deselect to remove it from the report. To sort the data in each column, click the column header. 

Graph view

When you view records in Graph, RoboHelp displays the data in graphical format. 

TYPE

Under Type, you can view the type of report that is open. For example, Topic References.

VIEW

By default, the Topic References report is shown as Table. Use the options under View to change the appearance of the report to Graph.

FILTER

Browse Sequence Use browse sequences to provide sequence of topics to the users to navigate to the previous or the next topic. You can select a particular browse sequence to see the references of the topics in the chosen sequence by using left and right arrows at the right side of the screen.

TOPIC

Use the search using the search box to look out for any other topic.

View a report

You can view a report in Table and Graph formats. The display type you select determines how the report looks and the extent to which the report can be formatted. 

The following examples show the same report run in different view options.

Table view

Select View from the Filters panel, then select Table to display the report in Table view.

The report is displayed in a table format. 

Table view
An illustration of how the Reference report looks in Table view

The Topic is displayed at the left, Outgoing Links at the center, and Incoming links at the right side of your screen.

Graph view

Select View from the Filters panel, then select Graph to display the report in Graph view.

The report is displayed in a graphical format. 

Graph view
An illustration of how the References report looks in Graph view

The Incoming links are displayed in green at the left, Topic in blue at the center, and Outgoing links in orange at the right side of your screen.

A broken reference in the report is indicated with red color alerting you about the broken link. 

To fix, select the link that contains the broken link. The Fix Broken Links dialog box opens that displays the list of broken link and its location. You can point the broken link to the correct topic and update the link as appropriate.

Broken link

Delete references

While deleting any topic you can delete all its references, too by following the below steps:

  1. From the Reports panel, right-click a topic and click Delete.

  2. The Confirm dialog box opens, showing the list of files where this topic is referred from. Click the checkbox to confirm deletion of all the references from the files.  

    Delete reference

  3. Click Yes to confirm the deletion. The topic, along with its references, is deleted.

Note:

Choosing NOT to delete the references forces the links to display as Broken Links.

Get help faster and easier

New user?

Quick links

View all your plans Manage your plans
View quick links
Hide quick links

Legal Notices    |    Online Privacy Policy