[RTF Doc] RTF Text for each Diagram.

[danielku15]

Hello.
I want to generate a documentation for all diagrams in my project. My problem is, that I want to add some RTF descriptions to each of my diagrams (not only notes) that it looks like this:

package>
1. Overview {Pkg.Name}
diagram>
{Diagram.RtfDescription}
{Diagram.Notes}
{Diagram.DiagramImg}
<diagram
<package

And in my RTF Description I want to add texts like this:

1.1 Diagramtitle
Some diagram description with a lot of information and formatting.

Combined, should it become a result like this:

1. Overview Package01
1.1 Diagram01
This diagram describes how to....
[IMG]
1.2 Diagram02
This is the class diagram to implement the features of Diagram01
[IMG]
2. Overview Package02
....

Is this possible? My idea was to add a "Document"-Element to each Diagram which contains the RTF Description. But I do not know if it's possible / how to include only the Contents of the "Document"-Element in the RTF file.

Any ideas how to solve this problem?

Greets Daniel

[Oliver F.]

Is this possible? My idea was to add a "Document"-Element to each Diagram which contains the RTF Description. But I do not know if it's possible / how to include only the Contents of the "Document"-Element in the RTF file.

Unfortunately you can not assign a linked document to a diagram and even if you could the templates do not allow to print it in the RTF documentation.

So the diagram notes to describe the diagram might be an alternative. Those give you basic formatting features, but maybe this is not enough for your purpose.

The approach of having a document artefact with a linked RTF document in it would work if you accepted that the description is generated after the diagram because you can not order elements before diagrams in the model.
And even worse, some model elements have their own sort order which eg. means that artefacts are sorted below activities and do not move up whatever you do.

Oliver

[danielku15]

An how is it about the package order? Are packages printed alphabetically , as they are sorted in the repository or in the project tree. I've got an idea to solve my problem, but I neet a specific order for my packages / modules. Probably add a number to the package name for sorting.

[Dermot]

Tree order is set by default, this is alterable in the RTF editor: File | Document Options.
As it is the packages that you want to order - if you want a user-defined order - look at using a "Virtual Document" to set this up.  See Help | Search | "Virtual Document"