Model and Master Document or normal.rtf?

[ebeb]

Hi!

Guess what's the question? You name it, RTF again!  

Ok, currently, I have all the corporate identity stuff like footer, logos and stuff in every single template.

I saw that there are two ways to use just one corporate template as the basis for other documents.

So, I already use Virtual Model Documents to aggregrate different packages which is just fine. Now, what I've read about the Master document, it seems more as if the master document includes other model documents and generates a huge document including all the model docs rather than the other way around. I was hoping I could define a master doc with an empty CI template and let model docs some kind of "inherit" from the master doc. I still want that each model doc delivers one RTF output. I don't want to combine them.

But this not gonna work, is it?

So, in this case, I need to use the normal.rtf. I read that I should not put any data in it except formatting. Does this apply also to corporate logos and stuff? In other words, does this template has to be REALLY empty (i.e not a single character) or does that only mean no document sections?

I appreciate any reply!

-Jan

[skiwi]

Sorry, I'm struggling with this too.
I'll be interested in the answers you get.
See http://www.sparxsystems.com/cgi-bin/yabb/YaBB.cgi?num=1256154543

[fwoolz]

Sparx ought to pay someone to gather up all the answers, tips, workarounds, etc. from this forum and publish them in one giant "How To" guide. Alternatively, there's an opportunity here for a badly needed book - "Sparx Enterprise Architect UNLEASHED!"

[skiwi]

Well actually they may say it is their RTF white paper, others may not.

In my case I'd suggest that more documentation will not fix what is an obtuse subsystem.

Note that a recommendation by sparx is to use Master documents (swap one flakey system for another?) that provide the header footer, toc etc, and link to the generated documents. I have found this useful.

[Ainsley Haslett]

Good point skiwi it is tricky. Now that I think about it I probably wouldn't have figured it out had it not been for http://www.catchlimited.com/ teaching me on a training session I attended on this subject.

Here is some info I posted on linkedin in the EA group on this topic

I disagee that you cant create a nice word document from EA. Granted It is hard, but it is definitely possible.

The trick is this:
1) Create a new rtf template in EA with the required fields> You will need a new rtf teamplate for each different section in your final document.
2) Export the rtf
3) Open the rtf in office 2k7 and apply the formatting - be careful not to change the field tag naming or the order of the fields
TIP: Use tables for your EA info!
4) Go back to EA and open the rft
5) Select import and import the rtf that you updated using word 2k7
6) Save
7) Repeat 1-6 for each section. e.g. you may need the following templates, each being a separate rtf: a cover page; introduction; verision history; process; requirements; signoff
Create a master document* and attach the relevant packages and templates
9) Generate the master document
* I'm assuming you know how to set up a master and model documents...

Let me know how you get on!

Ainsley

[ebeb]

Note that a recommendation by sparx is to use Master documents (swap one flakey system for another?) that provide the header footer, toc etc, and link to the generated documents. I have found this useful.

skiwi, could you elaborate on this? I mean, is it possible (as I explained in my first post) to create a master doc with an empty template but with the formatting and the header/footer and use the model docs to create different rtfs with the formatting of the master doc?

The trick is this:
1) Create a new rtf template in EA with the required fields> You will need a new rtf teamplate for each different section in your final document.
2) Export the rtf
3) Open the rtf in office 2k7 and apply the formatting - be careful not to change the field tag naming or the order of the fields
TIP: Use tables for your EA info!
4) Go back to EA and open the rft
5) Select import and import the rtf that you updated using word 2k7
6) Save
7) Repeat 1-6 for each section. e.g. you may need the following templates, each being a separate rtf: a cover page; introduction; verision history; process; requirements; signoff
Create a master document* and attach the relevant packages and templates
9) Generate the master document
* I'm assuming you know how to set up a master and model documents...

Hey Ainsley,

What exactly is the advantage of this method? I already have created a few templates based on an imported word template. But even this does not work properly. I had a lot of trouble importing the template (there is an old thread where I described my misery) becase table were messing, styles were wrong...in one word: Horrible.

But in contrast to your suggesting, I have one template for or resulting document. This works well. I can assemble all the packages I need using the model documents attributes. So what advantage do I have when I would split it and put all into one master document?

The main problem I have is, that I create several documents, e.g. product requirements spec, system requirements spec, system designed description etc pp.

I don't want to put all of them into one master doc! Instead, I want to have one "master template" where I can apply the formatting, headers, footers and then create each single rtf doc using the master formatting.

-Jan

[Ainsley Haslett]

Morning Jan

I think we have misunderstood each other. Im suggesting one master doc for BOTHsay requirements spec and technical spec. Im suggesting say:

Master doc 'Functional spec'
e.g. with the following sections, each being a model doc corresponding to a separate rtf template
-model doc cover page
-model doc introduction
  e.g. displaying package notes
-model doc requirements
  e.g. a table with requirement name, requirement notes, author, date, version
-model doc diagram
  e.g. diagram image, notes, tabulated activity list

Make sense?  

