Reporting

[HeadOffice]

What's an easy way to get a complete report from EA?
I'd like to get multiple pages with all diagrams and then a breakdwon of all objects and their attributes.

[jaimeglz]

Hi HeadOffice!

I know of three ways of doing it, which have been posted in this forum:

1. Use the standard RTF generator, and polish the document with Word Macros (see Sept. 11, 2002 posting by PhilR on "Creating Proffessional Documentation").

2. Use the RTF template shipped with EA (see posting by moto_b, same day, same topic; see also posting by gsparks, Aug 9 2002, "Heading levels in RTF documentation").

3. Arrange your packages in your project tree in the same order you want them to appear in your documentation. Move all your classes to a package (or to a limited number of packages) under a single package in the project tree: they can be at the end, which is the place you want them. (See my posting July 29 2002 "EA's documentation features...").

I use the third alternative, and I can produce RTFs quite quickly; however, this is not the way recommended by Sparx (see gspaks posting on Aug 8, "Page numbers in RTF...").

I would encourage you to read previous discussions on this at the forum: do a search for "Documentation".

Jaime Gonzalez

[HeadOffice]

Jamie,
Yep - going to have to search forums. Reports are not that intuitive (at least from the Help).

Thanks...

[jaimeglz]

I agree... if what you are trying to achieve is high quality documentation.

But if all you want to do is generate general-purpose documentation, try right-clicking at the root package of your project tree and choosing Rich Text documentation. Although the RTF documentation generation dialog has lots of options, only "Output Filename" is really critical.

Try also the HTML generator on specific packages: its great for publishing metadata in your LAN.

I'm sure you will become familiar with the different options as you advance in your project.

Jaime