How to: Generate a Report of Missing Help Topics

If you have an existing Help project that you want to check for missing documentation, the audit mode is helpful. For example, you can print a report that shows all the missing Help topics to see an overview of the remaining work, or the missing Help topics in a certain area that you want to focus on. The process of generating a report is similar to generating the Help topics; the difference is that you select the output form as one of the last steps of the Microsoft Dynamics NAV Reference Help Generator.

To generate a report of missing Help topics

  1. Start the Microsoft Dynamics NAV Reference Help Generator, and choose the Next button.

  2. On the Specify a Multilanguage file page, you must choose the multilanguage file that contains the objects that you want to check. Use the Find button to locate the file on your computer.

  3. Select the Use the Name property when no localized caption is included check box to use the Name property on the object in case there is no localized caption for the object. Choose the Next button.

  4. On the Specify object IDs for the objects that you want to document page, you can filter for the object that you want included in the report. For more information about filters, see Using Filters in the Help Generator Wizard.

  5. When you have applied the appropriate filter, choose the Next button.

  6. On the Specify what you want to generate page, you specify that the output should be a report. Select the Create a report of missing Help topics without generating a Help project option, and choose the Next button.

  7. On the Specify report options page, you must enter a name for the report.

  8. In the Help Collection field, browse to the path of the Help collection that you want the tool to examine for missing topics.

    Note

    The Help collection can be postfix .htm files from the Microsoft Dynamics NAV Help Server, or alternatively HTML Help files postfixed .chm. The search for missing topics is performed only in the specified file.

  9. Choose the Next button to continue. Confirm the settings on the page, and choose the Run button.

After the report is successfully generated, you can inspect it by choosing the Report button. The status for each topic indicates whether a topic already exists or is missing.

When you have an overview of the missing Help topics, use the Reference Help Generator to either create a new Help project, or add missing topics to an existing Help project.

See Also

Tasks

How to: Generate a New Help Project
How to: Add Topics to an Existing Help Project

Other Resources

Help Generator Tool