Document! X for Database Documentation
Document! X supports documentation of Access, SQL Server and Oracle databases. Database documentation covers the following database items:
- Tables and Columns
- Views
- Indexes
- Table Relationships
- Stored Procedures (SQL Server and Oracle)
- Triggers, User Defined Functions, Data Types, Users, Roles, Defaults, Rules, Checks, File Groups and Full Text Catalogs (SQL Server)
Authoring content
Document! X can extract specifically tagged comments from View, Stored Procedure and User Defined Function (SQL Server only) SQL source code. Example:
-- ##SUMMARY This procedure is an example of using various Document! X comment types
-- ##REMARKS Single line and multi-line comments can be used
-- ##RETURNS Documents the return type of a procedure
-- ##SEEALSO target="pubs_db~t-Authors", caption="A see also link to a table topic"
CREATE
PROCEDURE ExampleTaggedComments
@Param1 int = NULL, --##PARAM @Param1 The first parameter
@Param2 varchar, --##PARAM @Param2 The second parameter
@Param3 tinyint, --##PARAM @Param3 The third parameter
AS
...
Document! X can also use any existing descriptions entered into the Access Table designer, or any SQL
Server descriptions entered in the SQL Server Enterprise manager or created using extended properties.
The Document! X Content File Editor allows you to author additional content for inclusion in the generated documentation. The full featured HTML Editor, Dynamic and Project
Spell Check, Find and Replace and Link Check tools make authoring activities as productive as possible.
Colorized source code
Document! X outputs colorized SQL code associated with documented objects where available. Colorized SQL code is easier to read and forms a valuable reference in the generated
documentation.
Customization
The template based configuration that Document! X is based on makes it easy to:
- Create new comment types for use in source code comments;
- Add additional standard content to the generated documentation (for example a glossary or company information);
- Adapt existing templates to match your existing corporate style and color scheme;
- Customize Table of Contents definitions according to your requirements;
- Fine tune the standard phrases and terminology used by Document! X to match your standards.
Help where you need it
The Document! X IDE includes a comprehensive help system, including a Contents, Index and Dynamic Help window. The Dynamic Help window provides a list of help topics,
tutorials, getting started guides and movies relevant to your current activity enabling both new and experienced users to get to grips with Document! X functionality as quickly as
possible.
Document! X includes several printable 'Getting Started' PDF booklets to enable you to get immediate results from Document! X.
Authoring examples
The easy to use Example code designer included in the Content Editors makes adding multi-language examples a breeze. In-line or linked examples can be created and example code
is automatically colorized in the generated output.
Localization
Document! X supports several different languages (English, French, German, Dutch, Italian and Russian) for the phrases used in the generated output. All of the
phrases and terminology in the generated output can be configured according to preference.
Model Comments - re-usable common descriptions
Model Comments allow you to define common descriptions in a model comment profile for re-use in future projects. For example, ActiveX controls usually support a set of
common properties and events (e.g. KeyPress event, BackColor property) - Model Comments allow you to define descriptions for these members once and have Document! X use them
wherever the members appear in order to reduce duplication and effort.