Generate RTF Documentation Dialog

Model Document

Root Element
Root Package

Confirm the name of the element selected from the Project Browser, 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.

The (  ...  ) (Browse) button enables you 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-generated template.

System RTF Templates

Design Custom RTF Templates

Output to PDF

Generate the report in PDF format rather than in RTF format.

Use Language Substitutions

Switch custom language word substitutions on.

Deselect to switch custom language word substitutions off.

Word substitutions

View Document On Completion

Open the document as soon as it has been generated.

Use Internal Viewer

Enable the View button to launch the generated RTF Documentation in the Enterprise Architect internal viewer.

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

Document options

Include all Diagram Elements in Report

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

The Package.Diagram.Element and Package.Element checkboxes must be selected 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 properties

Optimize for Open Office

Generate reports where diagrams are adjusted for clean rendering in Open Office.

The option also overwrites the value fields defined in a document section with the actual value text.; if you open a generated report in Word, you can format the text but you cannot display the original field code.

If the checkbox is deselected, diagrams displayed in Open Office are less distinct - value fields remain and are populated with the appropriate values; when you display a generated report in Word, you can right-click on the field and toggle between the value text and the field code.

If you use Open Office as your text editor, you must select this checkbox to show the field values; Open Office defaults to showing the field codes only, and you cannot toggle to the field values.

Resource Document

Save the current options as a document definition.

Document definition

Edit Template

Edit the currently-named template using the RTF Style Template Editor.

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

RTF Style Template Editor

Generate

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

View

Launch the generated RTF Documentation in:

Abort

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