Document each contained elem. generates only tag

[armin]

Hi,

I would like to generate a rtf report which contains all diagrams in all of my subpackes. After each diagram there should be a list of contained elements (classes, components,...) whith its notes. I checked the "Document each contained element in rtf" box in diagram properties and created the following rtf template:

package >
diagram >
{Diagram.Name} - ({Diagram.Type} diagram)
{Diagram.Notes}
{Diagram.DiagramImg}
Figure {Diagram.Figure}
element >
{Element.Name}
{Element.Notes}
< element
< diagram
element >
embedded elements >
< embedded elements
diagram >
< diagram
child elements >
< child elements
< element
child package >
< child package
< package

The diagrams appear. Foreach element in a diagram the generator generated the tags "{Element.Name}" and "{Element.Notes}" but not the name or the note itself.

Is there a solution for that problem?

Thanx in advance Armin

[«Midnight»]

What about the elements themselves? Are they contained in the same package as the diagram you are documenting?

If not, perhaps EA is only mentioning them here because there are diagram objects referring to these (foreign) elements. If you document the packages containing these elements, do you get the desired results?

[armin]

Most packages contains diagram(s) and its elements. But there are also packages which contains only diagrams. In both cases it is the same output: the elment.name tag but not the elements name.

If I have no subpackages in the package I select for generation the generator works correctly.

[«Midnight»]

Which RTF generator are you using? Remember, there are two.

What are your settings?

[armin]

I use the template based generator. (The one with the small start dialog - Titel: "generate RTF documentation").

[peter.zrnko]

According to Working with the RTF Generator (PDF) section "Recursion through Packages and Elements" it has to work as you supposed. I've tried it and it didn't. It seems to me it's a bug.

But there is a solution to you. Remove content of

diagram >
element >
{Element.Name}
{Element.Notes}
< element
< diagram

to element itself:

element >
{Element.Name}
{Element.Notes}
< element

your template will look like this:

package >
diagram >
{Diagram.Name} - ({Diagram.Type} diagram)  
{Diagram.Notes}
{Diagram.DiagramImg}
Figure {Diagram.Figure}
element >
< element
< diagram
element >
{Element.Name}
{Element.Notes}
embedded elements >
< embedded elements
diagram >
< diagram
child elements >
< child elements
< element
child package >
< child package
< package

The
diagram > element >
section will be rendered using
element >
section.

[«Midnight»]

And in the meantime please report the bug to Sparx with the Bug Report Page. You'll find the link by clicking Support at the top of the forum page and looking in the left-side menu.

If possible send Sparx a zipped copy of the offending project.

Since a build just came out, they can hopefully address this for the next build.

[peter.zrnko]

The solution I've described doesn't work. The section >diagram>element is not rendered. What I've seen in my experiments was always the section >element.

[armin]

I've posted this bug to Sparx. They will correct it.