Book a Demo

Author Topic: Clean HTML report template  (Read 7404 times)

j-col

  • EA Novice
  • *
  • Posts: 5
  • Karma: +0/-0
    • View Profile
Clean HTML report template
« on: October 04, 2010, 08:37:02 pm »
I use Enterprise Architect for reverse-engineering URL class diagrams from my source code, and want to take this a step further by using the software to generate HTML API documentation of my code.

However I find the markup generated by Enterprise Architect to be full of scripts, some of which do not seem to work too well on Firefox. Want I want is a clean HTML-only template that I can use to produce simple markup that will work fine in all browsers.

I have tried to manually create this template using the template editor in Enterprise Architect 8, but find this cumbersome.

Does anyone know of an existing template I can use, or an easier way to generate a template without using the built in template editor?

Sunshine

  • EA Practitioner
  • ***
  • Posts: 1353
  • Karma: +121/-10
  • Its the results that count
    • View Profile
Re: Clean HTML report template
« Reply #1 on: October 05, 2010, 06:38:17 pm »
You haven't mentioned what programming language you are trying to document but it sounds like you'd be better off using something equivalent to javadoc or ndoc (in .net world) as these were specifically designed for such a purpose.

http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html
http://ndoc.sourceforge.net/
Happy to help
:)

j-col

  • EA Novice
  • *
  • Posts: 5
  • Karma: +0/-0
    • View Profile
Re: Clean HTML report template
« Reply #2 on: October 05, 2010, 07:40:33 pm »
I'm using PHP, so could use phpDocumentor to get good results, but those HTML documents won't include the class diagrams from Enterprise Architect which I would have to add in manually later.

I'd much prefer to work within Enterprise Architect exclusively (it's already doing a good job of pulling out my class/method documentation comments from the code), I just need it to produce clean HTML.

Eve

  • EA Administrator
  • EA Guru
  • *****
  • Posts: 8110
  • Karma: +119/-20
    • View Profile
Re: Clean HTML report template
« Reply #3 on: October 06, 2010, 08:26:16 am »
I would recommend using the automation interface to generate your HTML if you are wanting a structure with significant differences to what EA generates by default.

j-col

  • EA Novice
  • *
  • Posts: 5
  • Karma: +0/-0
    • View Profile
Re: Clean HTML report template
« Reply #4 on: October 06, 2010, 07:32:06 pm »
Thanks Simon, can you point me in the right direction in terms of where I should be looking in the menu system for the automation interface to generate the HTML?  I'm using EA 8.

Geert Bellekens

  • EA Guru
  • *****
  • Posts: 13523
  • Karma: +574/-33
  • Make EA work for YOU!
    • View Profile
    • Enterprise Architect Consultant and Value Added Reseller
Re: Clean HTML report template
« Reply #5 on: October 06, 2010, 07:42:05 pm »
I think Simon means: write a HTML generator using the API of EA to query the model.

Geert

j-col

  • EA Novice
  • *
  • Posts: 5
  • Karma: +0/-0
    • View Profile
Re: Clean HTML report template
« Reply #6 on: October 06, 2010, 07:59:30 pm »
Okay that makes sense Geert, I'm unfamiliar with this API though so would appreciate some guidance here.  Is the documentation available online or within the EA help system?

Its sounds like this could be a lot of work for me, but I am a programmer so am not afraid to take it on if I can find some good examples to follow and expand upon.

j-col

  • EA Novice
  • *
  • Posts: 5
  • Karma: +0/-0
    • View Profile
Re: Clean HTML report template
« Reply #7 on: October 06, 2010, 08:11:11 pm »
Okay I found it myself, will look into this and see if I can modify it for my needs:

http://www.sparxsystems.com/resources/developers/autint_vb.html