Please note that if you incorrectly edit this file directly you may not be able to document your database again using this project file. The structure documented here maybe altered in future versions of SQL Doc.
The project files for SQL Doc are outputted in XML and has the following structure
- Code: Select all
<?xml version="1.0" encoding="utf-16"?>
As you can see the basic structure is based around a Project which has several attributes. Each Project consists of Items and ObjectExclusions (objects excluded). The Items itself is a collection of databases which in turn have a collection of objects.
In this document I will only describe the attributes for the Project.
SQL Doc 1.0 Features
- Version-Version of the XML format. Currently 1
Author-Name of Author
HtmlPath-Path to the generated output
ProjectDescription-Description of the project displayed on the front page
Treeview-Specifies if to generate a tree view or not
OutputStyle-StandardHTML/FramedHTML/ CompiledHelpThe generated format
Server-the default Sever name
Database-the default Database name
IntegratedSecurity-True or false
Username-The user name if not using integrated security
paswword-The password for the username
AllowEditing-True or false enabling the editing of the descriptions
ApproxVals-Number of database objects
Forced-Over-write previously generated output
SQL Doc 1.1 Features
- AutoAppend-True or false to specify if the server name/date is auto added to the generated path.
IncludeSQLScript-Include SQL Scripts in generated output
IncludeTriggers-Include Table/View Triggers in generated output
IncludeIndexes-Include Indexes in generated output
IncludeForiegnKeys-Include Foreign Keys in generated output
IncludePermissions-Include Permissions in generated output
ThemeName-The name of the theme. The name must match the folder name under %Program Files%\\Red Gate\\SQL Doc 1\\Style1\\Skins
NewDatabaseObjects-Enabled/Disabled. Specifies if new items to this documentation are automatically enabled or disabled.
SQL Doc 1.2 Features
- IncludeFullIndexInfo-Specifies if indexes are given their own page.