www.flexdoc.xyz

Licensing

1. Licensed Entities
2. Free License

   2.1. Generated Output

3. Demo License

   3.1. Generated Output

   3.2. Templates

4. Trial License

   4.1. Generated Output

   4.2. Templates

5. Full License

   5.1. Single-User License

   5.2. Site License

   5.3. Delivery & Activation

   5.4. Operating Systems & Execution Environment

   5.5. Maintenance and Support

   5.6. Upgrade Possibilities

   5.7. Generated Output

   • Involvement of other License types

   5.8. Templates

6. Licensing of Templates

   6.1. Basic Templates

   6.2. Commercial Template Applications

   6.3. Custom Templates

   • Changing Templates Manually

7. Multiple Licenses

   7.1. Example

8. Getting Help

1. Licensed Entities

By its nature, FlexDoc software can be described simultaneously in three different categories:

1. A software development tool, which manifests itself as the Template Designer (as well as the template language it visualizes).
2. A run-time environment, which is the Template Interpreter / Output Generator.
3. Template applications that implement particular end-user tasks (e.g. XML Schema Documentation Generator).

Although those pieces represent parts of the whole software system, essentially, they are intended for very different purposes. Therefore, not everyone needs all of them. Yet each of those parts cost great efforts to develop and cannot be given away totally free.

Breaking the software into different editions does not solve the problem completely, because this cannot cover all possible usage scenarios: either someone will have to pay for what they do not actually need or we are forced to give away valuable features without any compensation for them (and, therefore, will have little funds to develop them further).

The goal of this licensing system is to allow people to pay exactly for what they actually want to use and, at the same time, to keep the integrity of the software as a whole. That is achieved by introducing multiple licenses covering different groups of related features/functionality. These are called licensed entities.

It works as follows. A particular software package is always the same and may include lots of functionality (for instance, FlexDoc/XML or FlexDoc/Javadoc). Without the proper licenses that functionality works only in a reduced or demo mode (see Demo License). When you want to use some set of features grouped under the licensed entity «A», you buy a Full License for «A». If you need more features that belong to the licensed entity «B», you buy another license covering «B». Both (or more) licenses can be installed together. As a result, you get software that does what you need and pay only for what you use.

There are following types of licensed entities:

Licensed Entity	Details
SDK (System Development Kit)	First of all it includes the Template Designer – a high-quality GUI to create/modify templates. The «SDK license» covering it essentially provides a possibility to create/modify templates. Above that, SDK license may cover some extended functionality of the Generator (see below). SDK license may be a Demo, Trial or Full License. Currently, there are two SDK licenses: License for FlexDoc/XML SDK License for FlexDoc/Javadoc
Template Interpreter / Output Generator	This is the run-time environment to execute templates (called «Generator» for short). The result of its working is typically some number of generated output files (that is the output documentation). The most part of the Generator functionality is provided under the Free License. That is called «free Generator» and always available immediately as the Generator being run. However, some extended functionality (for instance, the possibility to execute trial templates) is unlocked only in the presence of a Trial/Full SDK License.
Template Application	Template applications implement what FlexDoc software is all about – particular documentation generators. From the point of licensing, all template applications are divided into the following categories: Template applications developed by Filigris Works (and provided with the downloaded software). This includes: Basic Templates, which implement some basic or sample functionality. They are provided under the Free License. Commercial Template Applications, which implement some general very complex tasks (e.g. XML Schema Documentation Generator). They are provided under a Demo, Trial and Full License. Currently, there are two commercial template applications: FlexDoc/XML XSDDoc FlexDoc/XML WSDLDoc Custom Templates, which are those developed by users. First of all, to be able to create any custom templates, you will need an SDK license (trial or full). The SDK license also allows running any your custom templates. However, if you want to run them also with the free Generator, the SDK license, under which your custom templates were modified (i.e. saved) the last time, must be the Full one. Saying it simply, in order to use your custom templates, you need to buy a Full License for SDK (covering the Template Designer) at some point. Further, there may be the following situations: Your custom templates were developed completely by you to solve your own specific tasks. In that case, you don't need to license anything concerning templates. Your custom templates were derived (by modification) from some templates developed by Filigris Works (which are included in the downloaded software). In that case, your custom templates are licensed under the same license that covers the original template application. For more details, please see: Licensing of Templates
Diagramming Plugin	Diagramming plugins are special Java-hardcoded modules that generate graphical representations (i.e. charts, diagrams) of various things described by the data processed by the templates. Although diagramming plugins are held in the same single FlexDoc executable jar-file, they are not parts of the Generator. Rather, they may be considered as functional extensions of particular template applications and are controlled and invoked from the templates. See also: FlexDoc/XML | Features | Diagramming Plugins

