This tool generates detailed reports on your project that can be used for a wide range of purposes, including documentation, providing your programmers with lists of topic IDs for their help calls, checking project status, locating dead links, finding missing images and unused images and so on. Reports are displayed immediately in a special viewer but you can also save them in HTML files for documentation and other purposes.
See the report dialog reference for details on the dialog options and the available report types.
1.Select Report Tool in
2.Select the report type in the tabs on the left.
3.Select the other options to change the sort order of your report and which topics you wish to include or exclude (see the dialog reference for details).
4.Click on OK to display the report in your default browser. |
The option includes word and character counts for each topic listed and also a cumulative count for all the topics in the report.
Word counts for individual topic classes, builds etc.
You can use the selection options in the Report tool to get word counts for any customized group of topics. For example, you can use the date range option to get a count for all the topics modified between specified dates. Similarly, you can get counts for topics with specific build options, classes or status, or any combination of these filters.
Word counts for selected topics
You can also get a cumulative word count for selected topics in the TOC. Just select the topics before opening the Report tool, with Ctrl+Click and Shift+Click. Then start the Report tool, select the Selected Topics option in the Include Options box on the right and generate a Full Report.
Selected chapters always include all the sub-topics of the chapters!
|
Help+Manual can help you to locate unused graphics files in your project and remove them so that they no longer take up space.
1.Select the Project Report tool and choose the Full Report option.
2.Set the Sort Order option to Topic ID. This is important to ensure that all topics will be covered by the report, including those that do not have TOC entries.
3.Run the report and scroll down to the bottom of the page. Each folder where unused images are found has a button with which you can move the images to a backup folder for storage or deletion.
|
|
|
Simple list of all topics in your project with status, caption (i.e. the TOC title), topic IDs, help context numbers, builds in which the topics are included and date last edited. The report also includes a summary of the number of topics and keywords in your project.
This is a practical format for providing your programmers with a list of topic IDs and context numbers for their calls.
Use Topic ID sort order to include all topics!
Use the Topic ID sort order with this report if you want to ensure that all topics are covered by the report, including those that do not have TOC entries.
|
|
|
Also includes each topic's keywords and help window and a more detailed project summary with a list of the images used in the project.
Missing images are shown in red.
Use Topic ID sort order to include all topics!
Use the Topic ID sort order with this report if you want to ensure that all topics are covered by the report, including those that do not have TOC entries.
|
|
|
Also includes lists of the images used in each topic, lists of the links in each topic with their targets (including topic links, Internet links, file links and script links) and the first lines of the text with which the topic begins.
Missing images and dead links are shown in red.
Use Topic ID sort order to include all topics!
Use the Topic ID sort order with this report if you want to ensure that all topics are covered by the report, including those that do not have TOC entries.
|
|
|
Same as the Long Report but also includes an additional full list of images used in the project with a lists of the topics in which each image is used. In addition to this there is also a list of images in the project's graphics folders that are not used in the project (useful for tidying up your project folders).
This report also includes word and character counts of each individual topic and all the topics in the report. See further above on this page for more details on word counts.
Locating and removing unused images
Unused images are listed at the end of the report with controls for moving them to a backup folder for saving or deletion.
Use Topic ID sort order!
Always use the Topic ID sort order with this report to ensure that all topics are covered by the report, including those that do not have TOC entries.
|
|
|
Displays all topics which do not contain any index keywords. This can be useful when you are building an index, as it shows you where you may have forgotten to enter keywords.
Use Topic ID sort order!
Always use the Topic ID sort order with this report to ensure that all topics are covered by the report, including those that do not have TOC entries.
|
|
|
Displays all topic files that do not have TOC entries.
Caution: If you use TOC sort order with this option you will get an empty report!
|
See also:
Reports (dialog reference)
