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 print a report or download it as a .csv file.
The Topic List report allows you to view the topics in your project. For each topic, you can view its status, author, folder, and the Table of Contents it belongs to. You can also view if a topic has index keyword tags associated with it and if the topic is included in search.
In this report, you can edit, configure topic properties, and delete a topic or multiple topics. To do this, select the desired topics. Right-click the selected topics and choose Edit to open and edit them. You can also select Properties to configure the topic properties of the selected topics or select Delete to delete the topics.
Table of Contents
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 Broken Links report lists topics that contain broken links. You can view the topic, broken link path, and link type for each broken link in your project.
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 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.
In the Reports panel, double-click the type of report that you want to generate. Alternatively, click Options next to the desired report type and choose Open. To know more about the various types of reports in RoboHelp, see Types of reports.
To view the latest report after you've edited your project, click the Refresh icon on the toolbar.
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.
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.