For more details about how different licenses work together, please see:

• Multiple Licenses

For help to decide which exactly licenses you need take a look here:

• FlexDoc/XML | XSDDoc | Which Licenses You Need - Use Cases
• FlexDoc/XML | WSDLDoc | Which Licenses You Need - Use Cases

2. Free License

Free License is provided for some Filigris Works software components to allow using them free of charge.

The most important of such components is the Generator, which allows you to run the template applications. Others are Basic Templates.

2.1. Generated Output

When the output documentation was generated only under Free License(s), it is free for any possible usage. In particular:

• You may change the content of the generated files in any way you need, e.g. edit/remove some blocks, add your own, etc.
• You are free to distribute your generated/modified documents with no limitations.

When, during the generation of any output files other types of licenses were involved, the whole result is governed by those licenses.

See also: Multiple Licenses

3. Demo License

Demo License is currently provided for some Filigris Works software components.

Demo License is available free of charge once you have downloaded the software covered by it. The license is activated automatically each time you run the software (and no corresponding trial or full license found). No registration is required for that.

Under Demo License, the software works in demo mode, which is interpreted as follows:

Software Type	How it works in Demo Mode
Commercial Template Applications	No restrictions on whatever functionality. However, only limited number of major items (e.g. XSD components, Java classes etc.) are fully documented, which depends on the demo limits embedded in a particular template set (and main template) you run. When the demo limits are not exceeded (on small input data/projects), you will get the complete documentation without any distortions! Otherwise, some content will be omitted and the messages included saying exactly which limits were exceeded. Anyway, the result documentation will be minimally distorted to allow you to evaluate how everything would look under the Full License.
Diagramming Plugins	No restrictions on whatever functionality. However, only a limited number of diagrams is generated according to the demo limits embedded in a particular template set (and main template) you run, with which the plugin works. When the demo limits are not exceeded, you will get all diagrams! Otherwise, some diagram sections in the output will show up with omitted content and the messages included saying which exact limits are exceeded. Anyway, those diagrams actually generated will be complete, with all possible hyperlinks and undistorted with any watermarks. So, you will be able to evaluate how everything would look when generated under the Full License.
Template Designer	You will be able to investigate any functionality, however unable to save any created/modified templates.

Demo License has no limitation in time. You may use the software under the Demo License as long as you comply with the license terms.

3.1. Generated Output

The output documentation and diagrams generated under Demo License are free for any possible use. In particular:

• You may change the content of the generated files in any way you need, e.g. edit/remove some blocks, add your own, etc.
• You are free to distribute your generated/modified documents and diagrams with no limitations.

3.2. Templates

Demo License does not allow you to create or modify any templates.

Template Designer will work only in demo mode. You will be able to investigate any functionality, however unable to save your created/modified templates.

For further information, please see: Licensing of Templates

4. Trial License

Trial Licenses are provided for those software components of Filigris Works that are available for Commercial Licensing.

The purpose of the Trial license is to allow you for free to evaluate all functionality you are interested in (and check that everything works properly as you expect) before buying the corresponding Full License.

Under a Trial License the software will work the same as under the corresponding Full License:

• All implemented functionality (covered by the Full License) is unlocked
• No limitations on the input data, number of documented items, number and size of the output files etc.

A Trial License is generated automatically per your request and the license certificate is emailed to the provided address. The license certificate represents a plain text file with the information about your license. The received license file should be installed together with the installed Software according to the provided instruction.

A standard Trial License is valid for 30 days. You may request for an extension of your Trial License for another 30 days. However, that possibility may be limited.

If you have any problems or questions concerning your trial, please let us know by sending an email to: support@flexdoc.xyz

4.1. Generated Output

Any output files generated under one or multiple Trial Licenses may be used for evaluation purposes only. You are strictly prohibited to use the generated documentation (or any parts of it, including diagrams) for any other tasks.

To enforce that condition

• All output documents (in both HTML and RTF formats) generated under at least one Trial License will be distorted by replacing some letters with shade ('░') characters. Additionally, at the end of each generated output document there will be a trial message like the following:

  

  where you can see which Trial Licenses were used (involved) in the generation of that particular document.
• All diagrams generated by Filigris Works own diagramming software (e.g. FlexDoc/XML DiagramKit) working under a Trial License will contain special watermarks, like on this screenshot:

  

