Document Generation

[tdcoll]

I am also experiencing the same 'pain' as Nick and others.  

I just started using EA and was hoping to generate RTF documents with multi-level headings (following the package hierarchy I created in EA) - but can not find a way with in EA to do this.

What approaches are others using?

[peter.zrnko]

I've tried to set "Adjust Heading levels" to Heading 9 (Document Options) when generating documentation for a package including nesting packages. In the template I had style Heading x (I think 3) for Package name.
In the resulted RTF document I've found different headings styles according to the package depths.

Unfortunately all with the same Level of overview (level 1). It seems it is possible to influnce the style according to package  depths, but not the level of overview.

See my post http://www.sparxsystems.com.au/cgi-bin/yabb/YaBB.pl?board=Automation;action=display;num=1161243686

[mark.myers]

I have this working fine.  All headings and levels get adjusted according to the package depth.  To get it to work I had to define styles for Heading 1, Heading 2 etc (up to 9) in the template editor.  Without these styles defined the level/style will remain whatever you use in the template body.

Hope this helps.

[nick.hynes]

Thanks Mark.

I tried that, but it's still not working for me.

The Table of Contents is showing the headings at the correct level, but somehow my level 1 'Heading 1' style is being converted to a 'Heading 1 Char,H1 Char,Section Heading Char,EA Char,1 Char,h1 C' style, as are all of the child package headings.

The template is essentially defined like this (with a few cover pages):

[size=18]{Pkg.Name}[/size]  (Heading 1 style)

{Pkg.Notes}
diagram >

{Diagram.Name}

{Diagram.Notes}
{Diagram.DiagramImg}
{Diagram.Figure}
< diagram


package element >
< package element
element >

NAME	Description
{Element.Name}	{Element.Notes}

embedded elements >
< embedded elements
diagram >
< diagram
child elements >
< child elements
< element
child package >
< child package
< package

[mark.myers]

Thanks Mark.

I tried that, but it's still not working for me.

The Table of Contents is showing the headings at the correct level, but somehow my level 1 'Heading 1' style is being converted to a 'Heading 1 Char,H1 Char,Section Heading Char,EA Char,1 Char,h1 C' style, as are all of the child package headings.

Hmmm.  I will describe how I have it set up and that may give you some clues.  I have a Word document that is my master document and it contains my TOC and preamble.  Then I have a number of RTF files inserted as linked documents (below is my template that generates the requirements section).  The headings are replaced correctly (provided they are defined in the template - see prior post) but I have noticed that the field that contains the header is correctly styled as 'Heading 2' etc but that the end-paragraph character is styled as 'Heading 2 + Auto, Auto'

Perhaps it the way Heading 1 is defined in the template (you've probably had a few edits of it by now)  Try deleting the style and re-adding it (that's if you can find a way to delete the style - or start a new template and paste in the body)

Requirements template (full listing):
package >
{Pkg.Name} (Heading 1)

element >
Name
Notes
{Element.Name}
{Element.Notes}
< element
child packages >
< child packages
< package

[peter.zrnko]

BTW there is no posibility to delete a Style defined in a Template or at least I didn't found it.

[Ozzone]

The way I found to delete styles is to export the template to a rtf file. In a text editor, edit the section where the styles are defined, then re-importing it !!!

For ex. {\s6\fs24\b\cf2\cb1\ulc2 heading 1;}

But make sure they are not used in the reste of the file (try searching "s6" in my example)

[Ozzone]

Coming back to the solution proposed above, I does not work at all for me !!

If I specify "heading 1" for  {pkg.name} it remains as heading 1 in the whole document !  

[Ozzone]

Could Mark Myers export his template in rtf and add it in this thread ?

Thanks

[mark.myers]

Could Mark Myers export his template in rtf and add it in this thread ?

Thanks

As requested, here is the RTF export of my requirements template.  As I said, the critical thing for me was to define Heading 2, 3 & 4 in the EA template.  I couldn't find any way to attach/upload a file to this post  :-/ so I have pasted the raw text here but I'm not sure if you'll be able to recreate the template from it.

Code: [Select]


