Author Topic: TOC in Master Document does not work  (Read 6938 times)

pocketom

  • EA User
  • **
  • Posts: 97
  • Karma: +0/-0
    • View Profile
TOC in Master Document does not work
« on: October 23, 2010, 04:50:48 am »
I added a title page and a TOC to my master document template. The TOC is not generated, also no model documents are included if a TOC is present in master page.

One of the many RTFGenerator bugs?

Fred Bevan

  • EA User
  • **
  • Posts: 46
  • Karma: +0/-0
    • View Profile
Re: TOC in Master Document does not work
« Reply #1 on: October 23, 2010, 05:38:55 am »
I had a bit of trouble with that too. Rather than take the time to figure out the reason for the problem I modified a copy of one of the Sparx samples that was working.

Hopefully someone will have a better answer but in the mean time, this should give you a way to create the report.


pocketom

  • EA User
  • **
  • Posts: 97
  • Karma: +0/-0
    • View Profile
Re: TOC in Master Document does not work
« Reply #2 on: October 23, 2010, 06:11:29 am »
Tried that too. At the beginning it worked, but than the trouble started here too. I just used the regular functions, no hacking or something else. Even reinstalling EA didn't bring it back. Trying older/newer versions also not. If this crap is burnt-in once in your model, it's there.

Unusable, sorry.

Here some citements from EA's marketing team:


"Creating a Rich Text Format (RTF) document is a simple and flexible process. "
http://www.sparxsystems.com/uml_tool_guide/reporting_in_enterprise_architect/createarichtextdocument.htm

"Producing high quality documentation in Enterprise Architect is simplicity itself. Documentation can be produced in the MS Word compatible .RTF format in a matter of seconds or minutes, with a simple procedure."
http://www.sparxsystems.com.au/resources/rtf/rtf_generation.html

