Prev Next

Model Reports Panel

The 'Model Reports' panel provides a set of tools for extracting information from the model for output in a variety of useful formats, including DOCX, PDF and HTML.

Available Facilities

Facility

Description

See also

Report Builder

Click on this icon to access a short menu of documentation options:

  • Generate Documentation - generate a document from the content of the model; generate rtf, pdf or docx format, from built-in or customized templates
  • Generate Documentation from Selected Objects - generate a document from a selection of objects (Ctrl+click on each) in the Browser window or in a diagram
  • Simple Diagram Report - generate a 'Diagram Only' report to capture images of all diagrams in the current Package - the 'Generate Documentation' dialog displays, defaulted to a Diagram Report template; specify the 'Output to File' path, including the file extension to set the file format
  • Open a Document File - open an existing document file in RTF or DOCX format, for manual editing
  • Create a New Document File - create a new document for manual editing and export it in RTF or DOCX format
Diagram Report Editing Documents and Templates How To Generate Documents

Custom Document

Click on this icon to start to generate a custom linked document, which can contain any of a range of document objects from the model, each formatted with their own document templates.

Custom Documents

Model Documents

Click on this icon to access a short menu of Model Document options:

  • New - create a new Model Document element using the 'New Element' dialog; the 'Toolset' and 'Type' fields default to the values for creating a Model Document element
  • New from Pattern - create the Model Document from a base pattern, using the 'Create from Pattern' tab of the Start Page; the tab defaults to the Document Publishing perspective, and you can select the appropriate pattern from the list
  • Find Model Documents - run a search in the Find in Project view, to locate all Model Documents existing in the model; you can use the context menu options to operate on one or more elements, including generating a documentation report
  • Find Document Packages - run a search in the Find in Project view, to locate all Packages with the stereotypes 'Master Document' or 'Report Package', which are designed to contain Model Document elements; again, you can select context menu options to generate documentation from the contents of one or more Packages
  • Help - select this option to display the ?? Help topic
Add Elements Directly To Packages

Templates

Click on this icon to manage, create and modify the templates used in generating documents in RTF, PDF or DOCX format.

All About Document Templates

Preview Mode

Click on this icon to display the Dynamic Documents window, which displays a document instantly generated from the current element.

Dynamic Document View

HTML

Click on this icon to select from two options for publishing documents on the web:

  • Standard HTML Report - publish a document to an internal or internet website as static web pages, in standard HTML
  • Publish to Joomla! - generate an HTML document to a Joomla! database, for internet distribution
Publish to Joomla! HTML Reports