FlexDoc/XML - XSDDoc (XML Schema Documentation Generator)

FlexDoc/XML v1.14 released! See new README, Change Log, XSDDoc v3.0README, Change Log.

XSDDoc is included in FlexDoc/XML archive ready for downloads now!

  1. What is FlexDoc/XML XSDDoc?
  2. What you can generate with it
  3. What is processed/documented
  4. Documentation Features
  5. Possibility of unlimited customizations
  6. Getting Started
  7. Licensing

1. What is FlexDoc/XML XSDDoc?

A powerful XML Schema documentation generator that will help you to create a unified HTML or RTF documentation (with XSD diagrams) for any number of XML schema files.

It is implemented in the form of «XSDDoc» template set for FlexDoc/XML.

FlexDoc/XML is a software system for development and execution of high-quality documentation and report generators from any data stored in XML files. XSDDoc is an application of it. For more details, please see: FlexDoc/XML | Overview, Features.
XSDDoc includes two main templates: XSDDoc template set is found in 'templates/XSDDoc/' subdirectory of FlexDoc/XML archive or installation. It is ready to use. Please read Getting Started!

2. What you can generate with it

Framed HTML Documentation

Using FramedDoc.tpl main template, you can generate a multi-framed HTML documentation by any number of W3C XML Schema definition (XSD) files. It looks similar to JavaDoc and provides most detailed and easily accessible information about all XML schema components as well as any interconnections between them.

Here you can see some samples of such a documentation (click on a screenshot to view the real HTML):

The following functionality is supported:

Please, take a look also at XSDDoc | Examples page for more samples of HTML documentation generated from various large XML schemas found on Internet.

Single-File Documentation

SingleDoc.tpl is another main template that generates the entire XML schema documentation as a single file/document, which can be in any supported output formats (primarily HTML and RTF).

HTML Documentation

With SingleDoc.tpl main template and the output format set to «HTML», you can generate a single-file HTML documentation. On the left is a demo documentation generated in that way (click on the screenshot to view HTML).

RTF Documentation

Using SingleDoc.tpl main template with the output format set to «RTF», you can generate a single-file RTF documentation by any number of W3C XML Schema definition (XSD) files. It is built of the same basic blocks as the framed HTML documentation (which are actually generated by the same subtemplates) with a few additional features.

These screenshots show pages of a demo RTF documentation (click to enlarge):

The following features/functionality are supported:

PDF Documentation

FlexDoc/XML currently generates no PDF directly. However, you can produce quite decent PDF from RTF using some converters. Here is an example of the XML schema documentation in PDF format created in that way (click on the screenshot to see/download the PDF file, 7.7 MB):

3. What is processed/documented

Any number of input XSD files

All referenced XSD files

You just need to specify only the root XSD files of your project. Everything referenced from them will be loaded automatically!

Any XML schema design patterns

Like a single XML schema describes the structure of infinite number of XML files, the structure of the same XML file could be described by a great (potentially infinite) number of XML schemas. All of those XML schemas would differ from each other by ways of how they are designed. Those ways are called XML schema design patterns. Some of them were given even special names: chameleon, russian doll, salami slice, venetian blind, etc.

When you design a schema, you definitely use some of those design patterns, even when you haven't heard of them. Simply, in that case you reinvent the pattern by yourself. When a schema is generated by some tool, it always follows a certain pattern.

So, how do all those design patterns differ from one another in respect of documenting them? Or asking it otherwise, what might be common? If you look closely into this, you could notice that all XML schema design patterns come down to a few specifics, all of which can be addressed by a single documentation approach:

Design Pattern Specific How It's Handled
The entire XML schema is broken into a number of XSD files, some of which import/include others. You don't need to do anything special about this. Both <xs:import> and <xs:include> XSD elements are supported. All referenced schemas will be automatically loaded and documented.

Moreover, using template parameters:

