Survey on XSD documentation

[lbell]

Hello everyone,

    QXmlEdit is gaining revamped support for XSD reporting in paginated and non paginated formats (PDF and HTML) for better XSD documentation.

If anybody has some suggestions or needs, I am glad to take them into account before closing the feature.

Essentially the reports will consist of two types: simple and complete where the difference is the level of detail of referenced elements and types.

The diagram of the schema will consist of outline or logical view depending what is the current choice in the XSD display panel from whom the report is created.

An hypothesis is to use Graphviz (www.graphviz.org) to generate the diagram.

Some samples of the currently generated reports are visible at the following links, please note that the type of included XSD diagram is independent of the report type:

* simple report in PDF format for Apache FOP’s intermediate format XSD with logical view diagram

   (https://github.com/lbellonda/qxmledit/wiki/files/simple_if.pdf),

* complete report in PDF format for Apache FOP’s intermediate format XSD with logical view diagram

   (https://github.com/lbellonda/qxmledit/wiki/files/complete_if.pdf),

* complete report in HTML format for Apache FOP with outline view diagram

  (https://github.com/lbellonda/qxmledit/wiki/files/complete_fop.html),

* complete report in PDF for Apache Maven POM

  (https://github.com/lbellonda/qxmledit/wiki/files/complete_maven.pdf).

The branch for the feature is 167-betterxsddoc.

The current work is outlined in the “Roadmap” wiki page at https://github.com/lbellonda/qxmledit/wiki/Roadmap.