Report¶

The better way to documents a Visual Paradigm project is to do a Report.
The Report in VP is like a diagram so It is positioned in the left box under the other folder.
The great advantage of the report is that all diagram changments are automatically update in the report.
The creations of the report is very simple:

It must drag the diagrams or part of them in the report page.

If it wants a better result it can chooses one of many default templates available or it can creates a new template.

Insert an object with a default template
1. With a Report window open it must select the object to insert in the report. It can uses the Diagram Navigator or other views. The object can be a diagram but also an object contained in a diagram (i.e. a single use case of use cases diagram).

2. In the property panel appear the templates files i.e._ Use Case Diagram Details, Children, Comments, Documentations, and many others_. Every one create a piece of report with some information specified in the template choosed.

3. It drags the template choosed in the report page.

Create new Template
Sometimes the default template does not full sotisfation so it is better create another template:

1. The firs step is equal at the default template cases.

2. It chooses a default template similar to the template it wants create.

3. Using the right-button of mouse, it must select duplicate so it can duplicates the template e modify the just copied file.

4. Using the right-button of mouse, it must select edit so it opens an editor and it can modify the xml file which is the template.

Tips
1. The uses of a default template can modify the index numeration of the paragraphs. It is better to modify the template deleting the styles which contain VP (for example Heading 2 (VP) ) because it recognize that text as a title and then assign it a paragraph number.

2. If it is wants to insert the ID of an object in the template must be inserted a content with property userID . This property is changed in october 2012 so for older releases it can found wrong existing template and then is better to applay the latest patch of the visual paradigm in order to solve this problem.