ApexSQL Doc can generate documentation in any of the following formats:
The variety of formats makes it easy to share with others, easy to use, and easy to search for any required word or parameter. The images shown in the following topics are representative of the documentation produced in each format
Compiled HTML Help file format or CHM is the standard for software help files. It contains a Table of contents tree (TOC), Index and Search modules. Topics are easily browsed via the TOC or internal links. CHM output exists as single *.chm file that can be opened independently without any additional software:
HTML documentation format consists of multiple individual .html files interconnected by links. HTML format is helpful for posting on corporate intranets:
HXS (HTML 2.0) is the next generation help File format introduced by Microsoft, which is included in tools like SQL Server Management Studio for SQL Server 2008. HXS adds powerful new capabilities including more toolbar options, and better searching and indexing
Tech tip:
The Help 2.0 SDK is required to generate documentation in the HXS format. If experiencing trouble with this format, click here to learn more about setting up ApexSQL Doc to use the HXS format
|
Microsoft Word document format is great for printing and editing. The documented objects and topics are linked within the document allowing finding objects quickly. ApexSQL Doc generates documentation in both Word Document 97-2003 (.doc) and Word Document 2007 (.docx) formats:
Copyright © 2012 ApexSQL LLC. All Rights Reserved.