you can even specifically disable documenting of imported/included schemas (even though they will be processed still).
There are several XSD files and some of them redefine certain components declared within others. That is done using <xs:redefine> XSD elements, which are processed/documented by XSDDoc very well!

See Also: Documenting of redefinitions

Some elements are declared locally. Such elements may share the same name, yet have different content models. Others may be absolutely identical (with equal names and based on the same global type), yet declared separately in numerous locations. If you document all of that straight (which is actually what all other known to us XML schema doc-generators always do!), in certain cases you may get in your XML schema documentation a mess made of numerous repeating local element names, in which it could be difficult to find some useful information.

XSDDoc provides two ways of dealing with that problem:

Locally declared elements are used everywhere instead of attributes to hold simple data. Again, if you document it straight, various navigation lists and element summaries will get overwhelmed by insignificant local elements, in which you may have trouble to find what you need. XSDDoc provides a remedy to deal with this too, by documenting local elements in two ways: globally and locally.

See Also: Global and local documenting of local elements

There are groups of globally declared elements referenced across the schema via few abstract elements representing any element in a group. Such groups of elements, called substitution groups, are specifically recognized and processed/documented by XSDDoc.

See Also: Documenting of substitution groups

The order in which elements/attributes are declared is important. Using the following template parameters you can preserve the original ordering of your elements/attributes at various locations of the documentation:
XML schema declares a possible root XML element that needs to be highlighted in the documentation. In general, the W3C XML schema specification provides no functionality to assign which of the XML elements declared in XML schema must be the root of any XML document that complies with that schema. However, in many concrete situations, such an intention very much exists and needs to be documented somehow.

To solve that problem, we have introduced a concept of top-level elements.

Top-level element is the one, which satisfies the following conditions:
  1. It is a global element (that is defined as a child of <xs:schema>)
  2. It is not abstract
  3. It has no parents in the same namespace. Precisely, the element is not included directly or by substitution in the content model of any other elements defined in any XML schemas targeting the element's namespace.
When an element matches all of those criteria, most likely it will be used as the root element of some or all XML documents described by the given XML schema.
Typically, very few such elements can be found in an XML schema (possibly one or two per a namespace). Using this template parameter:
Generate Details | Elements | Separate Top-Level Elements
you can separate the top-level elements and thereby highlight what you intended to be the main element in your schema (e.g. <xs:schema> in XML schema for XML schemas).

If the separation of top-level elements doesn't work for you, alternatively, you can declare the root element the first in your XML schema. Further, when you generate documentation for that XML schema, unselect the template parameter:

Generate Details | Sorting | Components
That will preserve the original order of element declarations in the documentation.

If your XML schema is broken into several XSD files, specify the one of them that contains the root element declaration to be processed the first by the generator and unselect the parameter:

Generate Details | Sorting | Schemas
That will ensure that the root element gets on the top of various navigation lists and summaries, which will highlight its special role.

Joint documenting of conflicting XML schemas

Conflicting XML schemas are those that define the same components (that is with the same local name and in the same namespace). For instance, different versions of some your XML schema project will likely contain conflicting XML schemas.

Since the version 2.6.0, XSDDoc is able to document correctly any number of conflicting XML schemas!

Straight documenting of several conflicting XML schemas together will likely produce incorrect documentation. Some links from the references to global components defined simultaneously in different schemas would go to wrong locations. What's more, the content models of some components (as well as other things) may be derived incorrectly. As a result, the whole such a documentation may be almost unusable. Yet, those conflicting schemas themselves may be quite correct at that!