As soon as you acquire the corresponding Full License(s), no text distortion, trial messages or watermarks will appear!

4.2. Templates

You may create/modify any templates under a Trial License that covers the Template Designer (i.e. SDK license).

For further information, please see: Custom Templates

5. Full License

Full License is also referred to as «Commercial License», and the software components, to which it is available, – as «commercial» ones.

A Full License unlocks all functionality, which the Software has been designed for, in respect of the licensed features.

Currently, there are two kinds of Full License that stipulate some restrictions on how the Software may be used:

1. Single-User License
2. Site License

5.1. Single-User License

A “Single-User License” is a non-exclusive, perpetual, royalty free Full License for the Software, which grants the right for a single user to use the Software according to the following restrictions:

• The License may be installed and used on any computer, however, only on ONE SYSTEM at a time. Once the License is not needed on the first system (where it was installed initially), it may be installed on another system and used there. At that, the License must be uninstalled (removed) from the first system.
• The License may be used only by ONE PERSON AT A TIME, who is either the Licensee him-/herself or works for the Licensee when it is a company/organization. For instance, the Single-User License may not be installed on a server and called directly or indirectly by several people.

  Precisely, that must be interpreted as follows: A person, who runs the Software is meant to be USER. That person should not change more frequently than once per 30 days. Otherwise, more Licenses (or a different type of License) must be purchased.

The Licensee may be a person or organization.

In case of a person, the Licensee is identified by:

• Person name
• Postal address
• E-mail address

In case of a organization, the Licensee is identified by:

• Organization name
• Postal address
• The name and E-mail of the license admin — a person, who will be responsible for maintaining/managing the License

The Single-User Full License may not be transferred to any other individual or organization, except the direct successor of the Licensee, who takes over the full legal rights and responsibility over the Licensee business.

5.2. Site License

A “Site License” is a non-exclusive, perpetual, royalty free Full License for the Software that is valid for one authorized site (“Licensee Site”), which must be a specific geographic location of the Licensee business that is defined by its physical address.

A Site License grants you the following rights:

• To install and run the Software on any computers located at the Licensee Site or any virtual servers that are controlled, managed, and either owned or leased by the Licensee Site.
• To use the Software concurrently by multiple persons including remotely (from any location on the globe), provided they are employees of the Licensee Site or hired to work on the projects hosted and led by the Licensee Site.

If projects that are hosted and led at different or multiple sites need to access the Software, each such site requires a separate License for the Software.

The Licensee Site is identified by:

• Organization name
• Physical address of the site authorized to use the License
• The name and E-mail of the license admin — a person, who will be responsible for maintaining/managing the License

The Site License may not be transferred to any other individual, organization or site, except when that was explicitly approved by the Licensor.

5.3. Delivery & Activation

The Software is only available through electronic delivery via the Internet (see downloads). The fully functional version of the Software is unlocked by the License Certificate (key) sent to the user via e-mail to the specified email address.

The License Certificate represents a plain-text file with the information about the License and the Licensee. The license file should be installed together with the Software according to the provided instruction. After that, the Software will be ready for any use.

FlexDoc Software currently implements no specific license manager and activation procedure that checks and enforces the number of concurrent users and other restrictions of the License. You should ensure this by yourself so as to comply with your License terms. If you cannot control that, you should buy more Licenses (e.g. for each of the potential users) or a License of different kind.

The Software (or any part of it) licensed under the Full License may not be redistributed separately or as a part of any other application. However, any output produced by the Software, including the template files created with it, may be freely distributed without restrictions.

5.4. Operating Systems & Execution Environment

As the whole FlexDoc XYZ Software is implemented in Java programming language, you can run it on any OS that supports recent versions of Java SE (starting from Java 11). That includes:

• Microsoft Windows
• Linux
• macOS

The Full License imposes no restrictions about that.

You are also allowed to install and run the Generator (with a template application) on any virtual server or OS-container (like Docker), as long as you comply with the terms and restrictions of your License.

Furthermore, you are free to integrate the licensed Software with any other third party software installed on your system, especially various build automation tools like Apache Ant/Maven, Gradle etc.

5.5. Maintenance and Support

Each Full License includes a period of 1 year (or more depending on the conditions of your purchase) of the following maintenance and support:

• Unlimited email support.

  It means that you will normally get a reply on your email during the same or the next working day, and we will keep corresponding with you until you have all your questions or problems fully resolved.

