In an open project, click Reports on the Author toolbar.
- RoboHelp User Guide
- What's New in Adobe RoboHelp?
- What's new in RoboHelp (2020 Release) Update 8
- What's new in RoboHelp (2020 Release) Update 7
- What's new in RoboHelp (2020 Release) Update 6
- What's new in RoboHelp (2020 Release) Update 5
- What's new in RoboHelp (2020 Release) Update 4
- RoboHelp system requirements
- RoboHelp FAQs
- Download and install your Adobe app
- Download RoboHelp on Windows and macOS
- Get to know the RoboHelp workspace
- Fixed issues in RoboHelp
- Collaborate with authors
- PDF Layout
- Editing and formatting
- Format your content
- Create and manage cross-references
- Create and manage links
- Single-source with snippets
- Work with images and multimedia
- Create and use variables for easy updates
- Work with Variable Sets
- Use Find and Replace
- Auto save your content
- Side-by-side editing in Split View
- Use the Spell Check feature
- Create and Edit Bookmarks
- Insert and update fields
- Switch between multiple views
- Autonumbering in CSS
- Import and linking
- TOCs, indexes, and glossaries
- Conditional content
- Review and Collaboration
- Generating output
- Publish output
Learn how to open, customize, and download different types of reports in RoboHelp and manage your project better.
In Adobe RoboHelp, you can generate a variety of reports to monitor, compare, and optimize the content of your project. You can customize your report and display the desired columns, reorder information, and filter project components. You can then quickly download a report as a .csv file.
Reports in RoboHelp
You can generate the following types of reports in RoboHelp:
Tip: You can also launch topic list by choosing View > Topic List.
The Topic List report displays the list of topics in a project. For each topic, you can view the filename, title, status, author, and the Table of Contents it belongs to. You can view the folder containing the topic, the condition tags applied to a topic and its content, the style sheets and master pages used in a topic, the See Also component if added to a topic, and the last modified date and time. You can also view if a topic has index keywords associated with it and if the topic is included in search.
You can use the Filters panel at the right to filter the topic list by status, author, folder, and search.
For individual topics or multiple selected topics, you can use the context menu to edit (click Edit) and delete topics (click Delete), and configure topic properties (click Properties). The Properties panel shows the number of topics present in the topic list; you can use this information while filtering specific topics. You can also create a duplicate of an individual topic (click Duplicate) and locate a topic in a specific Table of Contents (click Locate in TOC).
You can also drag-and-drop topics from the topic list to a Table of Contents and an index. You can resize columns in the topic list report. If you make changes in a topic or add/delete a topic, RoboHelp automatically updates the topic list report to reflect the changes.
The Project Status report allows you to view the status of each topic in your project. This way you can generate information on the total number of topics completed, in progress, and ready for review.
The Topic Properties report allows you to view the various topic properties associated to each topic in your project. You can view a topic's status, author, condition tags, style sheet, Table of Contents, index keywords, and search keywords associated with it.
In the Topic References report, you can view the incoming links in each topic. This way you can view the references that are leading to a topic.
In the External References report, you can now find in how many topics the link has been referred to and vice-versa the number of external links available in a topic.
You also have an option to order the reports based on either Link (default) or Topic, allowing you to quickly find a particular report in a more quicker way. However, you can sort the columns by clicking on the column header.
The Search Keywords report lists the keyword tags applied in each topic.
The Broken Links report lists the topics that contain broken links, that is, links to objects (topics/images) that have been moved, renamed, or removed. You can view the topic, the folder in which the topic exists, broken link path, and type of object for each broken link in your project. You can also fix broken links.
In a multi-author and version-controlled environment, ensure that you don’t link to topics that have been moved, renamed, or removed as these links are broken.
The Unused Files report lists the various files that are not used in your project. For each unused file, you can view its file name and the folder.
If you want to remove any unused file(s) from your project, right-click the file from the list and press the Delete button. You can also use the individual or multiple checkboxes to select the files you would like to delete.
The Unreferenced Topics report lists the topics in your project that are not linked to in the Table of Contents, index, browse sequences, or in other topics. You can use this report to identify:
- Inaccessible topics that are not linked from other topics
- Topics excluded from the Table of Contents
- Topics without index
Few topics do not use references such as context‐sensitive Help topics. For example, if you create window‐level context‐sensitive Help, topics are accessible only when you press F1 or click Help. In this case, you don't require references.
The Table of Contents report lists the details of the selected Table of Contents in your project. You can view the links in the topics, the title and file type such as book or page, and if it is hidden or not in the Table of Contents output.
The Index report lists all the index keyword tags applied across topics in your project. You can view the keywords and the topics that contain them.
The Glossary report lists the terms and their definitions in the selected glossary. You can also view the topics that the terms are added in and the file types.
The Condition Tags report lists the condition tags in your project with the tag name and color. For each tag, you can view the group of condition tag, the topic, and file type that the condition tag is applied in.
The Variables report lists variables in your project with their values. For each variable and its value, you can view the topic and file type that the variable is used in. This way you can find variables that are used in a topic or those that are not used in any topic. Before you delete a variable, you can locate the topics in which the variable is used and delete references to that variable.
The Snippets report lists the snippets defined in your project. You can view the topic and the file type each snippet is used in.
The Images report lists the image file names that are used in your project. For each image file name, you can view the topic and the file type that it is in.
The Multimedia report lists the multimedia file names in your project. For each multimedia file name, you can view the topic and the file type it is in.
Use the Stylesheets report to view the list of style sheets in your project. For each style sheet, you can view the topic and the file type it is in.
Use the See Also report to view information such as the list of See Also keywords (terms) in your project, the main topics that use each term, title of the main topics, and the folder in which the main topic exists. You can also filter the report according to folders.
For information about See Also keywords, see Work with See Also and Related Topics.
Use the Map ID report to view the information related to the map IDs used in your project. You can view the map number, map ID, map filename, topics in the map file, topic title, and the folder in which the topic exists.
Open a report
To open or generate a report in RoboHelp, follow these steps:
In the Reports panel, double-click the report that you want to generate. Alternatively, click Options next to the desired report type and choose Open. To know more about the various reports in RoboHelp, see Types of reports.Note:
To view the latest report after you've edited your project, click the Refresh icon on the toolbar.
Customize a report
You can customize a report using the Filters panel on the right side of the screen. In this panel, you can view the type of report, select a criteria to order information, filter information, and select the columns to view in the report. To customize your report, use the following options in the Filters panel:
Under Type, you can view the type of report that is open. To know more about the types of reports in RoboHelp, see Types of reports.
You can select a criteria to order the information in your report using the options under Order By. Based on the type of report, you can find different options such as Status, Keyword, Topic, and more.
By default, a report is viewed as a table. Reports such as Topic References and Project Status can also be viewed as a graph and pie chart, respectively. Use the options under View to change the appearance of the report.
Under Filter, use the drop-down lists of various project components to specify information in the report. You can also select multiple options in each drop-down list.
For Index, Glossary, Condition Tags, Variables, Snippets, Images, Multimedia, and Stylesheets reports, you can also select Used in <project component> to view the files that the project component is applied in.
RoboHelp remembers all filtering and column selections for all reports across sessions.
You can add or remove columns in your report using the options in Columns. These columns are based on the type of report that you have selected. Select a column to view it and deselect it to remove it in the report. To sort the data in each column in all reports, click the column header.
Download a report
To download a report with the applied settings in RoboHelp, follow these steps:
Click Reports on the Author toolbar.
In the Reports panel, double-click the type of report you want to generate and open it. Alternatively, click Options next to the desired report type and choose Open.
To download your report, click Download on the toolbar.
The report is then saved as a .csv file.