Here's how documenting of conflicting schemas works:
  1. Among all XML schemas initially specified for documenting, the main schemas are identified. These are the schemas that are not referenced from other schemas. Here, schema reference is any of the elements: <xs:import>, <xs:include> and <xs:redefine>. Note that any conflicting schemas, if they are correct indeed, cannot reference to each other (both directly and indirectly)!
  2. The main schemas break everything into several domains adding to each name a sort of extra "namespace". This makes possible to resolve global component references only within a particular main schema domain, which the given reference belongs to.
  3. Some XML schemas involved here may be those referenced from several conflicting schemas simultaneously. These must be some library schemas valid in all cases. For instance:
    <xs:import namespace="http://www.w3.org/XML/1998/namespace" schemaLocation="http://www.w3.org/2001/xml.xsd"/>
    Such schemas will belong to all domains at once. They will be documented only once. All links to the components defined in them will go to the same documentation locations from anywhere those components are used.
  4. In the case of multi-file framed HTML documentation, if the names of conflicting XML schema files are repeating too, the components of those schemas will still be documented in separate subdirectories. Normally, such a subdirectory name is derived from the name of the XML schema file. If that name duplicates another schema's name, it will be extended with a numeric suffix so as to make the subdirectory unique. For example:

XHTML tags in your descriptions/annotations

Below is a demo of what can be achieved using XHTML markup in XML schema annotations. On the left you can see the XML source of an XML schema, whose annotations are heavily laden with XHTML markup (including insertion of images). The next is the framed HTML documentation generated by that schema (click on screenshots to see the actual HTML):

The last two screenshots show pages of the RTF documentation generated by that schema (click to enlarge). Here, you can also download a PDF converted from that RTF: HumanEvolution.pdf

See Also:

Support of XML Catalogs

XML catalog(s) may be used in a large XML schema project to avoid referencing separate XSD files from each other by direct file names. You may also want to use an XML catalog when some XSD files involved in your project are located differently as they are specified in other XSD files.

See Also:

4. Documentation Features

This section highlights some advanced features, which you rarely find in other documentation generators. That makes our tool so special!

Highly navigable framed HTML documentation

The idea comes from Javadoc:

Frame Usage
Overview Frame The primary navigation frame. Here you select some large-scale scope, e.g. a namespace or an XML schema.

Related template parameters: Navigation | Overview Frame

These are navigation frames, where you can quickly find what you need without disturbing the current view of the detail document.
List Frame Used to display one of the second-level navigation lists associated with a particular selection in «Overview Frame». Here you select a particular XSD component within the selected scope.

Related template parameters: Navigation | List Frame

Detail Frame Shows the details of the selected item (e.g. namespace, XML schema or component).

Related template parameters: Navigation | Detail Frame
This frame is used to display the actual documentation content

See Also: Framed HTML Documentation

Dense layouts: more information in less space

Our template technology (see FlexDoc/XML | Features) allows for fast programming of complex table-based grid layouts.

Using it, it is possible to generate such things as shown on the left screenshot (click to enlarge).

You may think: What's special here? Just yet another page of some documentation... But it uses three grid layouts! If that technique was not applied, the information printed on that page would occupy 2-3 pages instead!

Abundance of cross-links

When you look at a documentation generated by our tool, you can see a lot of hyperlinks. Everything seems to be a hyperlink!

Cross-links are produced by matching sets of special keys generated for both link source and destination. The keys represent actual data being linked. Their generation is specified in templates along with the generation of the corresponding pieces of output. In that way anything can be cross-linked together. At that, if a particular set of keys cannot be matched, an alternative set of keys can be specified as well. That means, when the primary target is absent, the link can go to some alternative location related to the link source.

For instance, when in a reproduced XML source the value of some attribute is the name of some XSD component, that value is linked to the component detail. But when the detail is absent, the link can go to a corresponding item in some component summary:

In RTF documentation intended for printing, some cross-links can be emulated with page number references that appear in square brackets after the linked item, as visible in the above screenshot.

See Also: FlexDoc/XML | Features | Hypertext | Cross-Reference Links

Documenting of local elements

This XML Schema documentation generator possesses a unique capability to document all local elements defined in your XML schemas. In fact, we have never seen anything like this in any other software/tool supposed to generate XML schema documentation!

What are local elements?

Local Elements are those element components that are defined locally within: Local elements represent a challenge to document. Here are typical problems with them and the solutions XSDDoc provides:

Problem Description/Solution
Locally declared elements are used everywhere instead of attributes to hold simple data. Documenting them straight (together with global elements and local element with complex content) may result in that various navigation lists and summaries get overwhelmed by insignificant items. That may greatly reduce the clarity of the documentation and impede its navigation.

Solution: Global and local documenting of local elements

There are many element declarations with the same name but based on different types. Since the introduction of local elements in W3C XML Schema language, there is no strict relationship between the element name and its type for the entire scope of the XML document. Now, within the same XML document, you may find several different XML elements that although share the same name, actually represent more or less different things and, therefore, may have different attributes and content. It is clear that such equally named but essentially different local elements must be documented separately.

Solution: Adding extensions to local element names

Certain local elements share the same name and the same global type, yet are declared separately in numerous locations. In many cases local elements are declared very simply:
<xs:element name="elementName" type="typeName"/>
In such a declaration, an element is totally defined by its type, which is a global one. An XML schema may contain many such simple declarations, where {elementName, typeName} pairs are repeating. Documenting all of them separately will result in multiple equally looking items surfacing in various lists, yet describing essentially the same thing.

Solution: Unifying local elements by type

Global and local documenting of local elements

Local elements can be documented simultaneously in two ways: globally and locally.

The purpose of two types of the documentation is that some elements may be important to show in the navigation lists, whereas other elements (particularly those with predefined simple content that essentially play the role of attributes) are better to be documented locally where they are defined/used. Exposing such insignificant elements in the navigation lists and summaries (along with the global elements or those with complex content) may blow out and overwhelm such lists and make them difficult to navigate.

As an example, here are two documentations generated for the same little XML schema (from “Sales Report” sample).

Global Documenting

Global documenting of local element means generating for it the full Component Documentation block/page that includes all possible details about the element. In the case of framed HTML documentation, such an element will also appear in the component lists shown in the documentation List Frame (on the left).

On the left screenshot is the XML schema documentation with all elements (both global and local) documented separately (globally). Click on the screenshot to view the doc.

Local Documenting

Local elements can be documented also locally together with their parent components where they are defined. In that case, the local element is documented the same as attribute. That documentation appears in the Content Element Detail section of the Component Documentation block/page generated for the element's parent component and may contain fewer details.

On the left screenshot is the XML schema documentation, in which only global elements and local elements with complex type are documented separately. All local elements with simple content are documented locally. Such a documentation may appear tidier and easier to navigate. Click on the screenshot to view it.

Related Template Parameters:

Adding extensions to local element names

Using local elements, you can define in an XML schema several element components with the same name but different content. That's OK to verify an XML file (for which XML schemas are typically used). But it creates a problem for documenting. Since the main purpose of the documentation is to show relations between components, all element components eventually surface globally. For instance, when you have a list of some element components that share particular properties, very likely it will include several local elements with the same name. If nothing is done about that, you will see repeating names in that list, which may look quite confusing.

XSDDoc solves that problem by adding some extensions to the repeating element names, which make those elements unique. The extensions are generated according to:

On the screenshot (left) you can see how element name extensions look (the grey text).

Related parameter: Show | Element Name Extensions

Unifying local elements by type

When a single name is used for several element components that means they share something common. Sometimes that 'common' comes down to the element type. For instance, in many XML schemas instead of defining a single global element and reference to it from many locations, multiple identical local elements are declared like this:

<xs:element name="someName" type="typeName"/>

You've got lots of local element components that define effectively the same thing. So, instead of flooding the documentation with repeating element names, why not to document all those local elements (with the same global type) as a single one? We shall call it unified local element and its name extension (when necessary) will be just the name of that global type.

Here's how it works:

On the left you can see a documentation generated with such unification. On the right, all local elements are documented straight as they are. We think the first documentation (on the left) is much easier to understand. Click on the screenshots to view the docs.

Related parameter: Generate Details | Elements | Local Elements | Unify By Type

List of containing elements

