Generate Documentation

It is possible to specify a wide range of parameters to control how your RTF document is generated and output. You can specify, for example, where the document file is written to, what format it is generated in, and what elements are included in the document. You set these options on the Generate Documentation dialog, on which the options are provided on a number of tabs.

The first, and default, tab is the Generate tab, on which you define how and where the document is generated. After you have set options on any or all of the other tabs, you return to the Generate tab and click on the Generate button to produce your document.

Access    Project Browser package: ( F8 ) > Generate or
Diagram element ( F8 ) > Generate

Set Report Generation Options

Option

Action

See also

Model Document

 

Root Element
Root Package

Confirm the name of the element selected from the Project Browser, diagram, Diagram List or Model Search.

If this is the specially-created model document element for a Virtual Document, the field is Model Document.

Otherwise, this field identifies the selected element of the hierarchy to be reported on; that is, the Root Element or Root Package.

 

Virtual Document

Output to File

Type or select the location and filename for the generated documentation.

Click on the (  ...  ) (Browse) button to navigate to the location.

 

 

Use Template

Type or select the name of the RTF template to apply to document generation.

You can select either a standard template (enclosed in parentheses) or a user-designed template.

 

System RTF Templates

Design Custom RTF Templates

Output to PDF

Select to generate the report in PDF format rather than in RTF format.

 

 

Use Language Substitutions

Select to switch custom language word substitutions on.

Deselect to switch custom language word substitutions off.

 

Word Substitution

View Document On Completion

 

Select to open the document as soon as it has been generated.

 

Use Internal Viewer

Select to enable the View button to launch the generated RTF document in the Enterprise Architect internal viewer.

Deselect to enable the View button to launch the generated RTF document in the MS Windows default RTF file viewer.

 

Document Options

Include all Diagram Elements in Report

Select to include elements in the report from external packages that are referenced from a diagram, for every diagram covered by the report; the checkbox defaults to selected.

To include the external elements in the document, also select the Package.Diagram.Element and Package.Element checkboxes in the current template.

If external elements are to be included only for specific diagrams, deselect this checkbox and - only for the diagrams for which you want to include external elements in the report - for each diagram select the Document each contained element in RTF checkbox in the diagram properties.

When both options are deselected, or when neither of the Package.Diagram.Element or Package.Element checkboxes are selected in the template, only elements in the current package are documented.

 

Diagram Options

Resource Document

Save the current options as a document definition.

 

Resource Documents

Edit Template

Edit the currently-selected template using the Document Template Editor.

You can only edit user-defined templates, not the standard templates provided with Enterprise Architect; standard template names are enclosed in parentheses.

 

Design Custom RTF Templates

Generate

Generate the document (after you have set all the options you require, on all tabs of the dialog).

 

 

View

Launch the generated document in:

The MS Windows default RTF file viewer, or
The Enterprise Architect internal viewer, if you have selected the Use Internal Viewer checkbox (above)
 

 

Abort

Cancel report generation; a prompt displays to confirm cancellation of the report.

 

 

Notes

For an introduction to generating RTF documentation, see the RTF Documents topic

Learn more

Learning Center topics

(Alt+F1) | Reporting | Rich Text Reports | Generate an RTF Report