{\rtf1\ansi\deflang3081\ftnbj\uc1\deff1
{\fonttbl{\f0 \froman \fcharset0 Times New Roman;}{\f1 \fswiss \fcharset0 Arial;}{\f2 \fswiss \fcharset0 ;}{\f3 \froman \fcharset0 ;}{\f4 \fswiss \fcharset0 Lucida Sans;}}
{\colortbl ;\red255\green255\blue255 ;\red0\green0\blue0 ;\red255\green255\blue128 ;\red73\green0\blue65 ;\red250\green255\blue255 ;\red0\green16\blue0 ;\red128\green255\blue255 ;}
{\stylesheet{\fs20\cf2\cb1\ulc2 Normal;}{\cs1\cf2\cb1\ulc2 Default Paragraph Font;}{\cs2\f4\fs16\b\protect\cf0\cb3\ulc2 SSBookmark;}{\s3\cf2\cb1\ulc0 ;}{\s4\fs20\cf2\cb1\ulc0\tqc\tx4320\tqr\tx8640 footer;}{\cs5\cf2\cb1\ulc0 page number;}{\s6\f1\fs28\cf2\cb1\ulc2
Heading 1;}{\s7\f1\fs22\cf2\cb1\ulc2 Plain Text;}{\s8\f1\fs22\cf2\cb1\ulc2\outlinelevel1 Heading 2;}{\s9\f1\fs22\cf2\cb1\ulc2\outlinelevel2 Heading 3;}{\s10\f1\fs22\b\cf0\cb1\ulc0\outlinelevel3 Heading 4;}}
\paperw11908\paperh16833\margl1800\margr1800\margt1440\margb1440\headery720\footery720\deftab720\formshade\aendnotes\aftnnrlc\pgbrdrhead\pgbrdrfoot
\sectd\pgwsxn11908\pghsxn16833\marglsxn1800\margrsxn1800\margtsxn1440\margbsxn1440\headery720\footery720\sbkpage\pgncont\pgndec
\plain\plain\f1\fs20
{\header
\trowd\trgaph108\trleft0
\clvertalt\clbrdrb\brdrs\brdrw10\cellx2844
\clvertalt\clbrdrb\brdrs\brdrw10\cellx5796
\clvertalt\clbrdrb\brdrs\brdrw10\cellx9540
\pard\intbl\s0\ql\widctlpar\plain\f1\fs20\lang1033\f3\cf2\fs22 Requirements \cell
\pard\intbl\s0\qc\widctlpar\plain\f1\fs20\lang1033\f3\cf2\fs22\cell
\pard\intbl\s0\qr\widctlpar\plain\f1\fs20\lang1033\f3\cf2\fs22{\field{\fldinst TIME \\@ "dddd, MMMM dd, yyyy"}{\fldrslt Friday, April 29, 2005}}\cell
\intbl\row
\trowd\trgaph108\trleft0\trrh-20
\clvertalt\clbrdrt\brdrs\brdrw10\cellx2844
\clvertalt\clbrdrt\brdrs\brdrw10\cellx5796
\clvertalt\clbrdrt\brdrs\brdrw10\cellx9540
\pard\intbl\s0\ql\widctlpar\plain\f1\fs20\lang1033\f3\cf2\fs22\cell
\pard\intbl\s0\ql\widctlpar\plain\f1\fs20\lang1033\f3\cf2\fs22\cell
\pard\intbl\s0\ql\widctlpar\plain\f1\fs20\lang1033\f3\cf2\fs22\cell
\intbl\row
\pard\s0\ql\plain\f1\fs20\f2\cf2\fs22\par\plain\f1\fs20}
{\footer\pard\s4\tqc\tx4320\tqr\tx8640\qc\widctlpar\plain\f1\fs20\lang1033\f0\cf2 ________________________________________________________________________\cs5{\field{\fldinst PAGE}{\fldrslt 1}}\cs1\pard\s4\tqc\tx4320\tqr\tx8640\qc\widctlpar\par\pard\s0\ql\plain\f1\fs20\f2\cf2\fs22\par\plain\f1\fs20}
\pard\s6\ql{\*\bkmkstart Pkg_Begin}{\*\bkmkend Pkg_Begin}\cs2\lang1033\f4\highlight3\fs16\b\protect package {\*\bkmkstart Pkg_Begin_Inner}{\*\bkmkend Pkg_Begin_Inner}>\cs1\lang3081\f1\highlight1\ulc0\fs28\b0\protect0\par\plain\f1\fs20{\field\fldlock{\*\fldinst
MERGEFIELD \lang1033\f1\ulc0\fs28\b Pkg.Name}{\fldrslt\lang1033\f1\ulc0\fs28\b \{Pkg.Name\}}}\ulc0\fs28\par\pard\s7\ql\plain\f1\fs20\ulc0\fs22\par{\*\bkmkstart Pkg_Element_Begin}{\*\bkmkend Pkg_Element_Begin}\cs2\lang1033\f4\highlight3\ulc2\fs16\b\protect
element {\*\bkmkstart Pkg_Element_Begin_Inner}{\*\bkmkend Pkg_Element_Begin_Inner}>\cs1\lang3081\f1\highlight1\ulc0\fs22\b0\protect0\par
\trowd\trgaph60\trleft0\trrh245\trhdr
\clvertalt\clbrdrt\brdrs\brdrw1\clbrdrb\brdrs\brdrw1\clbrdrl\brdrs\brdrw1\clbrdrr\brdrs\brdrw1\cellx3150
\clvertalt\clbrdrt\brdrs\brdrw1\clbrdrb\brdrs\brdrw1\clbrdrl\brdrs\brdrw1\clbrdrr\brdrs\brdrw1\cellx8640
\pard\intbl\s7\ql\plain\f1\fs20\lang1033\f1\ulc0\fs22\b Name\cell
\pard\intbl\s7\ql\plain\f1\fs20\lang1033\f1\ulc0\fs22\b Notes\cell
\lang3081\f1\b0\intbl\row
\trowd\trgaph60\trleft0
\clvertalt\clbrdrt\brdrs\brdrw1\clbrdrb\brdrs\brdrw1\clbrdrl\brdrs\brdrw1\clbrdrr\brdrs\brdrw1\cellx3150
\clvertalt\clbrdrt\brdrs\brdrw1\clbrdrb\brdrs\brdrw1\clbrdrl\brdrs\brdrw1\clbrdrr\brdrs\brdrw1\cellx8640
\pard\intbl\s7\ql\plain\f1\fs20{\field\fldlock{\*\fldinst MERGEFIELD \lang1033\f1\ulc0\fs22 Element.Name}{\fldrslt\lang1033\f1\ulc0\fs22 \{Element.Name\}}}\ulc0\fs22\cell
\pard\intbl\s7\ql\plain\f1\fs20{\field\fldlock{\*\fldinst MERGEFIELD \lang1033\f1\ulc0\fs22 Element.Notes}{\fldrslt\lang1033\f1\ulc0\fs22 \{Element.Notes\}}}\ulc0\fs22\cell
\intbl\row
\pard\s7\ql\plain\f1\fs20{\*\bkmkstart Pkg_Element_End_Inner}{\*\bkmkend Pkg_Element_End_Inner}\cs2\lang1033\f4\highlight3\fs16\b\protect < elemen{\*\bkmkstart Pkg_Element_End}{\*\bkmkend Pkg_Element_End}t\cs1\lang3081\f1\highlight1\ulc0\fs22\b0\protect0\par\plain\f1\fs20{\*\bkmkstart
Pkg_Pkg_Begin}{\*\bkmkend Pkg_Pkg_Begin}\cs2\lang1033\f4\highlight3\fs16\b\protect child packages {\*\bkmkstart Pkg_Pkg_Begin_Inner}{\*\bkmkend Pkg_Pkg_Begin_Inner}>\cs1\lang3081\f1\highlight1\ulc0\fs22\b0\protect0\par{\*\bkmkstart Pkg_Pkg_End_Inner}{\*\bkmkend
Pkg_Pkg_End_Inner}\cs2\lang1033\f4\highlight3\ulc2\fs16\b\protect < child package{\*\bkmkstart Pkg_Pkg_End}{\*\bkmkend Pkg_Pkg_End}s\cs1\lang3081\f1\highlight1\ulc0\fs22\b0\protect0\par\plain\f1\fs20{\*\bkmkstart Pkg_End_Inner}{\*\bkmkend Pkg_End_Inner}\cs2\lang1033\f4\highlight3\fs16\b\protect
< packag{\*\bkmkstart Pkg_End}{\*\bkmkend Pkg_End}e\cs1\lang3081\f1\highlight1\ulc0\fs22\b0\protect0\par\par}


