Test Design StudioGo to Previous Topic: DocumenterGo to Next Topic: HTML Help Compiler

Documenter Wizard

The documenter allows you to document an entire solution, and individual project, or a loaded custom component. Invoke the Documenter Wizard by selecting Tools -> Documenter Wizard... from the main menu.

Welcome Page

This page allows you to choose the type of item to document. The following types are supported.
TypeDescription
Complete SolutionAllows you to document an entire solution. This is ideal when a solution contains multiple projects.
Single ProjectAllows you to document a single project from the solution.
Custom ComponentAllows you to document a COM component that has been loaded as a custom component in the Object Browser.
Select the documentation type to generate and click the Next button. If you selected the Complete Solution option, the Select Projects page will be displayed. If you selected the Single Project option, the Select Project page will be displayed. If you selected the Custom Component option, the Select Component page will be displayed.

Select Projects (Complete Solution)

This page allows you to select which projects will be included in the documentation. Only those projects you select will be processed. When the projects have been selected, click the Next button. The Configuration Style page will be displayed.

Select Project (Single Solution)

This page allows you to select the project to be documented. If only one project is loaded in the solution, this page will be skipped. When the project has been selected, click the Next button. The Configuration Style page will be displayed.

Select Component (Custom Component)

This page allows you to select the project to be documented. If only one project is loaded in the solution, this page will be skipped. When the project has been selected, click the Next button. The Configuration Style page will be displayed.

Configuration Style

Select the type of configuration you would like to use for your documentation.
TypeDescription
Use default settings Select this option to use the default settings for generating the documentation. All public members of your files will be included.
Custom settings Select this option to apply more control over the types of public and private members that are included in your documentation. You may also choose additional customization options to change the title, layout, and provide additional content.
Choose your style and click the Next button. If you selected Use default settings, the Output Configuration page will be displayed. If you selected Custom settings, the General Options page will be displayed.

General Options

This page allows you to customize the general content of the output.

Settings

Setting Description
Title Customize the title that is displayed in the header of each output page.
Include built-in language references When selected, the built-in language references for a project will be included in the generated output. For instance, a Unified Functional Testing object language reference will be included for Unified Functional Testing projects. This allows user functions to cross-reference the content of the built-in language.
Note:   Including the built-in language references will result in longer compilation times and should probably not be used while previewing your content.

Root Page

A root page allows you to insert any HTML page as the root page of the compiled help. The root page will typically be the first page of the help file that is displayed by default. Use this option to provide an overview or introduction to your documentation.

Setting Description
Include root page Check this box to include an HTML root page.
Topic Name Specify the name to be given to the page when displayed in the Table of Contents.
File name The full path to the HTML file to use as the root page.

Other Settings

Setting Description
Additional Content The full path to a folder containing additional content for your help files. This can include images or other items that need to be copied for your documentation.
Configuration File The full path to the XML file that defines the structure of the Table of Contents. This file allows you to customize the structure of the Table of Contents as well as add custom topics.
Include source code When selected, the source code for relevant items will be included in the documentation. All source code is included with full syntax highlighting (for supported languages).

Click the Next button to continue. The File Options page will be displayed.

File Options

This page is used to determine the types of public and private file members to include in the project. Click the Next button to continue. The Class/Interface Options page will be displayed if you are documenting a project that supports classes or interfaces. Otherwise, the Output Configuration page will be displayed.

Class/Interface Options

This page is used to determine the types of public and private class/interface members to include in the project when supported. Click the Next button to continue. The Output Configuration page will be displayed.

Output Configuration

This page is used to finalize the output options for the documentation.

Output Type

Setting Description
HTML Help Project Select this option to generate an HTML Help Project that can be used to compile an HTML Help file.
Compile Project Select this option to compile the generated HTML Help Project. Requires Microsoft HTML Help Workshop.
Web Files Select this option to generate web files that can be displayed in a standard web browser.

Location

Setting Description
Name The name given to the output file.
Create directory for documentation Select this option to create a directory to hold the generated content (recommended).
Output directory Specify the output directory where the documentation will be created.

Open File(s) After Compile

Setting Description
Compiled HTML Help Opens the compiled HTML Help file (if generated).
Web Files Opens the index page of the web files (if generated).

When you are ready to generate the documentation, click the Finish button.

Note:   Watch the Test Design Studio status bar for indications of the documenter progress.