Reports

Doc-To-Help has several reports that will help you organize your work and keep track of topics and index elements. These reports can be viewed, saved, and printed for maximum flexibility.

Following are the available reports:

  • Help Contents Listing Displays the table of contents for the target chosen with all books expanded and all topics visible.
  • Help Index Listing Displays all the project’s index keywords and how many topics are assigned to each one.
  • Index Report by Group Displays a list of associated topics, if any. Groups are listed in alphabetical order.
  • Index Report by Keyword Shows a list of associated topics, if any. Keywords are listed by full path name in alphabetical order.
  • Index Report by Topic Shows a list of associated keywords and groups, if any. Topics are listed in alphabetical order by title.
  • Script Listings Lists the code for each script defined in the project. Scripts are listed in alphabetical order.
  • Style Definitions Lists the properties of each style defined in the project. Styles are listed in alphabetical order.
  • Topic Detail Report Lists the properties for each topic in the project. Topics are listed in alphabetical order by title, and each topic starts on a new page.
  • Unindexed Topic Report Lists each topic that is not associated with an index element (keyword or group). Topics are listed alphabetically by title, along with their document name and style from which the topic was derived.
  • Help Contents Listing Displays the table of contents for the target chosen with all books expanded and all topics visible.
  • Help Index Listing Displays all the project’s index keywords and how many topics are assigned to each one.
  • Index Report by Group For each group name in the project, this report shows a list of associated topics, if any. Groups are listed in alphabetical order.
  • Index Report by Keyword For each index keyword in the project, this report shows a list of associated topics, if any. Keywords are listed by full path name in alphabetical order.
  • Index Report by Topic For each topic in the project, this report shows a list of associated keywords and groups, if any. Topics are listed in alphabetical order by title.
  • Script Listings This report lists the code for each script defined in the project. Scripts are listed in alphabetical order.
  • Style Definitions This report lists the properties of each style defined in the project. Styles are listed in alphabetical order.
  • Topic Detail Report This report lists the properties for each topic in the project. Topics are listed in alphabetical order by title, and each topic starts on a new page.
  • Unindexed Topic Report This report lists each topic that is not associated with an index element (keyword or group). Topics are listed alphabetically by title, along with their document name and style from which the topic was derived.
  1. Select File > Reports, and click on the report you wish to view. The Reports window opens.
  2. From this window you can save, print, navigate, change views, and refresh a report. Use the Two-Column Report button (when available) to toggle a report from a two-column display to a one-column display. Once the Reports window is open, you can select another from the Select Report drop-down list.