FlexDoc/XML - DiagramKit

This feature is included in FlexDoc/XML archive, which is ready for downloads now!

  1. What is DiagramKit?
  2. Key Features
  3. Technical Requirements
  4. Usage
  5. Licensing / Processing Modes

1. What is DiagramKit?

DiagramKit is the FlexDoc/XML native diagramming engine (independent on any third-party software). It creates beautiful XSD component diagrams, which can be generated/inserted simultaneously along with the documentation generated by XSDDoc/WSDLDoc (with the support of all possible hyperlinks). It is included in FlexDoc/XML software and will work by default.

DiagramKit is implemented as a diagramming plugin, which is a replaceable part of FlexDoc/XML, whose job is to provide some graphical representations of XML elements. It is another add-on to FlexDoc/XML and licensed separately.

Below are two sample diagrams generated by DiagramKit (click on the screenshots to view each diagram inside the documentation):

For more sample documentation with diagrams generated by DiagramKit, please see:

2. Key Features

Generation of XSD (XML Schema) component diagrams:

3. Technical Requirements

DiagramKit is implemented entirely using JavaFX 8 (the newest Java graphics/GUI platform) without involvement of anything else (e.g. XMLSpy etc). Consequently, DiagramKit will work anywhere Java 8 (or later) + JavaFx work. In particular, we've tested it on the following operating systems: On all of them, you can equally run XSDDoc/WSDLDoc + DiagramKit from both Ant and Maven.


4. Usage

Since DiagramKit is a diagramming plugin, it can be replaced with any other such a plugin (e.g. XMLSpy Integration or OxygenXML Integration), which is specified on the generator and template designer Java command line using -m option:
where 'diagramming-plugin-class' is a Java class implementing the plugin entry point. For instance, specifying DiagramKit in that way would look as follows:
However, 'IMAGE_PROVIDER_CLASS' is a macro that is expanded in the template set's XML Type config file. Unless that macro is specified on the command line, its default value will be used, which in case of XSDDoc/WSDLDoc is also assigned in the same config file with 'xyz.flexdoc.xml.xsd.DiagramKit'.
So, unless -m:IMAGE_PROVIDER_CLASS option is used on the command line (which is exactly the case when you run {flexdoc-xml}\bin\generator.bat), DiagramKit will be activated by default with any XSDDoc/WSDLDoc main template.

For further information, please see:

5. Licensing / Processing Modes

DiagramKit works with both XSDDoc and WSDLDoc, however, it is licensed separately.

That's because you can choose to use another diagramming plugin (e.g. XMLSpy Integration or OxygenXML Integration) or none at all instead.

To accommodate all possibilities concerning licensing, DiagramKit will work in the following modes:

Demo Mode

When you have no particular license for DiagramKit, the Demo License is activated, which enables a special demo mode. The purpose of that mode is to allow you without much hassle to see what DiagramKit basically can and in some cases even to use it for free.

In demo mode DiagramKit will work together with either XSDDoc/WSDLDoc when no other licenses are installed for both DiagramKit and the given template set.

That is exactly the case when you have just downloaded FlexDoc/XML and installed it. Then, you can immediately run it. Everything will work in demo mode. You don't need to request any trial for that!

When you run XSDDoc or WSDLDoc, you will see a message like this:

Just click OK to continue.

In demo mode, DiagramKit will generate only limited number of component diagrams. How many depends on the demo limits of a particular main template. However, any diagrams generated in demo mode will be complete and without trial markers.

When demo mode is disabled

Because of programming limitations, DiagramKit can work in demo mode only with a template set (i.e. XSDDoc/WSDLDoc) also running in demo mode. When you already have a Full License for that template set (and none for DiagramKit), you will see a message like this:

After clicking OK, you can continue using that template set (according to your license for it), however DiagramKit will be disabled: In order to use DiagramKit in that case, you can: If you want neither of the above, you can suppress the appearance of the license manager message using '-m:IMAGE_PROVIDER_CLASS=' option on the generator Java command line. For instance, here is how you should modify the last command in the supplied generator.bat:
"%JAVA_HOME%\bin\java" %JAVA_OPTIONS% -cp "%CLASS_PATH%" xyz.flexdoc.xml.Generator -m:IMAGE_PROVIDER_CLASS=
That effectively means setting the generator to use no diagramming plugin.

See Also:

Trial Mode

Trial mode is activated in the presence of a Trial License for DiagramKit, which will work with full functionality and generate all possible diagrams (with all hyperlinks). However, there are following limitations: You can request a trial license by clicking this button:

Then, you will be redirected to Try | Trial License page with “FlexDoc/XML (essential)” preselected in the «Product» field.

“FlexDoc/XML (essential)” means that you get in fact not a single but a package of trial licenses (corresponding all full ones): all of them together in a single 'flexdoc-xml.license' file, which you will receive by email.
The license file should be saved in FlexDoc/XML 'lib' directory (near 'flexdoc-xml.jar' file):


where '{flexdoc-xml}' denotes your FlexDoc/XML installation directory.

See Also:

Full Mode

Full mode is activated in the presence of a Full License for “FlexDoc/XML DiagramKit”. It allows you using DiagramKit without limitations. All diagrams will be generated clean (without any watermarks).

Please Note:

See Also: