Learn how to open, print, 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 print a report or download it as a .csv file.

Types of reports

You can generate the following types of reports in RoboHelp:

Topic List

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.

Project Status

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.

Topic Properties

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.

Topic References

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.

External references

In the External References report, you can view the links that are referred to resources outside your project. This way you can test the links in topics that lead to external content.

Search Keywords

The Search Keywords report lists the keyword tags applied in each topic.

Table of Contents

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.

Index

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.

Glossary

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.

Condition Tags

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.

Variables

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.

Snippets

The Snippets report lists the snippets defined in your project. You can view the topic and the file type each snippet is used in.

Images

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.

Multimedia

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.

Stylesheets

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.

Broken Links

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.

Unused Files

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 it is in.

Unreferenced Topics

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.

Open a report

To open or generate a report in RoboHelp, follow these steps:

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

  2. 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.

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:

Type

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.

Order By

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.

View

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.

Filter

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.

Columns

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.

Download a report

To download a report with the applied settings in RoboHelp, follow these steps:

  1. Click Reports  on the Author toolbar.

  2. 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.

  3. To customize your report, use the Filters panel on the right side of the screen. For details, see Customize a report.

  4. To download your report, click Download  on the toolbar. You can also click Options  next to the desired report type and choose Download.

    The report is then saved as a .csv file.

Print a report

To print a report with the applied settings in RoboHelp, follow these steps:

  1. Click Reports  on the Author toolbar.

  2. 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.

  3. To customize your report, use the Filters panel on the right side of the screen. For details, see Customize a report.

  4. To print your report, click the Print icon  on the toolbar. You can also click Options  next to the desired report type and choose Print.

Цей документ захищено ліцензією Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Публікації Twitter™ і Facebook не підпадають під умови ліцензії Creative Commons.

Юридична інформація   |   Політика мережевої конфіденційності