Parody. Pure parody. (Of course I'm just too stupid)

skiwi

  • EA Expert
  • ****
  • Posts: 2081
  • Karma: +46/-82
    • View Profile
Re: TOC in Master Document does not work
« Reply #3 on: October 26, 2010, 12:43:43 pm »
I feel your pain. And I think the documentation you quote is hopelessly optimistic.

A couple of notes that may help though.

If all else fails exporting to word (ie a very recent version), making the changes, and then importing back over may help.

Document generations is very very sensitive to minute variations in styles.
I'm note sure if it is a bug in Word or EA, but each model document includes its own styles (from the template), and Word accepts this, even if the styles have the same name.

IMHO EA should only generate the styles once for a document. (and take the first instance of a style where they differ).

You may get good mileage by being pernickety and ensuring all your templates are based on exactly the same normal.rtf, and have exactly the same styles defined in them. (Note this may be humanly possible, but probably is neither simple or flexible)
Orthogonality rules
Using EA16.1 (1627) on Windows 11 Enterprise/64 bit. Repositories in SQLServer2019 DB Schema 1558.
WebEA on Pro Cloud Server 4.2.64

pocketom

  • EA User
  • **
  • Posts: 97
  • Karma: +0/-0
    • View Profile
Re: TOC in Master Document does not work
« Reply #4 on: October 26, 2010, 08:35:18 pm »
Right, that's exactly my experience. I tried to create all documents from the Normal.RTF, but what if you want to change a certain style? As I wrote in another thread, the functionality 'reloading all styles from Normal.RTF' does also not work properly.

So, do I really have to recreate all templates from scratch once I want to change a global style element? In general, how should this cope with UML philosophy in general?

Anyway, I still don't know how to put a TOC at the beginning of a (master) document so that all model document content below (>1 model documents...) integrates into the same TOC which is located at at the beginning of the output document (or is this usecase about to be unusual)

skiwi

  • EA Expert
  • ****
  • Posts: 2081
  • Karma: +46/-82
    • View Profile
Re: TOC in Master Document does not work
« Reply #5 on: October 27, 2010, 08:24:52 am »
Re ToC, this is a known bugfeature, where the ToC appears to get dropped if the template in which it is declared does not have at least one 'heading' style.
(tried to find a reference for this but failed, - but a number of forum posts on ToCs)
You might find this useful.
Orthogonality rules
Using EA16.1 (1627) on Windows 11 Enterprise/64 bit. Repositories in SQLServer2019 DB Schema 1558.
WebEA on Pro Cloud Server 4.2.64

pocketom

  • EA User
  • **
  • Posts: 97
  • Karma: +0/-0
    • View Profile
Re: TOC in Master Document does not work
« Reply #6 on: November 16, 2010, 08:53:04 pm »
OK, thanx! So I need to add a heading and format it with #FFFFFF color to make it invisible on white ground... stupid, but simple. Or I format the "Table of Contents" Header above the TOC itself with a heading. Not very convincing, but working for now.

Happy

  • EA User
  • **
  • Posts: 55
  • Karma: +0/-0
    • View Profile
Re: TOC in Master Document does not work
« Reply #7 on: November 17, 2010, 01:34:48 am »
I myself encountered similar problems and ended up always to use a working EA Template for my purposes.

But to add at least one chapter to the master is required by our company templates, luckily.

However using master templates can get very frustrating.

Actually we still haven't found "our way" through to a stable rtf template workflow.

Cheers,
H.

AlanT

  • EA User
  • **
  • Posts: 66
  • Karma: +0/-0
    • View Profile
Re: TOC in Master Document does not work
« Reply #8 on: November 17, 2010, 02:27:10 pm »
My TOC, which once worked, is always generated incorrectly now.  I have to right click and update it every time.  Not sure how that happened!

              Alan

Happy

  • EA User
  • **
  • Posts: 55
  • Karma: +0/-0
    • View Profile
Re: TOC in Master Document does not work
« Reply #9 on: November 17, 2010, 05:44:49 pm »
Are you using master and document templates?
Or just a document template?

Maybe you've changed the style of one of the headings inconsistently over your template(s), thats one of the reasons for a corrupt TOC.

AlanT

  • EA User
  • **
  • Posts: 66
  • Karma: +0/-0
    • View Profile
Re: TOC in Master Document does not work
« Reply #10 on: November 17, 2010, 10:55:29 pm »
   I`m using a document template.  I`ll have to check into that.

   What is a master template, anyway?  Is that for combining multiple documents?

                   Thanks, Alan

Happy

  • EA User
  • **
  • Posts: 55
  • Karma: +0/-0
    • View Profile
Re: TOC in Master Document does not work
« Reply #11 on: November 17, 2010, 11:31:52 pm »
With a master document you can combine several model documents to be generated into on RTF.

For each model document you can specify individual template.

For the master document you specify a master template, wich overrides the other templates in case of styles, header, footer and page layout.

That's the theory.

pocketom

  • EA User
  • **
  • Posts: 97
  • Karma: +0/-0
    • View Profile
Re: TOC in Master Document does not work
« Reply #12 on: November 19, 2010, 03:44:43 am »
Code: [Select]
However using master templates can get very frustrating.

Actually we still haven't found "our way" through to a stable rtf template workflow.
Exact the same situation for us! The sad thing is that the management will perhaps drop EA out of our projects - or even limit the scope it can be used for. At the end documents that are accessible for all stakeholders matter, even if your use-cases and entities and all the stuff is modelled very nicely. If you can read it only with a specialist tool or export too much manually, it's worth more or less nothing.  :'(

Happy

  • EA User
  • **
  • Posts: 55
  • Karma: +0/-0
    • View Profile
Re: TOC in Master Document does not work
« Reply #13 on: November 24, 2010, 08:22:17 pm »
Actually we just found a proper solution.

Will use the Master template approach of EA from now on only to create a structured RTF with the model element documentation.
The style is almost complying with our standards. As far as we can go with EA without spending too much  and useless efforts:
things like TOC or Table of Tables are skipped now within EA, even we can ignore the Times New Roman font or any other problems ocurring when trying to create a special table layout


Afterwards this generated rtf is imported to a Word document and its contents are formatted to comply with our document standards by a simple bunch of word macros.