Show TOC

Object documentationDocumentation Wizard Locate this document in the navigation structure

 

The Documentation Wizard organizes the information in your model according to the parameters that you specify (such as printing notes or creating an index), creates a document and enables you to print it and save it.

 

You display the Documentation Wizard by choosing   Tools   Documentation Wizard  . Once you select the print options, and click Generate, the document is displayed for printing or saving. Choose the Print or Save As option from the File menu.

Structure

The following table lists the options in the wizard for printing your documentation:

Control

Option

Description

Source level

A drop-down list showing all the upper-level elements ("diagrams") of your model, such as pages and iViews, to enable you to select how much of the model is to be documented.

Include in documentation

Top-level Design board diagrams only

Prints only the diagram(s) displayed on the Design board.

Model elements and properties

Prints information about the model (for example, the iView name, author, last modified date, user-defined hyperlink and user defined notes). In addition, it prints a table listing the elements belonging to the model component, and properties of those elements. If the component has no lower-level elements, the table does not appear.

Statistics

A section at the end of the document that provides the following model statistics: Total Diagrams, Total Definitions, Total Property Values, Average Definitions per Diagram, Average Properties per Element.

Index

Adds an alphabetized index of model elements to the document.

All Design-board diagrams

Prints all diagrams of component levels below that displayed on the Design board.

Generate button

Displays a standard Windows screen for printing or saving the documentation.

Close button

Closes the Documentation Wizard without generating documentation.