RTF Documents

rtf_documents

If you want to produce immediate, screen-viewable or printable reports on the contents of your model, you can generate Rich Text Format (RTF) documents on selected packages or elements. You have the options of:

Generating one of a set of system-provided reports on specific aspects of your model
Generating a report from a system-provided template, with control of the report output through dialog options and filters
Creating your own templates from which to generate reports, applying an even greater degree of control over the contents and format of the output

 

RTF is a format common to many word processors, so you can also work on the reports in other word-processing tools to, for example, integrate the RTF report into a larger, externally-created document.

RTF Documentation Solutions

Topic

Detail

See also

Rich Text Format Document Generation

The RTF Document Generator features:

A powerful WYSIWYG Document Template Designer you can use to:
Import and export RTF templates using XML
Customize copies of the basic, system-provided templates
Create entirely new templates of your own design
Test templates as you design them, by generating ad-hoc reports within the designer
 
A document generator that:
Provides a wide range of simple options for filtering and modifying the report output
Generates detailed and comprehensive documents based on the RTF templates
Has an embedded RTF viewer for reading the generated RTF documents  directly within Enterprise Architect

 

A tutorial on using the RTF Generator and creating RTF documentation is available on the Sparx Systems website.

 

 

Design Custom RTF Templates

RTF Templates

 

 

 
 

Generate RTF Documents

 

 

 

 

 

http://www.sparxsystems.com/resources/whitepapers/

Virtual Documents

If you want to create very focussed and specific documents, with a greater complexity and presenting different views of your model data, you can do so using virtual documents. For these, you set up a Master Document (package) element and/or Model Document elements, and link packages or model searches (for elements) into the document in whatever order or combination is most appropriate to your requirements.

You can select packages from different areas of the model, arrange them in any order, and edit or delete the packages; the virtual document automatically incorporates the changes each time you generate it.

 

Virtual Documents

Word Master Documents

As an alternative to virtual documents, and as RTF is particularly targeted at Microsoft WordT, you can link a number of rich text documents into a single Word master document.

Typically you create a Word master document, then generate some RTF reports that you link back into sub-sections of the master document and refresh as required during project development; in this way the project document becomes an easily-managed and feature-rich work product.

You can also populate a Word document from specific sections of reports, based on bookmarks - for example, a Word document might have a section for a small part of your component model; using bookmarks you can generate a full component model, and then link into just one section of the report.

This way you can maintain a complex Word document from parts of Enterprise Architect reports; the RTF Generator performs one pass for one template, but using a Word master document and Enterprise Architect bookmarks enables you to incorporate material from several RTF documents with different formats based on different templates.

By adding tables of contents, figure tables, sections, and headers and footers, you can manage a complex document with relative ease; simply update the Enterprise Architect RTF reports then refresh the links in MS Word.

 

Using MS Word

 

 

 

 

RTF Bookmarks

Notes

In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of Enterprise Architect, if security is enabled you must have Generate Documents permission to generate RTF documents
You can have several RTF reports open at the same time, as separate tabs in the central view area of the Enterprise Architect work area; you can also close the reports individually or all together, leaving views of other types (such as diagrams or code editors) still open.

Learn more

Learning Center topics

(Alt+F1) | Reporting | RTF Templates
(Alt+F1) | Reporting | Virtual Documents