When you look at details of an XSD element component (produced by any doc-generator), you will typically see which children an XML element represented by that component may have. But it is equally interesting to know the possible parents of an XML element! Specifically, the list of those XSD element components, whose content model includes the given one.

Here is an example of such a list (click on the screenshot to see it within the documentation).

Related parameter: Details | Component Documentation | Lists Of Related Components | Containing Elements

Documenting of redefinitions

Redefinition of an XML schema is a type of its inclusion into another schema using <xs:redefine> element, during which some components defined in the included schema may be replaced with equally named components however defined differently (redefined) within the <xs:redefine> element. Those redefinitions are typically derived from the previous versions of the same components.

A component may be redefined any number of times (in different XML schemas calling one another through <xs:redefine> elements). Each redefinition creates a new version of the component. XSDDoc documents all such versions (including the initial one). To distinguish them, an extension is added to the component name showing the component version.

On the following composite screenshot you can see a 'family' element group redefined two times (all three versions in the same list on the left and the diagram of the last version on the right):

Here you can see documentation generated by a real XML schema with redefinitions: “XML Schemas for XHTML 1.1

Documenting of substitution groups

Substitution group is a group of globally declared elements (called group members), each of which may substitute for the same element (called group head), specified in member element definitions with substitutionGroup attribute.

XSDDoc recognizes substitution groups and documents them both in the documentation (as member list, list of possible parents by substitution and so on) and on the diagrams (as a special branch with group member elements attached to the group head).

On the screenshot (left) you can see the XML schema documentation, generated by an XML schema that uses substitution groups. Click on the screenshot to view it.

See also XML schema for MathML 3.0, which extensively uses multilevel substitution groups. In order to make the diagrams generated by that schema managable, the substitution groups are shown only by the root nodes of head-element diagrams, which is controlled by the parameter: DiagramKit | Show in Diagram | Substitution Groups
Related template parameter:

Documenting of complex content

Component Diagram

Component diagram can be generated for elements, complexTypes and element/attribute groups.

The diagram provides:

Component diagrams are generated by a diagramming plugins, of which there is currently one:
FlexDoc/XML DiagramKit
This is the native diagramming engine of FlexDoc/XML. It works synchronously with the Template Processor and generates beautiful XSD diagrams with the support of all features mentioned above along with all possible hyperlinks (including even from some properties). The diagrams are immediately inserted in the documentation output produced by XSDDoc.

All diagrams visible on this page and in all XSDDoc examples have been generated by DiagramKit.

The following screenshots are two diagrams of the same XSD component. On the left is the diagram with the element/attribute properties. On the right is the diagram without the properties. Click on the screenshots to see each diagram in full size within the corresponding documentation:

For further details, please see: FlexDoc/XML | XDDDoc | FAQ | How to include diagrams?

XML Representation Summary

XML Representation Summary section can be generated for each schema component. It provides a schematic text representation of all possible XML elements this component describes as well as how such elements may look in XML file. This includes: Here is how such an XML Representation Summary looks:

Element Content Model, which represents all possible combinations of child elements, appears in XML Representation Summary of some elements (see 'Content' field on the picture above), complex types and element groups.

Element Content Models are represented using Kleene operators (the same as used in XML DTD) extended with two more operators to cover all situations allowed by W3C XML Schemas. The following table shows all operators used in Element Content Model representations:

Operator Description
, sequence
| choice
() grouping
? 0 or 1 times
+ 1 or more times
* 0 or more times
Extended operators
× The idea of this operator can be expressed by the formula:
a × b = ((a, b) | (b, a))
This operator is used in two situations:
  1. To represent an unordered content model (which is the one defined using <xs:all> compositor)
  2. To represent a mixed content model (i.e. when any text is allowed before, between and after elements).

    For example, a content model for formatted text used in messages at some forum websites (that is, a text with allowed italic, bold and code markup) may be represented as the following:

    {text} × (i? | b? | code?)*

