Modifying the documentation format
Published 05 February 2013
You can modify the style sheets that SQL Doc uses to generate the database documentation, if required. In addition, when the documentation has been generated, SQL Doc provides all the source files so that you can edit them if required.
Modifying style sheets
SQL Doc uses Cascading Style Sheets (CSS) to determine the appearance of the database documentation. You can edit the master style sheet using a CSS editor, for example to change fonts, font sizes, font colors, text alignment, or table properties.
The SQL Doc master style sheet (master.css) determines the appearance of the documentation preview (the right-hand pane) and the generated documentation. The style sheet is located in the subfolder Style1/Style where you installed SQL Doc.
We recommend you make a copy of the master style sheet before you edit it.
Modifying Microsoft HTML Help (.chm) documentation
To customize a Microsoft HTML Help file, edit the source files then recompile the help using Microsoft HTML Help Workshop. For example, the default project language is English; if your database documentation contains characters from a different Unicode character set, you may want to change the language setting in the project (.hhp) file and then recompile the help so that the characters are displayed correctly.
By default, SQL Doc erases 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, create a registry value as follows:
- Open the Windows Registry Editor (regedit.exe), and navigate to the sub-key appropriate to your version of SQL Doc:
Version 4.x
HKEY_CURRENT_USER\Software\Red Gate\SQL Doc 4\Options
Version 3.x
HKEY_CURRENT_USER\Software\Red Gate\SQL Doc 3\Options
Version 2.x
HKEY_CURRENT_USER\Software\Red Gate\SQL Doc 2\Options
Version 1.x
HKEY_CURRENT_USER\Software\Red Gate\SQL Documentor - Right-click the sub-key and select New > String Value.
- Name this new value KeepIntermediate, and set its value to True.
To revert to the default setting, change the KeepIntermediate value to False.
To open Windows Explorer at the location of the saved project documents, open the project in SQL Doc and press Alt+E.
