Book a Demo

Author Topic: Documentation  (Read 4220 times)

paulinjm

  • EA Novice
  • *
  • Posts: 10
  • Karma: +0/-0
    • View Profile
Documentation
« on: October 06, 2004, 06:51:32 am »
I am trying to create an RTF format documentation of screens I made in EA - the only issue I am running into - if I have more than 1 screen in  a package, the screens are printed out first, and then the documentation behind those screens - I was hoping that the documentation would follow each screen rather than after the package - am I missing an option??  Or is this how it is?

Thanks
Jason

Rollie

  • EA User
  • **
  • Posts: 22
  • Karma: +0/-0
    • View Profile
Re: Documentation
« Reply #1 on: October 07, 2004, 11:20:50 am »
When you say screens, do you mean diagrams? I have the problem with element details not appearing directly after a diagram, when there are multiple diagrams in a package.  I would like to see the elements listed after each diagram.

Bruno.Cossi

  • EA User
  • **
  • Posts: 803
  • Karma: +0/-0
    • View Profile
Re: Documentation
« Reply #2 on: October 07, 2004, 05:06:38 pm »
That might be a bit problematic as an element can appear on multiple diagrams.

Quote
When you say screens, do you mean diagrams? I have the problem with element details not appearing directly after a diagram, when there are multiple diagrams in a package.  I would like to see the elements listed after each diagram.


Rollie

  • EA User
  • **
  • Posts: 22
  • Karma: +0/-0
    • View Profile
Re: Documentation
« Reply #3 on: October 08, 2004, 06:35:02 am »
That helps me understand why they have it formatted that way.  For most diagram types it makes sense, because all elements should be uniquely named.  For diagrams used to display screen definition it has a bad effect.  If I have 3 screens in a diagram, I may have 3 different Ok buttons that I name Ok so that the screen displays a button with Ok for the button label.  In the element description, it does not specify the screen that each Ok button represents.   It would be nice if a switch could be specified in a diagram so that the screen elements are listed after each screen.  Redundancy would be acceptable for shared elements.   Is anyone aware of any way to accompolish this?

Bruno.Cossi

  • EA User
  • **
  • Posts: 803
  • Karma: +0/-0
    • View Profile
Re: Documentation
« Reply #4 on: October 08, 2004, 07:24:47 am »
Hi,

I see what you are trying to do, but it might be a bit of an overkill.
First of all, you do not need to name an element (button, in your case) using the same text that you wish to appear on the diagram - you can use Alias to specify the display value instead.
Could not you accomplish the desired result by creating a separate package for each of the screen designs? If I well remember, this way you would get a diagram and all of the elements within the same package afterwards.

Bruno

Rollie

  • EA User
  • **
  • Posts: 22
  • Karma: +0/-0
    • View Profile
Re: Documentation
« Reply #5 on: October 08, 2004, 08:53:46 am »
Bruno,

Thanks for the response.  I did try using the alias, but I could not figure out how to get the alias value to appear on the button.  Is there a switch that can do that.  I might have to go with your last suggestion.  I may have to give separate packages a try.  The only draw back that I have with this project is it contains 52 screens.  I may just generate an RTF without the element descriptions for screen signoff, and use the HTML for the developers to reference.

Thanks,
Rollie

Bruno.Cossi

  • EA User
  • **
  • Posts: 803
  • Karma: +0/-0
    • View Profile
Re: Documentation
« Reply #6 on: October 08, 2004, 09:07:58 am »
Hi Rollie,

try Diagram Properites, checkbox "Use Alias if Available"

Bruno

Rollie

  • EA User
  • **
  • Posts: 22
  • Karma: +0/-0
    • View Profile
Re: Documentation
« Reply #7 on: October 08, 2004, 09:15:26 am »
Bruno,

Thanks for the input.  Setting that switch allowed the alias to be displayed.  Now I just have to go through and update my buttons, but I think the resulting documentation will be worth it.

Thanks,
Rollie

Bruno.Cossi

  • EA User
  • **
  • Posts: 803
  • Karma: +0/-0
    • View Profile
Re: Documentation
« Reply #8 on: October 08, 2004, 10:19:05 am »
Rollie,

glad to have helped!

Bruno