Generate reports

Tip: You can also launch the 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, notes, 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 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 the search. 

You can use the Filters panel at the right to filter the topic list by status, author, folder, search, and notes.

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, folder, TOC, notes, 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.

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

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 images that are used in your project. You can view the topic and file type associated with each image.

The Alt Text column in the Images report enables you to view the alt text assigned to images. Additionally, you can also use the Alt Text filter in the Settings panel to filter the images based on whether their alt text is empty or non-empty. This facilitates a quick overview to verify which images have alt text and which do not, all at one glance. 

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.