Diagram summary

A diagram summary is a component in a report template, indicating the need of looping (i.e. walking through) specific type(s) of diagram, and presenting their properties in tabular form. For example, to loop all use case diagrams in a project and form a table consisting of diagram names and documentation. By default, a table of diagram names will be printed. You are expected to add property column(s) under a diagram summary to indicate the diagram properties to print in the table.

Showing a property table for diagrams in project

To loop specific type(s) of diagrams in project for listing their properties in a table, create diagram summary at template root. To create diagram summary at template root:

1. In the template editor, click on the  on toolbar.
2. On the right hand side of the template editor, select the type of diagram(s) to loop and click  to confirm the selection.
   

   Select to loop use case diagram

3. If you generate report with a template like this, you will obtain a table of diagram names, provided that there exists diagram(s) of the chosen type(s). If you need to print specific diagram properties in table other than just name, click on the Add Property Column button in the toolbar of diagram summary, then select the property(ies) to add into the table as column(s). For more details about the use of property, read the chapter Property.
   

   To add a property column in diagram summary

Switching from diagram summary to diagram loop/paragraph

A diagram loop indicates the need of looping specific type(s) of diagram, while a diagram paragraph indicates the need of looping specific type(s) of diagram for constructing paragraphs of properties.

You can convert a diagram summary to diagram loop or paragraph by right clicking on a diagram summary and selecting Change to Diagram Loop/Paragraph from pop-up menu.

To convert a diagram summary to diagram loop/paragraph