Sparx Systems Forum
Enterprise Architect => General Board => Topic started by: MBO on May 27, 2005, 05:09:27 am
-
In my opinion the RTF document generation capabilities are a big improvement over the older (now legacy) ones.
:)
But the documentation about those new RTF features leaves still something to be desired. >:(
For instance I use the RTF export to create design documentation. I work in the heavily regulated medical industry. Therefore there a stringent requirements what should be documented and how it should be structured (For the insiders FDA 510K)
I need to create a reference list of figures (diagrams) in the RTF report. I am also unable to get the diagrams numbered and get diagram labels into the report.
The basic template has some field definitions, but the seem also not to work.
Does anybody have already some suggestions, or is it to early (5.0 just a week old) to ask such questions ?
-
I find the new WYSIWYG document template editor to be really an outstanding step toward creating perfect documentation with the tool.
It takes a bit of getting used to, but it is pretty powerful.
My only major gripe thus far is that in the Sections window, you cannot repeat elements. For example, if I wanted to re-use a package.name in various places in the document, I cannot -- I have to use it only in one place. It would be very useful to simply drag-n-drop references (GUID) from the model into the WYSIWYG editor. If the model changes, it is automagically updated in the documentation that is generated.
-
Is there a solution to this problem?
I also need a table of figures and can't get EA (5.00.768) to output the info from the RTF template. I'm approaching the problem through their recommended method of creating a master document with embedded subdocuments created in EA.
In the basic template there is a field {Diagram.Figure} which isn't a choice when right-clicking. Sadly it still outputs nothing when the document is generated.
Any help would be much appreciated!
-----------------------
*** LATEST ***
-----------------------
In case anyone is interested, I received the following in reply from Sparx support:
The figure numbering for diagrams was implemented early on but removed due some problems we encountered with third party software. We will look into adding it again some time after the release of Version 6.0.
I hope this is of help.
Best regards,
Etc..
-
Has anything happened with the table of figure issues and figure numbering. So far I haven't found a way, however roundabout, to do this. Inserting SEQ-fields in the template doesn't work either.
Any solution?
I'm using EA version 6.1.790.
-
I eventually gave up with the RTF document generation which was not flexible enough for our use.
Instead I (re) taught myself VB, took a crash course in Word automation and wrote a small program to output what I wanted!! I have to say it was much easier than I expected and more than made up for the time I wasted with RTF! :P
Sparx have a good example here http://www.sparxsystems.com.au/resources/developers/autint.html which I took and butchered to do what I needed. Bearing in mind it had to be to a military standard template it is very flexible.
Good luck!
-
I do just the same, except I use PERL. This way it's indeed very flexible!
-
> I do just the same, except I use PERL. This way it's indeed very flexible!
Many years ago, when I were using Rational Rose, we used VB in Word to generate the documentation. Eventually we started to use Rational SoDA and I must say that was an improvement. The documentation "scripts" were much easier to maintain.
VB doesn't really make my day anymore, but I'm looking for an excuse to learn Perl. Could you say a little bit more about how you use Perl here, and if you really feel generous :) share some of the code if you aren't restricted by company policy or something like that. I would really be grateful.
-
I'm currently rather busy :( But as far as I remember I published something on the EA Usergroup site (see the Automation board). I have done a lot more in the meantime and will publish more as soon as time permits. Feel free to ask at any time. Up til now I had time for short answers at least.