• Free bugfix updates for the licensed version of the Software.

  If you report a bug and provide with some information about how and where that bug is happening (in most cases, just a full Java Exception Stack Trace would suffice), normally, we can fix it and prepare an update during 2-3 following days. In fact, we receive very rarely reports about bugs, so that was the experience from those few cases.

• Special upgrade possibilities (see also below).

5.6. Upgrade Possibilities

The owners of a Full License are eligible for free upgrades within the same generation (major version) of the licensed Software product. For example, if you purchase a license for the Software version 1.0, your license is automatically extended to versions 1.1, 1.5.1 and so on.

Additionally, the Full License is automatically extended to any version of the licensed product/feature released during the support period. That, however, applies relative to the whole software package, not a particular product version.

To upgrade to a new version of the product covered by your license, you need just to download the new version of the corresponding software package and install it together with your license certificate. Each new software version is designed and tested to support any early issued licenses covering it.

5.7. Generated Output

The Full License imposes no restrictions on the output files automatically generated with the Software, which includes:

• The whole generated documentation
• Separate HTML, RTF and plain text files
• Diagram image files

You may use these files as you want and need:

• Publish them on the web, wholly or partially
• Link to them from any web pages
• Insert into some your own documentation, wholly or partially
• Distribute to anywhere else both alone and packaged with your files and software
• Modify the content of the generated files in any way you need, e.g. edit/remove/replace some blocks, add your own text, transform images etc.

When the output files generated with FlexDoc XYZ Software contain or represent your intellectual property, Filigris Works does not claim any rights to it.

Involvement of other License types

Any text distortion or watermarks, which you may see within the documents/diagrams generated under the Trial License, will disappear once you have installed the Full License(s) covering the corresponding features.

However, if during the generation of some files any Trial Licenses were involved (e.g. for the diagramming plugin), then the whole output is considered as the trial one.

See also: Multiple Licenses

5.8. Templates

The Full SDK License (i.e. the one covering the Template Designer) allows you:

• To create/modify any templates.
• To execute any trial templates (without any restrictions).
• To distribute your custom templates to anyone else.

6. Licensing of Templates

6.1. Basic Templates

These are any templates developed by Filigris Works (and included in the provided software), which are not designated as “Commercial Template Applications”. In particular, this includes:

• Any sample templates
• Template applications that implement some basic functionality essential for the entire product line

Using of Basic Templates requires no specific licensing. You are equally free to modify such templates and base on them your own template applications (see Custom Templates).

6.2. Commercial Template Applications

Commercial Template Applications (or «CTA» for short) are large template sets developed by Filigris Works to implement certain general very complex tasks.

They provide the functionality, which is typically offered by other companies in the form of separate commercial software products (or specific features of them). For example, “FlexDoc/XML XSDDoc” template set implements a high quality XML Schema Documentation Generator.

Since FlexDoc templates always require a special interpreter for their execution, all CTAs are delivered as add-ins to each edition of the base product line. For example, the XSDDoc template set is included in FlexDoc/XML archive.

On the other hand, because CTAs actually solve some very complicated general tasks, they require separate licensing. So, each CTA has its own product name and version number, to which a license is attached.

CTAs may work under the following licenses:

License Type	Details
Demo License	This license is activated by default when no other licenses for the given CTA have been found. Under the Demo License, the template application will work in demo mode, which is interpreted as follows: No limitations on whatever functionality. However, only limited number of major items (e.g. XSD components, Java classes etc.) are fully documented, which depends on the demo limits embedded in the template set (main template) you run. When the demo limits are not exceeded (on small input data/projects), you will get the complete documentation without any distortions! Otherwise, some content will be omitted and the messages included saying which exactly limits were exceeded. Anyway, the result documentation will be minimally distorted to allow you to evaluate how everything would look under the Full License. The output documentation generated by a CTA working under the Demo License is free for any possible use.
Full License	This license unlocks all functionality implemented in the CTA, with no limitations on the input data, number of documented items, number and size of the output files etc. Any output files generated by a CTA under the Full License may be used for any purposes without limitations, provided that no other Trial Licenses have been used at that. See also: Multiple Licenses
Trial License	This license unlocks all functionality implemented in the CTA, with no limitations on the input data, number of documented items, number and size of the output files etc. All output document generated by a CTA under the Trial License will be specifically distorted and contain trial messages at the end of each file. Any generated files may be used for the evaluation of this software only.

6.3. Custom Templates

In this category fall all templates that were created or modified by the users working under a Trial/Full SDK license (that covers the Template Designer).

This includes:

