Retaining CHM documentation source files

Category: How do I?
Date: 21 Apr 2009
Product: SQL Doc
SQL Doc can create database documentation in Microsoft Compressed HTML (CHM) format when Microsoft HTML Help Workshop is installed. You may want to retain the source files that SQL Doc creates to manually change some options, such as the output language, and then compile the source files to CHM manually.

By default, SQL Doc will erase the source files (HTML, index files, and HHW project files) when the CHM is built successfully. To retain these source files in the same folder as the CHM output after successful compilation, you can set a registry value that will prevent their deletion.

To do this, open the Windows Registry Editor (regedit.exe), and navigate to the key appropriate to your version of SQL Doc:

[Version 1]
HKEY_CURRENT_USER\Software\Red Gate\SQL Documentor

[Version 2]
HKEY_CURRENT_USER\Software\Red Gate\SQL Doc 2\Options

Right-click this key and select New->String Value. Call this new value KeepIntermediate, and set its' value to True.

To change SQL Doc back to the default setting, change the KeepIntermediate value to False.

Document ID: KB200808000288 Keywords: SQL,Doc,CHM,keep,source,KeepIntermediate

Was this article helpful?

Search support