Book a Demo

Author Topic: Document linked elements in RTF documents  (Read 4276 times)

Jos

  • EA Novice
  • *
  • Posts: 7
  • Karma: +0/-0
    • View Profile
Document linked elements in RTF documents
« on: July 02, 2007, 01:34:24 pm »
I am currently trying to create a RTF template to be used to generate documentation for use case realisations.  Each use case realisation contains one or more sequence diagrams (flow of events) and a view of participating classes (VOPC).  The VOPC is basically a class diagram containing references to classes that are part of one of more packages located outside the use case realisation package.  These 'external' packages contain more classes than are relevant to the use case realisation and I want to include only the relevant classes in the document.

The RTF template generator doesn't appear to allow me to include documentation of these 'external' classes in the document.  I know I could create a 'Virtual Document' to achieve this, but that would include documention of all classes, even the classes that are not relevant to the use case realisation.

The legacy RTF dialog has an "Document Linked Elements" option, which is a handy feature when the classes in a class diagram are located in another package.  It basically does exactly what I want to achieve with RTF templates.  Does anyone know how I can achieve this with RTF templates?


«Midnight»

  • EA Guru
  • *****
  • Posts: 5651
  • Karma: +0/-0
  • That nice Mister Grey
    • View Profile
Re: Document linked elements in RTF documents
« Reply #1 on: July 03, 2007, 02:30:18 am »
No, you can't have it!

Jos

  • EA Novice
  • *
  • Posts: 7
  • Karma: +0/-0
    • View Profile
Re: Document linked elements in RTF documents
« Reply #2 on: July 15, 2007, 05:42:07 pm »
 :) Received some helpful information from the EA support team (thanks Dermot!), as follows:

In the Diagram Properties | Document options tick the option:
 

  • Document each contained element in RTF:

    This sets the RTF generators to include details of elements that are defined  external to the package for this diagram.  This varies between the two RTF generators:

    -      In the old RTF report generator this sets the document to contain the external element details.
     
    -      In the New RTF generator this sets the generator to process this element but it requires that the Diagram::Elements section has been set.

    To create a section to generate the external element details; In the RTF editor  select from the sections area: Package | Diagrams | Element (The standard element details are in Package | Element).

    This will create the following text in the Content section.

    element >
    ...insert Element content here...
    < element

    You can then set this to blank (delete: ...insert Element content here...)to reproduce the layout used in the Package::Element section, or define the layout differently for external elements by adding a detail between Element> and <Element.

    There is a full section covering this in the RTF report generator whitepaper - see:
    http://www.sparxsystems.com.au/resources/whitepapers/