Author Topic: RTF documentation - include external elements?  (Read 2300 times)

Dave_Bullet

  • EA User
  • **
  • Posts: 295
  • Karma: +0/-0
    • View Profile
RTF documentation - include external elements?
« on: July 24, 2006, 04:29:28 pm »
Is there a way of getting EA to include the descriptions / properties of elements that are included on diagrams, but located externally to the package where the RTF is being generated from?

Our repository has a re-use model and project model as shown:

- Re use model
     - Re-use elements...
- Project model
     - Project A
     - Project B
            - Project B diagram (includes Project B elements + re-use model elements)
            - Project B elements
   
Each project will have a project view.  New elements can be added under the project view for a project, but project staff can re-use elements from the re-use model (ie. a Login use case etc...).

When the project people go to generate their project documentation - they want a "complete" document - where every element used in a diagram is described - regardless of the package it is located in.

The problem we have is all new project elements get described (since they are contained within a package under the project) - however elements re-used from outside the project are not included.

I've tried using model documents - but that requires the author to know / find each external package to include.  I'd like EA to be able to intelligently do a "deep" traversal on document generation

Can the above be done?

Thanks,
David.
« Last Edit: July 24, 2006, 04:34:09 pm by Dave_Bullet »
"I know I'm close to a good design, but it's like the balloon animals, squeeze in one spot and the problem moves down the line"

alesliehughes

  • EA Administrator
  • EA User
  • *****
  • Posts: 104
  • Karma: +0/-0
    • View Profile
Re: RTF documentation - include external elements?
« Reply #1 on: July 24, 2006, 08:51:14 pm »
Check the option "Document each contained elements in RTF" in Diagram Properties.

Alistair

Dave_Bullet

  • EA User
  • **
  • Posts: 295
  • Karma: +0/-0
    • View Profile
Re: RTF documentation - include external elements?
« Reply #2 on: July 24, 2006, 09:10:19 pm »
(Gee - you EA chaps have thought of everything haven't you!)

Thanks Alistair - exactly what I was after.  Works like a charm!  Appreciate the fast reply too (you guys have brilliant support)!

Can't believe I missed that setting.  

Cheers,
David.
"I know I'm close to a good design, but it's like the balloon animals, squeeze in one spot and the problem moves down the line"