[n1, n2] General cardinality operator (n1 can be 0 or any number; n2 is any number or *).

It is used in those rare situations when Kleene cardinality operators (?, +, *) are not enough.

For example:

is the same as

Related template parameters: Details | Component Documentation | XML Representation Summary

Table Representation

This is the third alternative way to represent the complex content defined by an XSD component – the most complete and easy to understand. It consists of two tables like shown on the following screenshots:


Content Element Model

Such Table Representations can also include the full or partial description of each attribute and content element. Thereby, they can be used as a light-weight compact documentation of those attributes and elements.

However, it does not work for all cases. If the complex content is defined within a local element itself (using an anonymous complex type), that cannot be documented only in such a way.
The Table Representation can be generated for the same component types as diagrams:

Documenting of XML source

The XML source of the whole XML schema file is included in the «Schema Source» page/block (see below on the left screenshot; click to view). Equally, the XML source defining a particular component can be included in «Schema Source» of «Component Documentation» (the right screenshot):

That XML source is actually reproduced from the DOM representation of the schema file. However, it closely follows the original one enriched with the following features:

Related Parameter: See Also:

5. Possibility of unlimited customizations

Template parameters

Since all content and formatting of the generated documentation is programmed entirely in templates, the numerous options and switches, which normally control traditional documentation generators, now simply become template parameters.
Template parameters are easy to introduce and access in templates, so there may be lots of them. That allows you to adjust the generated output within a greater range of various details, thereby squeezing the most from what is already programmed in the existing templates without changing anything in them.

On the other hand, to avoid overwhelming the user with too many unimportant settings, many template parameters inherit or derive their default values from other top-level parameters. So, you actually need to change only a few of them. The entire parameter set is organized in a tree, which makes it easier to understand and navigate. That tree is displayed in the Parameter Inspector as shown below.

See Also: FlexDoc/XML | Features | Template-driven architecture | Template Parameters

XSDDoc is controlled by more than 400 parameters, which you can specify in Parameter Inspector invoked from the generator GUI (when you click «Params» button with one of the main templates selected):

Alternatively, you can specify any template parameters through Java command line using -p option.

See Also:

Generator options

Generator options are more traditional things. They control particular features of the selected output generator (that is what is hardcoded in Java code).

Generator options are separated from templates. They do not depend on the selected template as well as their settings are not used in templates at all. That's because templates are designed to be mostly independent of the particular output format. Only some general assumptions about the output format are accounted, for instance, whether it supports pagination and has page numbers.

Which particular generator options are available depends on the selected output format, which currently may be HTML, RTF and TXT (plain text). In the generator GUI, after you have selected the destination output format, you can click «Options» button, which will invoke Format Option Inspector. Here you can see all options available for the given format and specify them. This screenshot shows the HTML Option Inspector:

Alternatively, you can specify any generator options (along with template parameters) through Java command line using -o option.

See Also:

Using custom CSS styles

You can apply also your own CSS styles to change how the generated documentation looks.

On the left you can see a documentation generated with the default formatting as specified in XSDDoc templates. On the right, the same documentation generated with the application of a custom CSS stylesheet. (Click on the screenshots to view the docs.)
That stylesheet is provided along with the XSDDoc templates as the file: {flexdoc-xml}/templates/XSDDoc/css/azure-theme.css

How to specify it is shown in the HTML Option Inspector screenshot above. You should set:

  • Output | CSS | Generate named rules = all
  • Output | CSS | Generate named rules | Custom rules file = Stylesheet file path name

Note that the possibility to use any CSS stylesheets is available only under the “FlexDoc/XML SDK” license (which covers the Template Designer).

See Also:

Modifying templates with Template Designer

If template parameters and CSS styles are not enough, you can modify the templates themselves using the Template Designer:

Template Designer is a highly sophisticated GUI used to design/edit templates. It represents the template both in the form template components, which it is made of, and the output those components would generate.

