Book a Demo

Author Topic: Documentation of RTF documention  (Read 3904 times)

skiwi

  • EA Expert
  • ****
  • Posts: 2081
  • Karma: +46/-82
    • View Profile
Documentation of RTF documention
« on: August 16, 2010, 11:39:10 am »
In the struggle to get artefacts on a diagram to be documented I came across the following help on Diagram properties
Quote
Document each contained element in RTF
 Include documentation on each element in the diagram, in any RTF document generated on the parent package or element.

([highlight]Applies only in the Legacy RTF Report Generator[/highlight]; for the extended RTF Report Generator, use the Generate RTF Documentation dialog.
 
and Generate help
Quote
Include all Diagram Elements in Report
 Include elements in the report from external packages that are referenced from a diagram, for every diagram covered by the report. Defaults to selected. The Package.Diagram.Element or Package.Element checkbox must be selected in the current template.

If external elements are to be included only for selected diagrams, deselect this checkbox and [highlight]select the Document each contained element in RTF checkbox in the diagram properties[/highlight] for each required report.

When both options are deselected, or when neither of the Package.Diagram.Element or Package.Element checkboxes are selected in the template, only elements in the current package are documented.
 

It seems to me that there is a discrepancy between the two  highlighted items.
Orthogonality rules
Position and Team disestablished, thanks austerity.
Now itinerant.

RoyC

  • EA Administrator
  • EA Practitioner
  • *****
  • Posts: 1297
  • Karma: +21/-4
  • Read The Help!
    • View Profile
Re: Documentation of RTF documention
« Reply #1 on: August 16, 2010, 03:36:12 pm »
There is indeed. In the first quote, delete the reference to the Legacy Report Generator (as I have just done). It used to be appropriate, but is not now.

For a more detailed discussion on getting external referenced elements into the report, see the Diagram Options topic here:

http://www.sparxsystems.com/enterprise_architect_user_guide/report_generation/document_options.html

Sorry for the confusion.
Best Regards, Roy

skiwi

  • EA Expert
  • ****
  • Posts: 2081
  • Karma: +46/-82
    • View Profile
Re: Documentation of RTF documention
« Reply #2 on: August 17, 2010, 07:46:56 am »
ta

I think it is time to deprecate and hide references to the Legacy report generator, and perhaps in EA itself remove options relating to it unless specifically enabled in global options.
« Last Edit: August 17, 2010, 07:48:34 am by skiwi »
Orthogonality rules
Position and Team disestablished, thanks austerity.
Now itinerant.