Customizing documentation

File format

ApexSQL Doc can generate documentation in any of several formats. Details about each file format, along with examples, are located here

To select the file format that ApexSQL Doc will use, in the Output options pane, click File Format

Style sheets

Customize the appearance of your generated documentation using style sheets. ApexSQL Doc comes with the Visual Studio 2005 and 2010 stylesheets

To choose which style sheet to use for documentation, in the Output options pane, click Styles

Headers and footers

Use custom tags in both the header and footer, which will automatically be replaced with the corresponding information when the documentation is generated. For example, the tag {date} will be replaced with the date the documentation was generated. A full list of accepted tags is located below

To define headers or footers for the documentation, in the Output options pane, click Custom text

Title and file name templates

Create templates for document titles and file names, which ApexSQL Doc will use to customize each document that is generated

To define title and file name templates for the documentation, in the Output options pane, click Naming

The following custom tags can be used in both templates, and will be replaced with the corresponding information when the documentation is generated

{datasourcename}
{databasename}
{date}

Copyright information

Information about the author, copyright, and any other comments will be displayed in a page at the end of the documentation

To enter copyright information:

On the Home tab, in the Tools group, click Application options
In the window that opens, select the General tab. Enter copyright and other information on the bottom of this page

Custom tags

Tag	Is replaced with
{datasourcename}	The name of the data source
	Example: (local)
{databasename}	The name of the database
	Example: AdventureWorks
{date}	The date the documentation is generated. Define the format for this date via the application options

{time}	The current time including hour, minute, and second

{author}	The name of the document author

{objecttype}	The object type
	Example: table, view, or procedure
{objectname}	The name of the processed schema object

{owner}	The object owner
	Example: dbo

Note:

Custom tags are not case sensitive