This screenshot shows XSDDoc/lib/element/contentElements.tpl template open in the Template Designer (click on the screenshot to see in full size). That template generates the Content Element Detail section of Component Documentation.

Note that all content and formatting you see in the generated output is programmed entirely in templates. In that respect, FlexDoc templates are not exactly “templates” in traditional sense (which typically serve to arrange how some output fragments readily provided by the generator are placed in the result output). Rather, FlexDoc templates are more akin to XSLT scripts. For more details, please read: FlexDoc.XYZ | Overview.

Template Designer is covered by the separate “FlexDoc/XML SDK” license, which you need to acquire along with “FlexDoc/XML XSDDoc” license, if you want to modify XSDDoc templates.

See Also:

6. Getting Started

You can try XSDDoc right now, without any registration! Just download FlexDoc/XML zip-archive and follow the instructions below.

By default, everything will work in demo mode. You will be able to generate a reduced documentation (including diagrams) by any your input XSD files. If they are small enough, that will be actually the complete documentation, which you can use for free! For further details, see Licensing.

How to run XSDDoc?

This section was moved to FlexDoc/XML | XSDDoc | FAQ. Please follow the links to jump directly to the corresponding content:

How to include diagrams?

This section was moved to FlexDoc/XML | XSDDoc | FAQ | How to include diagrams?

How to integrate with Ant/Maven?

A demo about that you can find in your FlexDoc/XML installation:
See Also:

7. Licensing

Demo Mode

Once you have downloaded FlexDoc/XML archive, you can run XSDDoc immediately and see what it is. You don't need to request any trial and register anywhere!

By default, everything will work in demo mode. It means that all your input XSD files will be fully processed, however fully documented will be only limited number of components. Component diagrams will be generated as well by any diagramming plugin you choose and as many as it's allowed by XSDDoc demo limits. What exactly the demo limits are depends on a particular main template (as well as some metrics).

If those limits are not reached, you will get the complete documentation. Otherwise, some content will be omitted and the message included saying which limits were exceeded. Anyway, the result documentation will be minimally distorted, to allow you to evaluate how everything will look under the full license. Any documentation generated in demo mode is yours. You may use it for free as you wish.

Template Designer will work in demo mode as well. You will be able to run it, investigate some functionality, but unable to save any created/modified templates.

See Also:

Trial License

The standard package of trial licenses (see below) unlocks full functionality of XSDDoc / DiagramKit / Template Designer. You will be able to evaluate how everything works, generate the complete documentation by all your XSD files. It will include all possible details (according to the settings specified in template parameters). All XSD diagrams will be generated as well.

But there will be some limitations:

You can request trial license by clicking this button:

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

“FlexDoc/XML” 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 Licenses

The whole functionality described on this page is covered by three different full licenses:

License Description
FlexDoc/XML XSDDoc Unlocks all functionality implemented in XSDDoc templates. In particular, you will be able to:
FlexDoc/XML DiagramKit Unlocks all functionality implemented in DiagramKit. Allows you to generate XSD diagrams and automatically insert them into documentation generated by XSDDoc (with the support of all possible diagram hyperlinks).
FlexDoc/XML SDK You need this license if you want to heavily customize the generated documentation (e.g. change some colors, fonts, layouts, look & feel, add new functionality etc). In particular, this license covers:

Please note that neither commercial template applications themselves (e.g. XSDDoc) nor diagramming plugins are covered by this license!

See Also:

Which Licenses You Need - Use Cases

You don't have to purchase all full licenses listed above – only those required for your particular goal:

Your goal The license(s) you need
  1. FlexDoc/XML XSDDoc
  1. FlexDoc/XML XSDDoc
  2. FlexDoc/XML DiagramKit
  1. FlexDoc/XML XSDDoc
  2. FlexDoc/XML SDK
  1. FlexDoc/XML XSDDoc
  2. FlexDoc/XML DiagramKit
  3. FlexDoc/XML SDK

You can order any combination of those licenses starting from Store page.