'templates/XSDDoc/'
subdirectory of each edition.
As being a commercial product, XSDDoc requires separate licensing. According to your license, it can work in one of three modes: limited, full or trial. For more details, please see Licensing / Processing Modes.
README.html
|
this file |
CHANGES.html
|
change log of XSDDoc templates |
FramedDoc.tpl
|
The main template to generate framed HTML documentation. |
PlainDoc.tpl
|
The main template to generate single-file documentation (in HTML or RTF format). |
help/
|
The descriptions of parameters of both main templates; used by the Parameter Inspector. |
lib/
|
The directory containing all subtemplates (and icon files) that power the XSDDoc template application. |
xsddoc.xmltype
|
The configuration file that defines the 'xsddoc' XML type,
on which all XSDDoc templates are based.
|
Note: All files and directories are located in 'templates/XSDDoc/'
subdirectory of each edition of
DocFlex/XML.
Please note, some general functionality used in a given version of XSDDoc templates may be available only since a specific version of DocFlex/XML. In particular, the XSDDoc version 2.8.0 requires DocFlex/XML version 1.9.0 or later.
Depending on your license for "DocFlex/XML XSDDoc", the template set may work (be interpreted) in one of the three different modes: limited, full or trial.
Note: | These are the processing modes of only the XSDDoc template application -- not the particular edition of DocFlex/XML (SDK or RE), which has its own processing mode(s). For more details, please see: http://www.filigris.com/buy/licensing_pricing.php | Commercial Template Applications |
In this mode, you can:
The limitations:
<img>
tags).
What is more, you can also modify/customize the XSDDoc templates themselves (so as to add the functionality not implemented by us, change the generated content, look & feel and so on). For doing this, you will need an additional license for "DocFlex/XML SDK", which covers the Template Designer.
See also: http://www.filigris.com/buy/licensing_pricing.php | Multiple Licenses
It will be already pre-installed in the 'templates/XSDDoc/'
directory of the main product.
(In the future, when other commercial templates applications will be developed, we may provide them as separately downloadable add-ons. However, now it is just an early stage of such a development.)
The only thing you may need to install specifically is the
'docflex-xml-xsddoc2.license'
file, which contains your license
for "DocFlex/XML XSDDoc" template application.
You receive that file by e-mail.
It should be stored in the 'templates/XSDDoc/'
directory
along with the FramedDoc.tpl
and
PlainDoc.tpl
main templates
(i.e. those called the first by the generator).
After that, the 'XSDDoc/'
directory will contain everything needed to
run XSDDoc.
Note: The "DocFlex/XML XSDDoc" license may be also included in a combined
'docflex-xml.license' file (along with other licenses), which should be installed in
the 'lib' directory of your DocFlex/XML installation (near docflex-xml.jar ).
The 'docflex-xml-xsddoc2.license' file may be also installed there.
|
'XSDDoc/'
directory to any other location
and run the XSDDoc templates directly from there.
This may be particularly useful when you want to modify something in the original
templates and derive your own version of XSDDoc.
generator.bat
(found in the root directory of your
DocFlex/XML (Full Edition) or
DocFlex/XML RE
installation). You will see the generator dialog.
While processing XSDDoc templates for big XML schemas,
the generator may be particularly hungry for memory. Lack of memory may considerably
increase the generation time!
To avoid this, make sure the maximum heap size available for JVM is 512Mb or even more
(e.g. Java option -Xmx512m sets the maximum heap size to 512Mb).
Note also that on 64-bit OS (running 64-bit Java), that amount should be doubled!
So, on Windows 7 64-bit you should specify -Xmx1024m .
|
FramedDoc.tpl
template.
You can choose this template from 'templates/XSDDoc' directory using File Chooser.
|
Each XML file can be specified either by local path name or by URL
(e.g. http://www.w3.org/2001/XMLSchema.xsd ).
In the case of a URL, the generator will try to download such a file directly from the Internet.
When multiple XML files are specified, make sure that each pathname or URL is enclosed in double quotes. |
The FramedDoc.tpl template is a frameset template
which can generate only HTML output!
|
Once all source XML Schema files are loaded, the generator enters into the estimation phase.
Lots of heavy processing is being done during that, however, you will see only
"Scanning data source, please wait..." message on the progress bar.
On large XML schemas this phase may take some time. Please wait!
After that, the generator will pass into the generation phase.
The progress bar will show what's being generated.
You can stop the generator at any time during any phase by clicking "Cancel" button. |
We are always happy to hear any questions, suggestions, comments, etc.
about this product.
Please, e-mail us to:
support@docflex.com or
contact@filigris.com
{docflex-xml}/templates/XSDDoc/CHANGES.html