List out models in your diagram along with its description

Doc. Composer provides an extremely flexible way for user to customize about how their diagram and model data being render. In this article will demonstrate how to create custom template to output the image of an elements in diagram with its description in tabular form. Let’s start!

1. Go to Tools > Composer > Manage Template XMLs.
   

   Manage Template XML

2. Switch the template category to General.
   

   Switch to General Category

3. Right click on any template in the list and select Duplicate from popup menu.
   

   Duplicate any template

4. Name the template as General/DiagramElementList, and select Table as template icon.
   

   Specify name & icon of the template

5. Replace the template with following content.

   <?xml version="1.0" encoding="UTF-8"?>
   <AnyBaseInitiationBlock>
       <Property anchorMark="true" property="name" style="@heading+"/>
       <ParagraphBreak/>
       <TableBlock colWidths="40, 60" tableStyle="Summaries">
           <TableRow>
               <TableCell>
                   <Text>Element</Text>
               </TableCell>
               <TableCell>
                   <Text>Description</Text>
               </TableCell>
           </TableRow>
           <IterationBlock ignoreLastSeparator="true">
               <TableRow>
                   <TableCell>
                       <Image/>
                   </TableCell>
                   <TableCell>
                       <Property property="description"/>				
                   </TableCell>			
               </TableRow>		
           </IterationBlock>
       </TableBlock>
   </AnyBaseInitiationBlock>

6. Press Save button to confirm the change.
7. Go to Tools > Composer.
   

   Go to Doc. Composer

8. Select Build Doc. From Scratch.
   

   Select Build Doc. from Scratch

9. Select the diagram you would like to output its elements.
10. Right click on the Basic template and select Duplicate from popup menu.
    

    Duplicate diagram’s Basic template

11. Name the template as ERD Element List.
    

    Rename the diagram template

12. Change the inline call from General/Diagram Basic to General/DiagramElementList.
    

    Change to call our DiagramElmentList template

13. Press Save button to confirm the change, then close the template editor dialog.
14. Drag out the ERD Element List template into document editor.

Now the elements in diagram will be listed in a table, with its view and description show in tabular form.

Explanation of the Template

The reason why we create the DiagramElementList template under General category is to make it become a component. This allow to be reuse in other diagrams instead of need to define the same template over and over on all diagram types.

In the DiagramElementList template we first output the name of the diagram using heading style. The argument @heading+ will instruct the engine to output with property, which is diagram name in this case, with the heading style in auto order. As this is the first call therefore it will automatically output with heading1 style.

<Property anchorMark="true" property="name" style="@heading+"/>

Next we create a table with two columns, with width in 40:60 ratio. The first column name as Element which will be use to output element’s image. The second column name as Description with will be use to output element’s description.

<TableBlock colWidths="40, 60" tableStyle="Summaries">
    <TableRow>
        <TableCell>
            <Text>Element</Text>
        </TableCell>
        <TableCell>
            <Text>Description</Text>
        </TableCell>
    </TableRow>

Now create an Iteration block. Since the template is in diagram scope, therefore the IterationBlock will automatically looping all elements in the diagram.

<IterationBlock ignoreLastSeparator="true">

Within the IterationBlock we create the table row with two cell. The first cell call the Image element which will output the element’s image, according to presentation setting in diagram. The second cell output the description property of the element.

<TableRow>
    <TableCell>
        <Image/>
    </TableCell>
    <TableCell>
        <Property property="description"/>				
    </TableCell>			
</TableRow>

Next we create another template under the diagram type we would like to output. This template will call the General/DiagramElementList for render of data.

<Inline template="General/DiagramElementList"/>

You can also call this template when using Fill-in doc approach by specify the diagram level template.

${DIAGRAM, “MyERDs”, “ERD”,Any, “ERD Element List”}

 

Related Know-how

Output Entity’s Sample Data using Doc. Composer Listing Entity Column’s Details in Table How to output class members to document which only show in diagram Output Associated Diagrams from Diagram Overview using Doc. Composer Customizing deliverables in guide-through process

Related Link

How to draw an ERD (User’s Guide) Entering sample table records for entities (User’s Guide) How to customize Doc Composer’s template Doc. Composer Writer’s Guide (PDF) Doc. Composer Template