Adivo
Subscribe  |   
  Search  
Features of TechWriter for Databases  

Features of TechWriter for Databases

Supported Databases

  • Microsoft Access 2000, 2002/XP, 2003 and 2007.
  • SQL Server 2000, 2005 and 2008 all editions.
  • Oracle 9i and 10g.
  • SAS 9.0, 9.1 or 9.2 (Local Data Provider only)
  • MySQL 5.0 and higher

Database Objects Documented

  • Tables, Views and Columns.
  • Table row counts.
  • Functions, Procedures and Parameters.
  • Indices, Foreign Keys and Triggers.
  • Column Data Types, Default Values and Required Indicator.

Supported Output Formats

  • PDF (Portable Document Format)
  • Compiled Help / HTML Help 1.x File (CHM)
  • Word/RTF (DOC)
  • HTML Page (single-page HTML)
  • Web Site (multi-page HTML)
  • DocBook XML
  • XPS (XML Paper Specification) Document

Advanced Filtering

  • Filter the tables, views, functions and procedures that you want to include or exclude through an easy-to-use checkbox interface.
  • Filter based on wildcard patterns that match the names of your database objects.

Annotations

  • WYSIWYG annotation editor for adding and revising database descriptions and remarks.
  • Rich content model that supports formatting of paragraphs, lists, tables, images, hyperlinks and more.
  • Import and export annotations to and from comma-delimited and XML files.
  • Export annotations to a SQL script. 

Customizations

  • Custom language file allows over 100 alternate values for output headings and text.  Can be used to support other languages or produce highly customized output. 
  • Control the level of detail included in the topic page for each database object by selecting from over 25 sections of conditional content.

Optional Command Line Interface

  • Can be called from build tools (e. g. MSBuild, Ant, NAnt).
  • Parameters allow you to specify the project file, output type and a refresh switch.

PDF Output Features

  • Printable table of contents with page numbers and hyperlinks
  • Bookmarks for navigation
  • Printable index with page numbers and hyperlinks
  • Page headers and footers

Compiled Help Output Features

  • Table of contents for navigation
  • Search tab for full-text searching
  • Index tab containing generated index terms
  • Page headers and footers

Web Site/HTML Page Output Features

  • Template-driven output
  • Configurable top-level page name
  • Configurable table of contents

Word/RTF Output Features

  • Table of contents
  • Page headers and footers
 
  Copyright 2002-2010 Adivo Ltd.  |  Site Index  |  Legal Notices