Book a Demo

Author Topic: RTF documentation for composite Use Cases  (Read 3210 times)

PrivateGamer

  • EA Novice
  • *
  • Posts: 2
  • Karma: +0/-0
    • View Profile
RTF documentation for composite Use Cases
« on: April 21, 2009, 05:26:19 am »
Hello,

I am quite new to EA so I hope this is not an absolute beginners question: I am trying to generate RTF documentation for a UseCase diagram which contains several composite Use Cases und the respective sub-diagrams in one package. However all I get is the documentation for the main diagram and its components, the sub-diagrams are ignored.

In the documentation the only hint I found is what is called "Virtual Documents", but it does not seem to apply here as it only combines packages. Maybe there is some switch in the "Generate RTF Documentation Dialog" called "include composite diagrams" or something similar I missed?

Thanks for your help, if you can give me any, I am quite stuck here.  :-[

Ingo

PS: I am using EA Desktop Edition

Dermot

  • EA Administrator
  • EA User
  • *****
  • Posts: 591
  • Karma: +7/-0
    • View Profile
Re: RTF documentation for composite Use Cases
« Reply #1 on: April 21, 2009, 12:16:19 pm »
The standard Use Case reports are specificaly set to not recurs through the sub packages.  To set this on - create a copy of the template and in the Editor set the Section: Element::Child Element ON. Also set Element::Diagram ON. Best to leave these both blank.

Oliver F.

  • EA User
  • **
  • Posts: 573
  • Karma: +2/-1
  • Aren´t we all in the model business ?
    • View Profile
    • Karl Storz homepage
Re: RTF documentation for composite Use Cases
« Reply #2 on: April 21, 2009, 06:08:54 pm »
Quote
The standard Use Case reports are specificaly set to not recurs through the sub packages.  To set this on - create a copy of the template and in the Editor set the Section: Element::Child Element ON. Also set Element::Diagram ON. Best to leave these both blank.

Which brings me to the idea of also including composite elements if the "include all diagram elements in report" checkbox and a new "include composites" option are ticked.

That could be worth a feature request...
Comments are welcome.

Oliver

PrivateGamer

  • EA Novice
  • *
  • Posts: 2
  • Karma: +0/-0
    • View Profile
Re: RTF documentation for composite Use Cases
« Reply #3 on: April 22, 2009, 05:39:59 am »
Thanks a lot, Dermot, for your help. It works now as I expected it - at least most of the time. Sometimes adding the Diagram and Child Elements both leads to the effect that the placeholders, such as {Element.Name}, remain in the generated document for all elements. It seems to be connected with the sequence I am adding the sections to the template, but I haven't done too extensive tests so far.

Anyway, I am happy it works now.  :)

@Oliver: Thanks for the suggestion, that was what I had been looking for as a beginner. Changing the template was something I didn't want to do for the first document I created, although knowing what to do I feel a little more confident now.