Book a Demo

Author Topic: Data Model HTML Documentation  (Read 4873 times)

themitch

  • EA Novice
  • *
  • Posts: 5
  • Karma: +0/-0
    • View Profile
Data Model HTML Documentation
« on: March 01, 2013, 05:12:02 am »
Hi there

I am just trialling EA at the moment and have a quick question regarding the HTML documentation that can be generated.

I have a data model, which I have mostly reverse engineered from my Oracle database. I have tidied up the layout, put some nice coloured boundaries in, added some comments, etc. etc. Then I have generated some HTML documentation so others can reference it.

However, the HTML doc isn't particularly Data Model friendly. Lots of talk of 'Public static' this, and 'Stereotype' that. Is there anyway to supress this? You know, make it a bit more user friendly as a report - remove redundant terms and concepts, etc.?

I realise this is a UML modelling tool, but I would still hope that it can be used for straight forward data modelling, if required.

Thanks in advance.
M

KP

  • EA Administrator
  • EA Expert
  • *****
  • Posts: 2919
  • Karma: +55/-3
    • View Profile
Re: Data Model HTML Documentation
« Reply #1 on: March 04, 2013, 09:17:31 am »
A degree of customization is possible. From the main menu go Project > Resources (Alt+6) to open the Resources view, under "Templates" right-click "Web Style Templates" and create a new HTML template, and you are free to edit anything you see in the new template. For example, you can open the "Content - Attributes Item" template and remove #SCOPE# and #STATIC# from line 3 and 'Public static' will not be displayed for attributes...
The Sparx Team
[email protected]

Nick Wh

  • EA Novice
  • *
  • Posts: 6
  • Karma: +0/-0
    • View Profile
Re: Data Model HTML Documentation
« Reply #2 on: March 06, 2013, 07:48:26 pm »
Yes, and look at the 'Body - Diagram' web style.  You can comment out or delete parts of this to make it more 'user friendly'.  I only leave the dagram, a 'generated on...' datestamp and notes.  No sterotypes or GUIDs etc. which only serve to confuse business users.

However what I would like is a little more customisation under the object properties - these usually have business relevant information but the webstyle options seem to be more limited / difficult.  Then again, I'm not a web developer. You need someone familiar with style sheets to work with you.

themitch

  • EA Novice
  • *
  • Posts: 5
  • Karma: +0/-0
    • View Profile
Re: Data Model HTML Documentation
« Reply #3 on: April 02, 2013, 08:24:27 pm »
Thanks for the replies. Didn't give me quite the results I was looking for, but still an improvment over the default layout. I will carry on playing with it.