Book a Demo

Author Topic: generate documentation  (Read 4340 times)

utilisateurEA

  • EA User
  • **
  • Posts: 57
  • Karma: +0/-0
    • View Profile
generate documentation
« on: April 22, 2010, 01:11:51 am »
Hello,

I'd like to generate a documentation from my EA project.
The problem is that my documentation is really long because I display a lot of useless properties, because in some cases I need to read a property and for others I need a different property.

So my question is : is it possible to create a condition (like if /else) in the xml-like template editor ?
For example if my Stereotype is A then I’d like to display the attribute whereas if my Stereotype is M then I need to display the method of the element.

Thanks

Geert Bellekens

  • EA Guru
  • *****
  • Posts: 13523
  • Karma: +574/-33
  • Make EA work for YOU!
    • View Profile
    • Enterprise Architect Consultant and Value Added Reseller
Re: generate documentation
« Reply #1 on: April 22, 2010, 04:33:02 pm »
There's a whole bunch of things you can do with the RTF template.
Search the forum for RTF+template and you should get thousands of posts.

Geert

utilisateurEA

  • EA User
  • **
  • Posts: 57
  • Karma: +0/-0
    • View Profile
Re: generate documentation
« Reply #2 on: April 22, 2010, 05:30:11 pm »
I've already searched in the forum, I could find interesting things like the possibility to add filter.
But it is not exactly what I am looking for because a filter is applied on the entire document whereas I would like to apply it for a restricted part (exactly like a if/else condition, but maybe it is possible with filters ?).

Happy

  • EA User
  • **
  • Posts: 55
  • Karma: +0/-0
    • View Profile
Re: generate documentation
« Reply #3 on: April 22, 2010, 06:30:52 pm »
Using Filters may be the method to achieve your desired goal.

Combined with
  • using a master document and subsequent model documents,
  • you can create one model document with a Search for your Stereotype A and
  • one model document with a search for you stereotype M.
  • Using two different rtf templates you can then display the attribute for one search and the method for the other.
However, you end up with having one group of elements of Stereotype A and one group of elements of Stereotype M in your document.

Cheers,
H.


utilisateurEA

  • EA User
  • **
  • Posts: 57
  • Karma: +0/-0
    • View Profile
Re: generate documentation
« Reply #4 on: April 22, 2010, 08:01:28 pm »
That's true it's a good idea.
But I have to do this for more properties and I'm afraid the merge operation would be too hazardous.
Do you know if xls code is read by the RTF template ? I could'nt find anything about this and my attempt was a fail. It could be a soluttion if it worked ?

Happy

  • EA User
  • **
  • Posts: 55
  • Karma: +0/-0
    • View Profile
Re: generate documentation
« Reply #5 on: April 22, 2010, 10:31:25 pm »
The RTF report generator of EA is designed specifically to interpret highly EA-specific templates to generate higly EA-specific RTF files.

I never tried to import xls-code. But I think this will not work.

Even a simple roundtrip of export template to rtf, edit it with MS Word, import template again will lead to a certain amount of work to get it working again!

Sorry Sparx, just my two cents!
H.