You could conceivably reuse the 'introduction' rtf in the technical spec (master document) for example, but say the 'cover page' rtf would be different as would have different title etc.

What else to say? If your method works then I would suggest you use it. I'm not suggesting my approach is better. I can tell you that it works and that I have successfully imported word documents - and it works. There are lots of lets say 'idiosyncrasies' about the import (won't use the word bugs) but with trial and error it does work. It is tricky though, I will say that.  :-?

[ebeb]

Ainsley,

that makes perfect sense However, I (and this is just my workflow at the moment, not better) use just one model document. For each model doc, I just add the packages I need. One package e.g. contains an introduction with some nice diagrams. I can reuse it by just dragging the package on the model doc I want to have it in.

BUT, unfortunately, that still doesn't answer my question: How can I just have one master template and use it for all documents?

[Ainsley Haslett]

hi

point one, agree

point two - no, you inherently have one master doc for each doc type e.g. tech spec = master doc, func spec = 2nd master doc.

Create one master doc then export and re-import it then rename it and tweak it to fasttrack creating 2nd, 3rd master docs etc  

[ebeb]

Now you got it Bud sadly, it seems as if I was right and it doesn't work.

The problem is, that our model grows kind of organically. We start with the first process step. When it comes to doc, I create the doc we need. Then, next step, we need another doc, I create it. Now, I find some wrong formatting. If I change it, I need to change it in the other templates, too. This is quite time consuming, especially with the *awesome* RTF editor.

So again, what about the normal.rtl? Does anybody use with success?

[RoyC]

This is the latest text from the Help files, concerning use of Normal.rtf:

"In versions of Enterprise Architect later than 7.1, a Normal.rtf template is provided as a system template, as an external file stored with the Enterprise Architect system directory (in C:\Program Files\Sparx Systems\EA\DocTemplates). This provides user-editable defaults of styles, numbering and other base formats. Any styles modified in the Normal.rtf file reflect in newly created templates.

To edit the Normal.rtf template, use the RTF Style Template Editor to create a new template called, for example, Normal, and use the File | import menu option to import the Normal.rtf file into the Normal template. Modify the Normal template as required, but ensure there is no body text when you save it. Export the modified template back into the Normal.rtf file in the DocTemplates folder.

A related feature in the RTF Style Template Editor is the File | Update Styles menu option. This enables you to update existing templates to reflect any changes to Normal.rtf."

The Normal.rtf file is the base reference file that all templates reflect, once you 'wash' them with File | Update Styles option. I think that option is what you need to change your templates.

[ebeb]

Hi Roy, thanks for replying!

Actually, I already read it and that's exactly what my initial question was about:

...but ensure there is no body text when you save it

So I can not use headers and footers with company logo e.g. within the normal.rtf? So I would need to have this done for each template? But I think it works at least for all the formatting.

[edit] The normal rtf cannot be stored within the project. So there is no project-wide isntead of system-wide template, is it? So if I change the normal rtf, other users can not use the template. [/edit]

Thanks

[ebeb]

And here is one really basic question:

How do I edit the normal.rtf? I guess, you would problably again copy the text from the help file, so I'll do that:

The Normal.rtf file is stored with the Enterprise Architect system directory. Use the RTF editor to open and modify it, but ensure there is no body text when saved.

But, unfortunately, that doesn't help. I tried:

• Looking in the list of template: Not there
• Opening the RTF editor: Not possible without opening a specific template.
• Opening any random template: Now what? The RTF Editor does not have an "open" command.
• Looking in the "Resources Window": No normal.rtf, only a parent template called "system" which I can't edit

So what now?

[RoyC]

Well, the reason I copied the text from the Help file myself is that it is the very latest, updated text, and not the same as the section you quote.

The piece I quoted tells you exactly where the file is, and exactly how to access it and edit it.

I hope someone corrects me on the next bit, if I am wrong, but in the process I described in the Help you are creating a new template within the RTF Editor based on the Normal.rtf file, and presumably you can put your boilerplate text and graphics in that. Or copy that template and use the copy for your boilerplate.

The point is, the Normal.rtf file is the style template, and you can create as many templates as you like from that, and copy existing templates to create new templates, all of which can be 'washed' with the Normal.rtf style template using the File | Update Styles menu option.

So, if you want a boilerplate that incorporates any changes you decide to make to the Normal.rtf styles, import the Normal.rtf file into a new template in the RTF editor, make your style changes as required, export that template to update the Normal.rtf file, then edit the same template in the RTF editor to include your boilerplate text. When you need to change the Normal.rtf styles again, import the Normal.rtf file into another new template in the RTF editor, make the changes, export that back into the Normal.rtf file, then open your existing boilerplate template and use the File | Update Styles option to wash the style changes into the template.

[ebeb]

Oops...my bad!  

I have to admit, that when I read "This is the latest text from the Help files" I thought "Yes, I read that part from the help file, it's nothing in it".

So, this part you posted is not officially published, right?

With that information, it works! Thanks a lot!

Jan