Book a Demo

Author Topic: RTF Documentation confusion  (Read 4008 times)

reddog

  • EA User
  • **
  • Posts: 26
  • Karma: +0/-0
    • View Profile
RTF Documentation confusion
« on: October 24, 2005, 10:41:17 am »
Hi all,

WARNING: There now follows a bit of a rant over RTF documentation in EA! [EA 772].

In my current project tree I select Business Model (below which live Business Process, Business Use Case Model, Business Domain Model) and then press F8 for Generate RTF documentation.  I enter an output file name, select  {basic template} and then click generate - as I get way too much info I click Switch Generator giving me the RTF Report dialog.

Also I have tried the Generate RTF Documentation - RTF Document - edit (etc) then Generate button but cannot get that to work!

Ok, rant over. Phew...

Any feed back would be welcome (better still a flow chart!!)

Reddog.
Problem1: The RTF Report dialog ignores the previous output filename but if I change its output file name and then click Switch Generator then the previous dialogs filename is then changed! Not good!

Problem2: On the RTF Report dialog I click new (template),    enter a template name, enter a new output filename, click create, view  the document and then save the template.  Now if I close the dialog and open it again the output filename has changed! Not good!  If I load the template again the filename does not change either

Problem3: If, following the above, I click 'save as document', enter a name and save, then quit the dialog I see the 'document name in the resource tree under documents-RTF documents.  OK I double click it, the RTF report dialog opens but still the filename is not correct (ie as I set it above)!!!

Rant: Would it not be clearer for the Generate RTF Documentation dialog to have one output filename for the 'generator' generator and one for the 'RTF document' generator?

Q: Are the options in the RTF report dialog (eg for each object tree) affecting the RTF document template generated file?  

Rant : Maybe a 'flow chart ' (showing main choices, inputs, outputs ) would help here!  And yes I have looked at the help files but I am a slow reader!

Rant: I am getting confused over EA's usage of the words 'document', 'template', 'profile', 'style template' in relation to the RTF documentation dialogs.