DocFlex/XML - DiagramKit
This feature will be included in DocFlex/XML 1.12, which is coming very soon!
DocFlex/XML is able to work with any kind of diagrams (i.e. inserting them automatically in the generated output).
That is supported on the level of templates, along with the generation of hypertext imagemaps.
Although, integrating diagrams into documentation can be effortlessly programmed in templates,
generation of diagrams themselves so far was not part of DocFlex/XML functionality.
Instead, we relied on integrations with 3rd-party software for that
(XMLSpy and Oxygen XML).
The support of diagrams comes from the concept of element images.
Some XML elements may have special depiction (or diagrams) attached to them.
For instance, an element in XML schema file that defines a particular XSD component
may be associated with a diagram showing the content model or the derivation of that component.
Such depictions, called element images,
can be easily inserted in the generated output using
Element images come from the
Element Image Provider
-- a special interchangeable extension of the XML DSM Driver.
Since element images are specific only to a particular type of data sources (e.g. XSD files),
the Element Image Provider
is effectively a part of the XML Type.
Now, we have developed our own diagramming engine called “DocFlex/XML DiagramKit”.
The first thing the DiagramKit will do is generation of XSD diagrams:
DiagramKit will be essentially another add-on to DocFlex/XML
(which by itself is mostly about data-mining in XML files and generating some human-readable text representation of the found results).
It has little intersection with the DocFlex/XML core architecture.
However, it will allow solving one very important licensing problem: to allow our users to license the whole functionality
necessary for them (that is, the generation of high quality documentation with diagrams) from the same single vendor -- that is us.
That was the primary motivation for us to develop DiagramKit and we strived for it the fastest way possible.
DiagramKit is implemented using JavaFX -- the newest Java graphics/GUI.
That will allow you to generate those diagrams anywhere Java works in general, in any configuration possible (including as the
Below are a few sample XSD diagrams generated by DiagramKit.
For more diagrams within the output documentation, please see: DocFlex/XML | WSDLDoc | Examples.
Our XSD diagrams will largely follow the notation used in XMLSpy
(however, with some extensions).
- They will look cleaner, because no collapse/expand buttons are shown on each diagram element.
Include a lot more hyperlinks, basically from any visible feature or label. (XMLSpy doesn't provide such hyperlinks,
for instance from the depiction of base types, which we find frustrating).
Unlike XMLSpy, our XSD diagrams will also show the restricted base types.
XMLSpy, for some reasons, shows only extended types (as if restrictions don't matter).
There will be a possibility to customize a little bit look&feel of the diagram: change the background of the base-type panel.
XMLSpy uses yellow color for that. We made it a shade of blue. However, you can specify your own color with a template parameter.