Constructing report

Creating a generated element

The term "Generated element" here means a block of report content generated by Report Writer and consists of details of a particular diagram or model element.

To create a generated element block:

  1. Click to select the desired model element from either the Diagram Navigator or Model Navigator for content generation.
  2. The supported templates for the selected model element are shown on the Template Pane. Each template represents a way in presenting the selected model element on the report. For example, Children template of a System represents a list of children placed inside a particular System.
    Template pane
    Template pane
  3. Drag the desired template from the Template Pane and drop it onto the report.
    Drag template from template pane
    Drag template from template pane
  4. When the cursor drags over the Writer Pane, a tiny straight line will appear in the report indicating the position of the expected position of the generated element. Once you've dropped the template onto the report, corresponding content will be generated element to the dropped position.
    Drop template to report
    Drop template to report
  5. Same as diagram, model element's template also able to drag to report.
    Drag template from template pane
    Drag template from template pane
  6. When the cursor drags over the Writer Pane, a tiny straight line will appear in the report indicating the position of the expected position of the generated element. Once you've dropped the template onto the report, corresponding content will be generated element to the dropped position.
    Drop template to report
    Drop template to report

Showing the bookmarks

Creating a new generated element within the boundary of an existing one is dangerous because the content may be messed up during a report update process. To avoid this, you can display bookmarks to indicate the start and end position of each generated element, and to prevent dropping a new one within the scope of the existing generated element.

To show/hide bookmarks, either check/uncheck Tool > Show Bookmarks from main menu to show/hide bookmarks.

Showing bookmarks
Showing bookmarks

Applying style to report

A style in Report Writer is a collection of formatting attributes that describe the nature of paragraphs. The generated element highly adopts the predefined styles in Report Writer therefore users can customize the related styles to bring consistency to the whole document. There are two ways for applying style to report.

Style configuration

The Stylist dialog box allows you to configure the pre-defined styles. To display the Stylist dialog box, select Tool > Show Stylist from main menu. The Stylist dialog box appear.

Stylist
Stylist

To edit the style, right-click on the highlighted style and choose Modify... from the popup menu. This displays the dialog box for the selected style. You can now adjust it with your own preference. When everything is ready, please click OK to commit the settings and exit the dialog.

Edit style
Edit style

The changes will take effect immediately and you will notice the style is applied to those generated elements using the same style.

Style change
Style change

Loading style from other report

The Copy Style dialog box allows you to copy the style from existing report. To display the Copy Style dialog box, select Tool > Copy Style from main menu. The Copy Style dialog box appear.

Copy style dialog
Copy style dialog

Select a desired report for getting the style configuration and click Copy Style. The style configuration in the current report is replaced by the style configuration of the selected report. All the predefined styles will be overwritten.

Updating table of contents

There is a predefined Table of Contents in each of the report template. Here is the pre-built Table of Contents structure:

Level Paragraph Style
0 Heading 1 (VP)
1 Heading 2 (VP)
2 Heading 3 (VP)
3-9 None
Details of predefined table of contents

To update the Table of Contents, right-click on the caption Table of Contents and select Update Index/Table from popup menu.