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.
See the Report Tool for full details on how to generate reports.
The Project Report dialog:
Note that all options that exclude topics will reduce the accuracy of link reporting (links to topics that are not included in the report will not be checked).
|
|
How you want your topics to be sorted in the report. Note that only the Table of Contents sort option also includes chapters without text. All the other options (Topic ID, Context Number, Modification Date) only include topics that actually have contents.
 | If you sort by context number only those topics that actually have context numbers will be included in the report! |
|
|
|
If you have defined more than one TOC in your project you can select the TOC here to report on only the topics included in that TOC. See Multiple TOCs for details.
|
|
|
Only include topics edited between two specified dates.
|
|
|
Include only topics with specific topic classes in the report. Currently there are only two classes: Default for all normal topics and Popup for popup topics.
|
|
|
Include only topics with a specific editing status in the report.
|
|
|
Include topics on the basis of predefined and user-defined include options. This works in the same way as include options in conditional output.
If you have selected topics in the TOC before opening the Report Tool you can select this to report on only the selected topics. Note that selecting chapters always includes all the topics in the chapter. Use Ctrl+Click and Shift+Click to select multiple topics in the TOC.
|
|
|
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.
|
|
|
Also includes each topic's keywords and help window and a more detailed project summary at the end with a list of all the images used in the project.
Missing images are shown in red.
|
|
|
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. As in the extended report the summary includes a list of all the images used in the project
Missing images and dead links are shown in red.
|
|
|
Same as the Long Report but also includes an additional full list of images used in the project with references to the topics in which each image is used, and word and character counts for individual topics and all the topics in the report.
In addition to this there is also a list of images found in the project's image folders that are not used in the project (useful for tidying up your project folders).
Missing images and dead links are shown in red.
|
|
|
Special report that only locates topics that do not have any index keywords.
|
|
|
Special report that lists the topic files in your project that do not have TOC entries.
Caution: If you use TOC sort order with this option you will get an empty report!
|
|
|
Special report that locates topics containing text with manual formatting instead of styles. Styles are strongly recommended for efficiency and compatibility with translation tools.
|
See also:
Report Tool (Instructions)
