Viewing documentation
Published 05 February 2013
By default, SQL Doc opens the documentation when it has finished generating. If you do not want SQL Doc to open the generated documentation automatically, clear the Open documentation on completion check box on the Generate Documentation dialog box.
SQL Doc creates your documentation in the folder you specify on the Generate Documentation dialog box.
Document (.doc)
To view the documentation, open the Project.doc file (see About documentation formats for a list of recommended applications for viewing the document).
If you are viewing in Microsoft Word, follow the instruction on the Table of Contents page to generate a table of contents.
Web pages (.html)
HTML documentation is created in a time-stamped subfolder. To view the documentation:
For web pages created with frames:
- open the main.html file
For web pages created without frames:
- open the index.html file
If you selected Use frames when you generated the documentation, the database documentation uses JavaScript. Your web browser may restrict access to this content; refer to your web browser documentation for more information.
Help file (.chm)
To view the documentation, open the Project.chm file. The help is opened in the Microsoft HTML Help browser.
These files cannot be opened across a network.
Find out more about what is included in the documentation.
