Heading levels in RTF documentation

[timhawkins]

I would like to see the following changes to the RTF document generator.

1) The ability to set the "heading level" of any package... Ie EA assumes that the node that you are generating rtf for is level 1, and all subsequent nested packages increment the level, I would like to be able to set the heading level of any package. This would make it easy to generate docs that integrate into our documentation standards.

2) The ability to suppress generation of RTF output for the root node, but still have the children generated. The root node is generaly a container view and is not really part of the documentation, for example a "custom view" called "requirements" results in "requirements" being heading level 1,  and results in all the childeren having rtf generated at the next level down. This puts all the documented packages at level 2 which is problematic for us.

3) EA has two options, elements as text or elements as a specific heading level (level 9). This causes us problems with element heading numbering (we are doing requirements with EA). I would like to have an extra option where elements can take either a specific level, or just the next heading level in the heading hierarchy.


Im currently running a SED script on the rtf output to try and fix up the output to match. The automation interface is not really an option for us as it envolves developing a specialised interface to word.

[gsparks]

Hi Tim,

I have had a quick look at this:

(3) is relatively straightforward and I will add an option to EA to select "Max 9 levels - elements are package + 1" as a drop list option. THis iwll be in the next build.

(2) a bit more difficult to arrange - but can really be done now. If you create a Word Master document and link in the contained packages at the right position - then you can produce any mix you like. To speed creation of several RTF documents at once, either create RTF documents which will appear in the Resource tab - then click each one and select autogenerate in turn. -OR- create a little script in VB or similar that calls the EA.Project.RunReport interface with the package list to generate.  Using this technique you can pick up packages from all over EA and link into one formal document.

(1) Is a bit harder - if you say package Foo is at level 3 - then I assume you would want all lower packages to increment the heading count - unless they specified a heading level also - then the process starts again. Is this what you had in mind?


Regards,
Geoff

[timhawkins]

(1) yes thats exactly what I had in mind... It also solves my problem for (2) I can set all the top level packages to level 1, and then generate the whole view, I can then set the root name to something like "Overview" and give it note text that describes the project.

[timhawkins]

incedently, why cant you set a description on a view, just curious.... ie the view has no "properties"

[mch]

I would also like to see nesting of packages in heading levels in RTF documents. Would it be possible to add another option to the "package + 1" style that treats nested packages as a lower level?  (I can get by without the customised heading levels although it's an excellent idea)

Package nesting in RTF docs would be a great immediate help to me.

Cheers,
Mark