Sparx Systems Forum

Enterprise Architect => General Board => Topic started by: priyakubher on March 21, 2005, 11:50:33 am

Title: Documentation
Post by: priyakubher on March 21, 2005, 11:50:33 am

Hi,

I am having some trouble with documentation and was wondering if anyone had any suggestions. Here is the prob.

1. I create a .rtf document from  my EA model. I read that i could create a master .doc filethat has bookmarks from this .rtf and which I could edit to suit my desired report format.

2. So I open a new word document do insert/file and in the range I type the bookmark that I got by right clicking my package name, choosing documentation and then copy rtf bookmarks to clipboard.  

3. A document is generated but any time I regenerate the .rtf file the change is not reflected in the .doc file

4. The update automatic links at open box under tools/options/general is checked.

What am I missing. Please advise.

Thank you,
Priya

Title: Re: Documentation
Post by: thomaskilian on March 22, 2005, 01:05:34 am

Not that I know the solution but try select all (CTRL+A) and refresh (F9) to force updating links and references.

Title: Re: Documentation
Post by: Tjerk on March 22, 2005, 01:15:36 am

Insert file works only once! You need to use the Master / subdocument document feature from MS Word. Search help of MS Word for details. You see options when turning on the Master view (see View menu). See:
http://www.sparxsystems.com.au/cgi-bin/yabb/YaBB.pl?board=general;action=display;num=1109136230;start=1#1

Greetz,
Tjerk

Title: Re: Documentation
Post by: priyakubher on March 22, 2005, 06:56:32 am

Thanks Tjerk,

This solution works. But there is a problem with it. After I update the EA model, the diagrams in the master word document do not show up. Just an icon where it is mean to be. Why is that?

Another problem I am having with documentation is that the diagrams all have Figure 1: XXX as the description. How do I change  the numbering for the figures?

I would appreciate any suggestions.

Priya

Title: Re: Documentation
Post by: Tjerk on March 23, 2005, 12:43:02 am

Figures in a master document are not updated, only figures in a subdocument. Be carefull, MS Word tries to change the extension from RTF to DOC when you save the masterdocument with the subdocuments visible (asks something like change format, need to answer no!). After that change, your subdocuments point to the DOC and not to the RTF generated by EA.

Updating figure numbers: open masterdocument and make subdocuments visible (shortcut Ctrl-\), then Select all (Ctrl-A) and Update fields (F9).

Title: Re: Documentation
Post by: priyakubher on March 29, 2005, 01:27:58 pm

 Cool Thanks,

I was just facing that exact same issue  ;D

Priya

Title: Re: Documentation
Post by: slavko on March 29, 2005, 04:26:06 pm

I have done exactly what Priya is doing without any problems.  Are you sure you are selecting "Insert as Link" on the insert button pulldown command.  This button is an intersting control it allows you to the insert or a pulldown to change the insert to an "insert as link"