1. Any templates developed completely by the users to solve their own specific tasks.
2. Any templates derived from Basic Templates (i.e. produced by the modification of one or several templates included in a basic template set).
3. Any templates derived from CTAs (i.e. produced by the modification of one or several templates included in a commercial template set).

Custom templates are subject to the following rules:

• Custom templates created (or modified the last time) under the Full SDK license may be executed anywhere, including by the Generator working under the Free License.
• Custom templates created (or modified the last time) under a Trial SDK license are called trial templates. Any trial template may be always executed in the presence of a Trial/Full SDK license.

  To make trial templates executable with the free Generator, they must be cleared from being "trail", that is updated (resaved) with the Template Designer working under the Full SDK license.

• If you derive your custom templates from a CTA, in order to run them, you will need also Trial/Full License covering that CTA.
  For instance, if you want to customize the XML schema documentation generated by FlexDoc/XML XSDDoc by changing something in XSDDoc templates, you will need at least two licenses:

  1. License for FlexDoc/XML SDK – covers the Template Designer
  2. License for FlexDoc/XML XSDDoc – covers «XSDDoc» (the CTA implementing the XML Schema Documentation Generator).
• You may keep any your custom templates as long as you wish (even if you do not buy any licenses allowing running them)

See Also: Multiple Licenses

Changing Templates Manually

In general, FlexDoc templates should be edited using the Template Designer.

Although, the templates are plain-text files with the format looking somewhat similar to XML (see FlexDoc.XYZ | What are Templates? | About Template Format), there are several reasons why we do not encourage changing templates manually.

One of such reasons is that because of the licensing issues the template structure and content are locked with a special checksum. This prevents easily forging the templates in order to circumvent licensing terms.

However, when you need to quickly replace a certain string simultaneously in a number of template locations or translate lots of text labels into a different language, doing this by changing the templates in a simple text editor might be much faster.

A Trial/Full SDK license allows you to do that. The following things can be changed in templates beyond the use of the Template Designer:

• Text labels
• Descriptions
• FlexQuery expressions
• Values of formatting properties
• File pathnames of called subtemplates
• Names of stock-sections and formatting styles

Once you have changed anything mentioned above directly in the template source, the template checksum will be partially broken. However, you can execute such a template with the Generator. When you resave the template with the Template Designer, the correct checksum will be restored again.

7. Multiple Licenses

You may combine (install) several licenses covering different features so as to use all of them together.

For instance, along with a license for FlexDoc/XML XSDDoc – the XML Schema Documentation Generator, you may install a license for FlexDoc/XML DiagramKit – a diagramming plugin that generates XSD component diagrams. As a result, you will get a generator of XML schema documentation with diagrams.

Those licenses may be of different types. You may have a Full License for some feature you've been already using for a while and additionally to install a Trial License for another feature so as to try some enhancement of the functionality you already use.

However, those combined licenses may have contradictive restrictions. So, the question arises: If licenses of different types impose different restrictions on the generated output, which of those restrictions apply to the output files generated under all those licenses?

The resolution is the following:

For example, when some output was generated simultaneously under both Full and Trial Licenses, that will be considered a trial output with all restrictions implied by the Trial License.

The following table shows all matching license types and their priorities (a license with the highest priority takes over all other licenses):

License Type	Priority
Trial License	3
Demo License	2
Full License	1
Free License	0

7.1. Example

An employee named Joan of some imaginary company called PerfectSoft Ltd. needed a good XML Schema documentation generator for her job task. She found one called “FlexDoc/XML XSDDoc” at this website. It happened to be a set of templates included in a software package “FlexDoc/XML”. When Joan downloaded that software and investigated it, she realized that that was exactly what she needed.

Joan read that if she purchased a Full License for FlexDoc/XML XSDDoc, she would be able to generate a complete framed HTML (Javadoc-like) XML schema documentation that she needed right then. So, Joan asked her company to buy a license for FlexDoc/XML XSDDoc.

Some years later, Joan visited this website again and noticed that a new add-on had been released called “FlexDoc/XML DiagramKit”, which enhanced XSDDoc so to generate and include in the output XML Schema documentation the component diagrams. That was exactly what Joan missed for long time! So, she asked her company to purchase a license for DiagramKit as well. When Joan installed it along with her old license for XSDDoc, started the Generator and invoked the «About» dialog, she saw the following screen:

8. Getting Help

If you have any questions concerning licensing or pricing of FlexDoc software, please, do not hesitate to let us know by sending an email to: support@flexdoc.xyz