ApexSQL Knowledgebase

LINKS

General

Apex SQL Audit
Apex SQL Clean
Apex SQL Code
Apex SQL Data Diff
Apex SQL Debug
Apex SQL Diff
Apex SQL Diff API
Apex SQL Doc
Apex SQL Edit
Apex SQL Enforce
Apex SQL Log
Apex SQL Log API
Apex SQL Recover
Apex SQL Refactor
Apex SQL Report
Apex SQL Script
Apex SQL Source Ctl
Apex SQL SSIS Compare

Knowledgebase Home

MOST RECENT

How to change fonts of object SQL in documentation

How to put descriptions for the tables in ApexSQL Doc

Welcome to the ApexSQL Knowledge Base

SITE FEED

Site Feed

Support Forum

The fastest and most effective to get answers to your questions quickly.

FAQs

Quick answers to common questions.

Troubleshooting

Known issues and basic troubleshooting techniques for problems or unexpected behaviors.

Knowledgebase

Technical tips, How-to articles, and other tutorials about ApexSQL Tools.

Online Documentation

All of our help files for download or convenient viewing online.

Videos

Watch product demos, training videos, or tutorials of our products' main features.

ApexSQL Knowledgebase

Tips and How-to Articles for Apex SQL Tools

How to change fonts of object SQL in documentation

SUMMARY
This article describes the customization of font size/style for SQL section of documentation with help of the custom style sheet.

RESOLUTION
To customize the font for SQL section of documentation the following operations should be performed. All examples are specified based on style.css file from Template folder:

1. Open style.css file for editing it.

2. Add the following lines to 'pre' class:
font-size: 10pt;
font-family: "Lucida Console";

3. Save changes and specify this css file as a style sheet on Formatting step of

Project Wizard:

AUTHOR
Dmitriy Dyubchenko

LAST REVIEW DATE
06 October 2008

Labels: ApexSQL Doc

...

posted by ApexSQL Team on Wednesday, October 08, 2008 0 comments

How to put descriptions for the tables in ApexSQL Doc

This KB discusses how to add descriptions to tables in ApexSQL Doc through the extended property feature.

DESCRIPTION
To show the extended properties in your database's documentation , ApexSQL Doc allows you to specify a common name for the properties in the ‘Extended Properties’ step of the Project Wizard. As with Enterprise Manager's Table designer or Management Studio, MS_Description is also the default Main Extended Property Name set by ApexSQL Doc when a user adds extended properties.

SOLUTION
The following example will demonstrate how the Main Extended Property Name value affects the final documentation:

Example 1:

CREATE TABLE [DBO].[TABLE_EXT_PROPS] (
[FIRST_COL] [INT] NOT NULL,
[SECOND_COL] [VARCHAR](50) NULL)
GO
--First property
EXEC SYS.SP_ADDEXTENDEDPROPERTY
@name = N'MS_Description' ,
@value = N'Description for First_col' ,
@level0type = N'SCHEMA' ,
@level0name = N'dbo' ,
@level1type = N'TABLE' ,
@level1name = N'Table_Ext_Props' ,
@level2type = N'COLUMN' ,
@level2name = N'First_col'
GO
--Second property
EXEC SYS.SP_ADDEXTENDEDPROPERTY
@name = N'MS_Description' ,
@value = N'Description for Second_col' ,
@level0type = N'SCHEMA' ,
@level0name = N'dbo' ,
@level1type = N'TABLE' ,
@level1name = N'Table_Ext_Props' ,
@level2type = N'COLUMN' ,
@level2name = N'Second_col'
GO

Above SQL script displays as below in the documentation:

Example 2: Let’s change the name of the first property to another, for example ‘Caption’:

EXEC SYS.SP_UPDATEEXTENDEDPROPERTY
@name = N'Caption' ,
@value = N'Description for First_col' ,
@level0type = N'SCHEMA' ,
@level0name = N'dbo' ,
@level1type = N'TABLE' ,
@level1name = N'Table_Ext_Props' ,
@level2type = N'COLUMN' ,
@level2name = N'First_col'

The second property name stays as “MS_Description”. The same goes for our Main Extended Property Name.

Below image shows how this affects the documentation:

The first property value is gone from the Description column because the property name was changed.

Example 3: Let’s change the value of the Main Extended Property Name to ‘Caption’. This will affect the documentation as below:

The second property disappears because its name remains “MS_Description”.

SEE ALSO
Options : Extended Properties in Documentation

AUTHOR
David Dawson

LAST REVIEW
29 August 2007

Labels: ApexSQL Doc

...

posted by Janice Lee on Saturday, July 28, 2007 0 comments

Welcome to the ApexSQL Knowledge Base

Welcome to the ApexSQL Training Knowledge Base. Here you'll find tips, reviews, videos, and articles on how to get the most out of ApexSQL Tools and Microsoft SQL Server.

Labels: Apex SQL Data Diff, Apex SQL Debug, Apex SQL Diff, Apex SQL Edit, Apex SQL Refactor, Apex SQL Script, Apex SQL SSIS Compare, ApexSQL Clean, ApexSQL Code, ApexSQL Doc

...

posted by Janice Lee on Monday, June 25, 2007 0 comments