Author Topic: RTF Documentation - to add a section more times  (Read 571 times)

..David..

  • EA Novice
  • *
  • Posts: 7
  • Karma: +0/-0
    • View Profile
RTF Documentation - to add a section more times
« on: November 10, 2008, 09:07:21 pm »
Hello,

Iīm loking for a way to add a section more then only one time to the Content template.
Background of the idea is that I want to use the {Pkg.ParentPackage} Tag in the page header and in the page body. For this it is necassary to add the section "Package". But I couldnīt add it twice: in the page header and in the page body.

Iīm sure that their will be any way and thank you for your answers.
Best wishs
David

Oliver F.

  • EA User
  • **
  • Posts: 573
  • Karma: +2/-1
  • Arenīt we all in the model business ?
    • View Profile
    • Karl Storz homepage
Re: RTF Documentation - to add a section more time
« Reply #1 on: November 10, 2008, 11:05:44 pm »
From my experience you canīt add any section into a page header or footer anyway without producing unpredictable results.

The package section acts as some sort of container for the underlying sections (diagrams, elements,...) which it encapsulates and as the header is a different document section than the rest of the document body (because the header is printed on several pages while the package element itself only at one point, it would propably destroy the document structure. Then comes the question what happens if the package section changes in the middle of a page- what would the renderer do?

I might be wrong here and things have changed but last time I tried this the results were unpredictable and the document looked horrible so I gave up.

Maybe you have more luck than I had.

Oliver

..David..

  • EA Novice
  • *
  • Posts: 7
  • Karma: +0/-0
    • View Profile
Re: RTF Documentation - to add a section more time
« Reply #2 on: November 10, 2008, 11:39:47 pm »
Okay - thank you, Oliver.

My main question asks about some way to add a section many times to the content template.

If there is some possibility to add some section to a header of the document that would be good but its just the second question for this time.

So Iīm looking for a way to add for example the "Package" section two or three times in the document.
I ask, because I want to use the Fields (for example pkg.parentPackage) often in the document body. But everytime I just can Use this Field only in one part:

For Example:

-----------------------------------------------------------
                                                                          
Document                                                           
...                                                                      
...                                                                      
[highlight]package >[/highlight]                                                       
                                                                         
{Pkg.ParentPackage}                                           
                                                                         
[highlight]< package [/highlight]                                             
...
...                                                                      
...                                                                      
[highlight]package >[/highlight]                            
                                                                        
{Pkg.ParentPackage}                                          
                                                                        
[highlight]< package [/highlight]                          
...                                                                      
...                                                                      
                                                                   
------------------------------------------------------------

So I try to use it in many sections.
Best wishs
David

aGrahamAtFES

  • EA Novice
  • *
  • Posts: 12
  • Karma: +0/-0
    • View Profile
Re: RTF Documentation - to add a section more time
« Reply #3 on: November 13, 2008, 12:31:46 am »
I to am trying to figure this out, but have not been successful.  I want to have the function documentation list the full function signature and then also have the parameters documented.

Oliver F.

  • EA User
  • **
  • Posts: 573
  • Karma: +2/-1
  • Arenīt we all in the model business ?
    • View Profile
    • Karl Storz homepage
Re: RTF Documentation - to add a section more time
« Reply #4 on: November 13, 2008, 06:46:20 pm »
Quote
I to am trying to figure this out, but have not been successful.  I want to have the function documentation list the full function signature and then also have the parameters documented.

I had offered the following solution offline so for completeness here it is in public:
Take a look at virtual documents. You can create a master document including a number of further documents which document different aspects of the model using templates of their own each.
They can either be used to describe different parts of the model or the same part of a model and show different aspects of it - just use a different template to document the same elements.

The online help and the RTF white paper from Sparx make a ver valuable source of information here.

Regards,

Oliver

aGrahamAtFES

  • EA Novice
  • *
  • Posts: 12
  • Karma: +0/-0
    • View Profile
Re: RTF Documentation - to add a section more time
« Reply #5 on: November 14, 2008, 03:02:47 am »
I need the documentation to be intermingled. i.e.

Foo
This is Foo documentation
Declaration      int Foo(in int X)
Parameters      X:in int
                       Documentation of X
Return      int

that can not be created by virtual documentation.