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 Project > Tools.
2.Select the report type in the Report Type: field. 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. |
Short report: |
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. |
Extended report: |
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. |
Long report: |
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. |
Full report including image references: |
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). Missing images and dead links are shown in red. Unused images are listed at the end of the report. |
Missing keywords: |
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. |
Files not in TOC: |
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)