Prev Next

Model Documents and Report Packages

You can develop virtual documentation for output in both printable document and web page formats, using Report Package 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 Model Document element 'RTFTemplate' Tagged Value
  • You create a Package list to select the elements for the report, and not a Model Search (which would be defined in the 'SearchName' and 'SearchValue' Tagged Values in the Model Document elements)

Access

Ribbon

Publish > Report > HTML Report > Standard HTML Report

Context Menu

Right-click on Document element | Documentation | HTML Report

Keyboard Shortcuts

Shift+F8

Generate web documentation from a Report Package and/or Model Documents

Step

Action

See also

1

On the 'Publish as HTML' dialog, set the options for your web document as required.

Select your preferred template - such as a customized Model 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 Report Package 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