Book a Demo

Author Topic: Option meaning  (Read 4275 times)

enjoySparx

  • EA Novice
  • *
  • Posts: 15
  • Karma: +0/-0
  • ...We Should be pleased that if you would...
    • View Profile
Option meaning
« on: March 03, 2008, 09:47:34 pm »
Hi All,
do you know if is there a manual explainig the meaning of each option inside the context area generated by RTF generator???
For example, between diagram> ... diagram<...

Thanks in advance...

Oliver F.

  • EA User
  • **
  • Posts: 573
  • Karma: +2/-1
  • Aren´t we all in the model business ?
    • View Profile
    • Karl Storz homepage
Re: Option meaning
« Reply #1 on: March 03, 2008, 10:00:05 pm »
Quote
Hi All,
do you know if is there a manual explainig the meaning of each option inside the context area generated by RTF generator???
For example, between diagram> ... diagram<...

Thanks in advance...

You mean besides that one here:
http://www.sparxsystems.com/downloads/whitepapers/Working_with_the_RTF_generator.pdf ?

Not that I know of.

Oliver

enjoySparx

  • EA Novice
  • *
  • Posts: 15
  • Karma: +0/-0
  • ...We Should be pleased that if you would...
    • View Profile
Re: Option meaning
« Reply #2 on: March 03, 2008, 10:10:47 pm »
I read deeply "working with rtf.." and i went fast using rtf generator... but unfortunatly this document did not explain a lot of little details!!! For example for each tag the list and the meaning of each related option...

Oliver F.

  • EA User
  • **
  • Posts: 573
  • Karma: +2/-1
  • Aren´t we all in the model business ?
    • View Profile
    • Karl Storz homepage
Re: Option meaning
« Reply #3 on: March 03, 2008, 11:14:46 pm »
Quote
I read deeply "working with rtf.." and i went fast using rtf generator... but unfortunatly this document did not explain a lot of little details!!! For example for each tag the list and the meaning of each related option...

I am not sure whether I can see your issue because I found them pretty self explanatory.

Can you give a few examples so we can try to elaborate the meaning ?

Regards,

Oliver

enjoySparx

  • EA Novice
  • *
  • Posts: 15
  • Karma: +0/-0
  • ...We Should be pleased that if you would...
    • View Profile
Re: Option meaning (intuition is not an answer)
« Reply #4 on: March 03, 2008, 11:51:19 pm »
In my opinion, there should be a section (paragraph or something else...) in document "working with rtf..." explaining for each bracketed Section  the option generated with a mouse right-click. Foe example, if i made a right-click between a section source>element> ... <element<source i obtain following choices ...Abstract, Alias, Author, ...,Type, Version, valueOf. Which is the meaning of non intuitive options (for me)??? Where can i find a little practical example for each one??? Thanks a lot!!! By

Oliver F.

  • EA User
  • **
  • Posts: 573
  • Karma: +2/-1
  • Aren´t we all in the model business ?
    • View Profile
    • Karl Storz homepage
Re: Option meaning (intuition is not an answer)
« Reply #5 on: March 04, 2008, 12:55:40 am »
Quote
Foe example, if i made a right-click between a section source>element> ... <element<source i obtain following choices ...Abstract, Alias, Author, ...,Type, Version, valueOf. Which is the meaning of non intuitive options (for me)??? Where can i find a little practical example for each one??? Thanks a lot!!! By

Most of the attributes are the 1:1 representations of their corresponding counterparts in the elements properties dialog.
As to your examples, Author is the author, Alias the alias, Abstract returns true if the element is an abstract element, Type is ... well guess what..., the same applies to Version and valueOf is the specific value of a tagged value.

So it is always worth considering the properties dialog of the element for which documentation has to be generated.

Oliver

«Midnight»

  • EA Guru
  • *****
  • Posts: 5651
  • Karma: +0/-0
  • That nice Mister Grey
    • View Profile
Re: Option meaning
« Reply #6 on: March 04, 2008, 01:36:57 am »
Try exporting a (small) package to XMI. Now read through the output and you will see most of the things you see in the RTF stuff. The actual name and format might differ slightly, but you'll quickly get the idea.

I know this is a far cry from documentation, but at least it should get you moving forward. And even if you can get Sparx to document the RTF engine, it could be a long wait.

HTH, David
No, you can't have it!