Author Topic: RTF Documentation - Package Element vs Elements  (Read 1972 times)

Jeff Cantrill

  • EA Novice
  • *
  • Posts: 9
  • Karma: +0/-0
    • View Profile
RTF Documentation - Package Element vs Elements
« on: November 04, 2008, 05:44:23 am »
Is there any documentation about the difference between a 'Package Element' and an 'Element' when generating RTF Documentation?    For that matter, is there any documentation regarding the elements you can pull into a template?  Some of them can obviously be mapped to a tab on the properties pane or other assorted field, but, for example, what does it mean to choose a 'model document'?  Is this just another 'element' or 'package element'?

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 - Package Element vs Element
« Reply #1 on: November 04, 2008, 07:23:43 pm »
Quote
Is there any documentation about the difference between a 'Package Element' and an 'Element' when generating RTF Documentation?    For that matter, is there any documentation regarding the elements you can pull into a template?  Some of them can obviously be mapped to a tab on the properties pane or other assorted field, but, for example, what does it mean to choose a 'model document'?  Is this just another 'element' or 'package element'?

The "model element" is the root of the model and contains basic information about the model itself (which is not much- tasks, issues, etc.).

A package (at least in terms of RTF documents) is not an element but treated more like a chapter to separate items.

For a brief information about RTF documentation you can read the whitepaper from Sparx:
http://www.sparxsystems.com/downloads/whitepapers/Working_with_the_RTF_generator.pdf

HTH

Oliver

Jeff Cantrill

  • EA Novice
  • *
  • Posts: 9
  • Karma: +0/-0
    • View Profile
Re: RTF Documentation - Package Element vs Element
« Reply #2 on: November 05, 2008, 01:05:17 am »
Oliver,

I don't mean to sound unappreciative of your response, but it was about as valuable as the whitepaper you directed me to; the one that is also referenced in the help documentation.  The documentation regarding the creation of RTF's is very weak.  It is not obvious at what I will get unless I spend hours generating samples.  Even though the whitepaper is of use for a number of topics, I was hoping that something more existed to further explain EXACTLY what each element does when one clickes the check box.