Logs

  • Article

The Microsoft Dynamics NAV 2013 Help Toolkit creates four logs when building Help. You can use these logs to troubleshoot potential errors.

Log Purpose Default file name Location

Help Builder default log

This log is created when the main log cannot be created.

This log contains:

  • Validation errors in the configuration files and in the Object.xml file.

  • Errors that occurred during translation of the Object.xml file.

defaultLog.txt

%MyDocuments%\Microsoft Dynamics NAV 2013 Help Toolkit\Logs\Help Builder

Help Builder main log

This logs contains:

  • A list of processing steps, errors, and warnings that occurred at build time.

  • A summary of processing time, number of successfully processed projects, number of failed projects, and number of errors.

  • A list of projects with errors and number of lookup errors and files that were not found in the project. Details are included in the Help Builder project log.

timestamp-Log.txt, for example: 20090609-140356-Log.txt

The root directory, which is the folder that contains the HTML Help project file, .hhp, for the project that Help Builder is compiling. For example, C:\Help Example\addin_a\Source.

Help Builder project log

This log contains:

  • The name of the processed Help project.

  • A list of files that were not found.

  • A list of object IDs that were not found in the Object.xml file.

Log.txt

The Processed folder of the project

HTML Help Workshop compiler log

This log contains:

  • Summary information about:

    • Compilation time.

    • The number of compiled files.

    • The size of .chm files.

  • A list of errors that have occurred during compilation, including:

    • Missing files.

    • Duplicated files.

    • Broken links in the table of contents.

    • Unexpected HTML tags in HTML files.

    • Incorrect aliases, such as an alias that points to a file that does not exist.

Error.log

The Processed folder of the project

Help Builder wizard log

Contains the Help Builder console output and the settings used by the Help Builder wizard during the build process.

helpBuilderWizardLog.txt

%MyDocuments%\Microsoft Dynamics NAV 2013 Help Toolkit\Logs\Help Builder

See Also

Other Resources

Troubleshooting Help Errors