Customizing report template
Visual Paradigm for UML (VP-UML) provides a documentation template designer for you to design your own report. This tutorial teaches how to design report template to generate use case report to PDF format.
| January 7, 2010 | |
User Rating:
/ 1
|
|
| Views: 4,523 | |
|
PDF
Link
Link: |
Add comments |
| Edition: Standard or above (Edition comparison) | |
To create custom template for documentation generation:
- Select Tools > Report > Generate PDF Report to open Generate PDF dialog.
- Once the Generate PDF dialog is opened, select <NEW> from Template combo box to create a template.
- Let's name the template as Use Case Diagram.
- The first step to create a template is to define what kind of diagram will be looped through the report. Press the Diagram Loop button to create a loop.
- Select Use Case Diagram in the tree, and then press the right arrow button to add it into the loop.
- Click the Diagram Image icon to include the diagram image in report.
- Now let's create a summary table to show what are included under the use case diagram. Press the Add Element Summary icon to insert the summary table of the diagram.
- Select Use Case on the tree and press the right arrow button to add it to the included element list.
- After you specify what elements will be included in the summary table, you can then specify the properties which you want to show. Press the Add Property Column button to insert a property.
- You can then select the property from the list on the right hand side of the dialog. Let's select the Documentation property.
- The Add Property Column Above/Below buttons let you insert property column before or after the current property.
- Let's specify 2 more properties, the Rank of the use case also the Details.Author (Author of use case details).
- Let's also include the details of use case's in report. Press the Add Element Loop icon to insert use case element.
- Select Use Case in the tree and press the right arrow button to add it to the included element list.
- Let's include the sub-diagrams of use case in our report. Press the Add Diagram Summary icon to insert a summary table of use case's sub-diagram.
- Select the diagram types on the tree and press the right arrow button to add them to the included diagram list.
- After specify the diagram types of sub-diagram, press the Add Property Column icon to add a property of the sub-diagram.
- You can select the property from the list on the right hand side of the dialog. Let's select Documentation property.
- Once you finish defining the template, you can have a preview of the report. Press the Preview Template Structure button can preview the report structure but not the report content.
- The preview of report structure will be shown at the bottom of the dialog.
- Press the Preview Template Content button to preview the exact report.
-
The preview of report structure together with content will be shown at the bottom part of the dialog. You can select the element on the tree to navigate within the report. Note that the preview may have small difference to the actual generated report.
- Element can be re-ordered by right click on it and select Move Up/Move Down.
- If there are diagrams or model elements you do not want to show in report, you can select them in preview and then right-click to disable Generate in order to ignore them in report.
- Various options such as cover page, header, footer and info of report can be configured in the report template designer as well. Press the Options button to configure them.
- Let's configure the Cover Page by specifying the Title, Organization name also the Logo image.
- Press OK button to confirm your configurations and close the dialog.
- Once you finish defining the template, press the Save button to save it.
- The template can also be exported for future use.
- Press the Close button to close the Report Template dialog.
-
Here is the generated PDF report.
Rate this Article
Click on one of the stars below to rate this article from 1 (lowest) to 5 (highest).
Comments (4)
written by Danilo Gurovich on January 29, 2011
You could have a style sheet to customize the fonts and font sizes used for the report generation. A big problem I've had is the report constantly having the wrong font sizes for my needs with no way to change.
written by Jick Yeung on January 31, 2011
Dear Danilo,
Thank you for your post. Could you provide me with a sample (project) showing your problem, as well as a description of what you would expected? You can send me the file by submitting a ticket at:
http://www.visual-paradigm.com/support/technicalsupport.jsp
Look forward to hearing from you.
Best regards,
Jick Yeung
written by andisheh on August 9, 2011
Thank you for your post
i need to know how i can change a documentation generate for persion fonts.how can changes them to right to left from left to right?
written by andisheh on August 10, 2011
please responde me