Create report using model document

[Manolo33]

Hi and thanks in advance

I have a model created in ea version 6.1.

Here is the thing I would like to create some documentation, using a rtf template of:

a Use case included in a package.
a use realization included in another package.
and (and here comes the deal) the classes that are used in them

The classes are created in packages but they have more classes than the ones used in the diagrams ...

To generate the documentation, I was using <<model documents>> and drag and drop in all the packages required .... but it is hard to have a large amount of classes that don´t belong to that use-case ...

Is there any other solution, other than creating a package for each class, so that I could get those three elements.

Thanks again.
Best, Manolo

[Jan ´Bary´ Glas]

I am not sure what your diagrams consist of, so both may suit you:
A) If you have all classes on the diagram - use a checkbox Document each contained element in RTF
OR
B) At RTF Generator (the bigger one) thick Document linked elements

[Manolo33]

Ok, first I have everything in different packages:
'use case A' under Package 'A';
'use case realization A' under Package 'use case realization A';
'clases for use A' under Package 'Clases' which contains a lot of classes not only for package A;

In order to generate documentation I created another package (let´s call that the 'Doc' package)where I add a 'model document'. That 'model document' has three attributes package 'A', 'use case realization A' and package 'Classes' but that´s mad ...  too much documentation ...

I have a sequence and a Classes diagram in package 'use case realization', I also check the option of the diagram: 'Document each element in RTF' and generated the documentation again but it just added the diagram and nothing else. (I was executing the documentation from the 'model document' in the 'Doc' package ...

I show your second option but I don´t know but is that all about.

Hope that could give you more information ...

Thanks...

[jbatista]

I'm using EA version 6.5.802, and i experienced some documentation issues in RTF document when my elements or diagram notes are empty.

Try to put some dummy descriptions on notes of diagram and elements (all that u want to export in your template).

Hope this helps...

[«Midnight»]

There is an option to Hide notes-less elements in RTF documents. The option is easy to find in the legacy generator, but is tucked away on the File | Document Options dialog when editing a template in the new generator. You'll first have to copy a template to get to this dialog.

By default this option is not checked (i.e. elements without notes should be documented). Still, make sure you've got it turned off in your case.

There is also an option to include elements from 'foreign' packages (i.e. defined outside of the package you are documenting). I don't remember where this is found in the current EA version (I rarely use the built-in document gereration). If memory serves this option is not set by default, so foreign elements are not documented. The working assumption is probably that they will be documented in their own package.

[Perhaps] Since you are using elements that were defined in the template package, they will be foreign elsewhere. Thus, they would not show up unless you checked this option. Track it down and change the setting.

Please let us know what happens, if anything.

David