Using stimulsoft to generate documentation from xml

[csbrogi]

Hello,

I am new to stimulsoft and want to ask for some advice if stimulsoft is a good choice for doing the following task:

We want to generate documentation from our software development tool. The input format for stimulsoft is XML and the output format docx.

The XML input can be formatted as needed.

The Output Document should look something like this:

Code: Select all

chapter "analysis"
  sub chapter "Package 1"
    sub chapter "Sub Package 1"
      sub chapter "class diagramm 1"
        description text
        graphic
        sub chapter "contained classes"
           crossreference to class 1
           crossreference to class 2
      sub chapter "classes"
        sub chapter "class 1"
           description text for class 1
           sub chapter "Attributes"
              sub chapter "Attribute 1"
                 description text for attribute 1
                 table with attribute properties
             ...
        sub chapter "class 2"
           description text for class 2
             ...

As you can see, we need a highly structered output document. It is necessary to include graphics (EMF or PNG Format) in the document as well as Links to external documents (pdf or xlsx or word (docx) files). It must be possible to create cross-references to chapters in the document. Sub chapters for classes (in the example) can be placed on different hierarchy levels.
It would be helpful to auto-generate chapter numbering for some elements and a table of contents as well as an index.

Is stimulsoft a good choice for this task?

Thanks in advance

Clemens

[HighAley]

Hello, Clemens.

I am new to stimulsoft and want to ask for some advice if stimulsoft is a good choice for doing the following task:

We want to generate documentation from our software development tool. The input format for stimulsoft is XML and the output format docx.

The XML input can be formatted as needed.

The Output Document should look something like this:

Code: Select all

chapter "analysis"
  sub chapter "Package 1"
    sub chapter "Sub Package 1"
      sub chapter "class diagramm 1"
        description text
        graphic
        sub chapter "contained classes"
           crossreference to class 1
           crossreference to class 2
      sub chapter "classes"
        sub chapter "class 1"
           description text for class 1
           sub chapter "Attributes"
              sub chapter "Attribute 1"
                 description text for attribute 1
                 table with attribute properties
             ...
        sub chapter "class 2"
           description text for class 2
             ...

As you can see, we need a highly structered output document. It is necessary to include graphics (EMF or PNG Format) in the document as well as Links to external documents (pdf or xlsx or word (docx) files). It must be possible to create cross-references to chapters in the document. Sub chapters for classes (in the example) can be placed on different hierarchy levels.
It would be helpful to auto-generate chapter numbering for some elements and a table of contents as well as an index.

Is stimulsoft a good choice for this task?

Yes, Stimulsoft Reports could accomplish this task. But it's not clear what structure your report will have. Have your Document fixed structure?

Let us know if you will have any difficulties with creating such document.

Thank you.