You are here: Creating Documentation > AutoDoc Features > Creating Reports
Close
Doc-O-Matic 10
Creating Reports

In Doc-O-Matic you can create and include various reports in your documentation. Reports are overviews of topics that have one or more matching properties or sections. For example, you can generate a report of all symbols that contain a To do section, that have the Flag Deprecated attached, or that are not documented.

  1. On the View tab, in the Views group, click Reports.
  2. Do one of the following:
    • Click Add next to the Reports list.
    • Select a report in the Reports list. and then click Copy next to the Reports list, to copy settings of an existing report.
  3. In the Name box, type the name of your report.
  4. Select the Active check box, to include the report in the output.
  5. In the Target box, type the topic ID of the topic in which you want to show your report.
  6. In the Options box, do one of the following:
    • Select Run on exported topics, to include only exported topics in your report.
    • Select Run on topics not Exported, to include only topics that do not appear in the output.
    • Select Run on all topics, to include all matching topics.
  7. Select the Print header check box, to display your report in a table with header.
  8. Select the Use for aliasing check box, to automatically link report entries that consist of one word to the report page.
  9. In the Criteria box, select whether you want to include topic that match any selected criteria or only topics that match all selected criteria.
  10. Click More to determine a criterion for your report.
  11. You can create reports using the following criteria:
    • Sections
    • Value List Names
    • Value List Descriptions
    • Topic properties such as version numbers, flags, documentation status and export status.
    • Symbol and topic types
    • Files
    • QA checks
  12. Under Print select which parts of the matching topics you want to show in the report.
  13. You can show the following topic parts:
    • Topic titles (linked or not linked)
    • Topic IDs (linked or not linked)
    • Sections
    • Names and Descriptions of Value Description List sections
    • Documentation status
    • Topic version and topic flags
    • Information about symbols such as the module, file, namespace or class they are contained in and the line number where the symbol appears.
    • Declaration code of symbols
    • QA Warnings
  14. Click the Not Sorted arrow to select a sorting order. You can sort topics alphabetically by values in this column.
  15. To use topic parts only to sort your report, select Asc. or Desc. no print. For example, you can sort topics by a section that only contains a date in format YYYY/MM/DD.
  1. On the View tab, in the Views group, click Settings .
  2. Click the corresponding Configuration tab.
  3. Select Files & Format > Sections.
  4. Click the corresponding topics tab.
  5. In the list select Reports. Select or deselect the section.
  6. Click Up or Down to change the position of your reports in the topic.
  7. Click Edit.
  8. Click Hide to remove all report names in this configuration.
  9. You can make reports expandable and show an image instead of report names.
  10. Select Files & Format > Sections > Format.
  11. You can format your Reports as tables or as paragraphs.

Reports are only included in the output, when you export the Reports section in the Section Appearance list. The section is exported by default. On the Files & Format > Sections > Format page you can format your Reports as tables or as paragraphs.

Section Appearance

Report Paragraphs, Report Tables, Report Section Headings

Copyright © 2000-2020 toolsfactory software inc. All rights reserved.