Master Documents and Model Documents [Enterprise Architect User Guide]

Top Previous Next

Master Documents and Model Documents

button_main button_prev button_next

You can develop virtual documentation for output in both printable document and web page formats, using Master Document and Model Document elements. The process for generating web virtual documentation differs from that for printable documentation in two ways:

You use a standard or customized HTML template, which you select in the Style field on the Publish as HTML dialog; you do not specify or use any templates defined in the element RTFTemplate Tagged Value

You create a Package list to select the elements for the report, and not a Model Search (which is defined in the SearchName and SearchValue Tagged Values in the Model Document elements)

Access Click Document element, then Project | Documentation | Publish as HTML (Shift+F8) or

Project Browser Document element context menu | Documentation | HTML Report

Generate web documentation from a Master Document and/or Model Documents

Step

Action

See also

1

On the Publish as HTML dialog, set the options for your web document as you wish.

Select your preferred template - such as a customized Master Document template - in the Style field.

 

Create a Web Page Report

2

Click on the Generate button to generate the documentation.

The HTML Report Generator works through the defined content of the Master Document element and/or the Model Document elements, and pulls in the information from the listed Packages, formatted according to the template identified in the Style field.

 

 

3

Click on the View button to view the documentation.

 

 

Learn more

Virtual Documents

 

Learning Center topics

Alt+F1 | Enterprise Architect | Reporting | Virtual Documents