About documentation formats - SQL Doc

SQL Doc generates documentation in the following file types:

Document (.doc)

Web pages (.html)

Help file (.chm)

You select the documentation file type when you generate your documentation.

For details of what information is included in your generated documentation, see What's in the documentation?

For information about how you can modify the format of the generated documentation, see Customizing the documentation.

Document (.doc)

This is suitable for viewing in Microsoft® Word and OpenOffice.org Writer.

We recommend the following versions (other versions may also be compatible): Microsoft® Word 2003, Microsoft® Word 2007, OpenOffice.org Writer 3.0.

Document is recommended if you want to print the document or create a PDF version. It is not recommended if you are documenting large databases, because of the large file size.

Web pages (.html)

SQL Doc generates a set of web pages. This is recommended if you are documenting large databases.

You can choose to generate the documentation with frames or without. The database and object navigation tree is created in a separate frame from the details of your database objects.

SQL Doc generates database documentation with frames much more quickly and the file sizes are smaller. You are recommended to use frames if you are documenting large databases, but note that the navigation tree requires JavaScript to be enabled on your web browser. If you cannot enable JavaScript, you are recommended to generate the documentation without frames.

Help file (.chm)

This is recommended if you are documenting large databases and you need to share the documentation. The help file is generated as a compiled Microsoft® HTML Help file (.chm), which includes search functionality and an index.

To generate your database documentation as a help file you must first download and install the Microsoft® HTML Help Workshop™. This is free to download, and is required in order to generate documentation in this format.

Downloading prerequisite application

Go to the HTML Help Workshop download page.
Scroll down to the files in this download section.
Download htmlhelp.exe.
Once it has downloaded, open the file. Microsoft HTML Help Workshop is installed.

You can now create documentation as a help file with SQL Doc.

Creating a PDF

SQL Doc does not support generating documentation directly in PDF format, but you can create a PDF by generating a Document (.doc) file, and then converting it to PDF.

Was this article helpful?

Search support