RTF document

[mikaeel]

Good Day,
I am using EA 7.1.  I have a package with only a class model in it.  The classes used in the model are residing in various other packages.  I want to generate a document with the model and description of all the classes and attributes used in the model.  I also want to use a template I've created for the layout of the document.
So, on the package, I hit F8.  I get the "Generate RTF Documentation" screen.  However, I can't use this generator because this generator does not give the option to document the classes from the other packages.
So, I switch generator and can have the option to document all elements.  But, the problem now is that I can't apply my document template that I see under RTF Style Templates in the Resources View.
I am confused at the template options for both the generators.  Wht the difference.
Why can't I create a document that includes related classes (from other packages) and at the same time allow me to use my RTF Style template.
Also, the two generators are very confusing.  The one generator is titled "Generate RTF Documentation."  The other one is titled "Rich Text Format Report".  They both have a template option, but a different list of templates.  How do I intepret this? :-/

[Eve]

Basically, the generator you see by default was added a while back because it is based on a more user friendly template system.  The other generator was kept primarily for people who already had working templates in the old system.  There are differences between the two, but I don't know exactly what they all are.

If you want to generate the elements outside your package (that are appearing on diagrams in your package you can insert the Diagram | Element region.

[Dermot]

Hello Mikaeel,
As Simon stated, it is best to use the new generator rather than the legacy generator.  There are options in the new generator to report on Elements External to a package.  I would suggest you download the whitepaper on RTF report generation and look at the section:
Reporting on Diagrams with Elements from Other Packages -p20.
For access to the whitepaper see:
http://www.sparxsystems.com.au/resources/whitepapers/index.html

[RoyC]

This is also in the Help (Creating Documents > RTF Documents > Generate RTF Documents > Diagram Options - look at the Document Each Contained Element in RTF section).

One point that wasn't clear (but I have updated the Help to make it so, for the next release of EA) is that you have to use your own customized template to include the 'external' element descriptions. You have to modify the template to enable a document section, and you cannot edit a system-supplied template. This is true whether you are using the recommended Extended RTF Generator, or the old Legacy RTF Generator.

[mikaeel]

Hi Simon M, Dermot, RoyC
Thanks very much.  This has solved my problem.
I totally missed the "RTF Document Options" appearing on the Diagram properties dialogue.  I think this option should be visible on the RTF Document dialogue, under the "Advanced" tab.

One more question: I followed the instructions as on section 5 in the whitepaper.  I noticed that the columns of the contained elements are also documented, which is what I want.  However, for these columns, I want to be able to choose which properties appear i.e. I only want the name and notes to appear.  How do I do this?

[Dermot]

If the template you are using is a System template ie {basic Teplate} - create a copy of the template (see the whitepaper) and edit the copy to remove the fields for {...Name} and {...Notes}.

[mikaeel]

Thanks,
I figured out how it works.  Basically, the element section that is within the diagram section must be blank.  Then make changes to the Attribute section that is within the Package Element section.  These changes will also apply to the Element section within the Diagram section:
package >
   diagram >
       element >

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

attribute >
{Att.Name}      {Att.Notes}
< attribute
< element

< package