[Eve]

May be worth adding it to the EA User Group site.  http://www.eausergroup.org/

I suspect it may be easier to add it to the SharePoint site.

[jorgemusprime]

Hello there,

I'm new with EA. I Know that you may be had been discussing this. But I'm gonna ask it any way.

Its possible to create document with an a personalized style including header and the footer. Is that possible?. how?.

If it is possible, please somebody tell me how!!

I need to know it realy soon!.

Regards.

Jorge

[nick.hynes]

Hi  All,

I finally got this working, thanks for all the help & advice.

The solution was to go back to the 'basic template' as a starting point. I then modified that in an iterative fashion until I had what I wanted.

It was a slow process, and you need to be careful when you cut and paste not to screw up the document styles.

Persevere - it can be done.

- Nick Hynes

[jorgemusprime]

Hello,

I have a problem and I need your help for to fix it.

I have made a diagram that is to long. So, when I generate the documentation the picture  is to small and is very unusefull.

Is there any way for to cut the image and use, for example, three pages?.

HELP PLEASE!!!!!......

looking forward hear you soon,

regards,

Jorge

[StefanPears]

Hi Jorge,

I will be very lucky if s.o. has a better answer than this one: I fear, you will have to save your diagram as image. Cut it into pieces with a third party tool (e.g. irfanview) and manually insert the segments into your document.

Stefan