Book a Demo

Author Topic: How to generate a virtual document?  (Read 9263 times)

marcelloh

  • EA User
  • **
  • Posts: 192
  • Karma: +0/-0
    • View Profile
How to generate a virtual document?
« on: December 10, 2009, 04:22:40 am »
I've read "Working with te RTF generator" but I'm missing something.
How to generate this document.
If I press F8, if will ask me about the template I want to use. (And according to the documentation, I configured it so that my master document uses a certain template. So I am confused.
I want a master document (that uses a maaster document template) and for each use case an use case template to be used for the generation of the existing use cases and that they are included in the master document.
Is this possible?

skiwi

  • EA Expert
  • ****
  • Posts: 2081
  • Karma: +46/-82
    • View Profile
Re: How to generate a virtual document?
« Reply #1 on: December 10, 2009, 07:18:55 am »
The document template for the master document, and for each model document is set as a Tagged value.
If you are generating directly from a package you need to set the template in the Generate RTF dialogue.
You probably know this.
I presume too that you have, as resources, System or Model Document Templates (under Templates).

Its less obvious that to make a virtual document (a confusing term IMHO) you need to create a "master document" package within a view within a model.
The only way I know of doing this is to create  a new diagram in your "Documentation" view and use the toolbox to create a new master document (changing the stereotype of an existing package does not seem to work for me).

Within the master document create another documentation diagram and add model documents. In general use one model document per template,
and add your use case packages to the model documents as required.

I don't recommend using document artifacts in a master document even though they appear in the toolbox as they don't 'play well' with other document components (instead create a document artifact in a package elsewhere and include the package in a model document)

Hope this helps
« Last Edit: December 10, 2009, 07:24:14 am by skiwi »
Orthogonality rules
Position and Team disestablished, thanks austerity.
Now itinerant.

marcelloh

  • EA User
  • **
  • Posts: 192
  • Karma: +0/-0
    • View Profile
Re: How to generate a virtual document?
« Reply #2 on: December 10, 2009, 08:47:16 pm »
I've tried this:
(MyPackage contains 1 diagram & 1 UC)

Master document
(with child: UseCaseModelDocumentation)
Tagged Value RTFTemplate: model document: master template

and a model document:
UseCaseModelDocumentation
(with child: MyPackage)
Tagged Value RTFTemplate: MyUseCaseTemplate
I don't know what type in at SearchName/SearchValue
But is seems that everything I choose in SearchName would end up in a non-generated include of MyUseCaseTemplate inside of the master document. (It is actually the same as pressing F8 when first clicked on UseCaseModelDocumentation, also generating nothing, just showing my template.)

So, any hint are welcome.
(I find the documentation on this new feature not very helpfull btw!)





RoyC

  • EA Administrator
  • EA Practitioner
  • *****
  • Posts: 1297
  • Karma: +21/-4
  • Read The Help!
    • View Profile
Re: How to generate a virtual document?
« Reply #3 on: December 11, 2009, 11:40:45 am »
I'm not sure, from what you are saying, if you have dragged the package MyPackage into your model document and put something in the search fields. You cannot do both of these at the same time. The Help quite clearly states (http:// http://www.sparxsystems.com/uml_tool_guide/reporting_in_enterprise_architect/virtualdocuments.html) that if the model document contains a package and a search defined in the Tagged Values, it will only act on the package and ignore the search.

However, the end result would still be some indication of the contents of MyPackage. Perhaps we need to know what is in your two templates - what do they define and include?

When you display the Generate RTF Documentation dialog (F8) all you really have to do is specify where the report is to be output, and press the Generate button. The basic report should be covered by the Master and Model Document contents (including the templates), and all the other stuff is refining the output.
Best Regards, Roy

marcelloh

  • EA User
  • **
  • Posts: 192
  • Karma: +0/-0
    • View Profile
Re: How to generate a virtual document?
« Reply #4 on: December 16, 2009, 01:38:37 am »
I have some generation working, just the way I like it. However, it only works when I have dragged a package onto the model document.

I would like a Masterdocument with a SearchName "MyPackageFilter" and a SearchValue "MyFirstPackage" and that all underlying modeldocuments used that same filter. (So when I have to generate different package documentation, I only have to change one thing (The SearchValue) Is something like this possible?

marcelloh

  • EA User
  • **
  • Posts: 192
  • Karma: +0/-0
    • View Profile
Re: How to generate a virtual document?
« Reply #5 on: December 16, 2009, 01:58:31 am »
and yet another question: when having several headers in various mode doc's. How can they autonumber. For now, they all start at 1.

So I want something like this:

1. Changes
   [generated via ModelDoc "Changes" and template "Changes"]
    (some text)

2. References
   [generated via ModelDoc "References" and template "References"]
    (some text)

3. DistributionList
   [generated via ModelDoc "Distribution" and template "Distribution"]
    (some text)

But ... every number is 1.
« Last Edit: December 16, 2009, 02:00:55 am by marcelloh »