WSDLDoc template set provides two main templates:
FramedDoc.tpl
– to generate framed multi-file (Javadoc-like) HTML documentationSingleDoc.tpl
– to generate single-file HTML and RTF documentation-template
option on the Java command line or in the Generator Dialog).
Effectively, each main template represents a separate documentation generator.
WSDLDoc template set is included in FlexDoc/XML software archive and found in the directory: {flexdoc-xml}/templates/WSDLDoc/
{flexdoc-xml}
is a designation of your FlexDoc/XML installation directory, e.g.: C:\flexdoc-xml-1.13\
See also: Docs | FlexDoc/XML | WSDLDoc
File / Directory | Description |
---|---|
README.html
|
this file |
CHANGES.html
|
change log of WSDLDoc templates |
FramedDoc.tpl
|
The main template to generate framed HTML documentation. |
SingleDoc.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 WSDLDoc template application. |
wsdldoc.xmltype
|
The configuration file that defines the 'wsdldoc' XML type,
on which all WSDLDoc templates are based.
|
css/azure-theme.css
|
An alternative skin for HTML documentation (both framed and single-file). See: Using azure-theme.css |
Note: All files and directories are located in WSDLDoc home directory: {flexdoc-xml}/templates/WSDLDoc/
WSDLDoc/lib/images/
directory,
have been borrowed from
NetBeans. That is allowed by the
CDDL license that covers NetBeans,
as well as follows immediately from this explanation:
http://wiki.netbeans.org/FaqUseOfImagesOtherPrograms.
Please note that some general functionality (i.e. template language) used in a particular version of WSDLDoc may be available only since the specific version of FlexDoc/XML. For instance, WSDLDoc version 1.2.5 requires FlexDoc/XML version 1.13 or later.
'{flexdoc-xml}/lib/'
directory.
For instance, the whole data processing in WSDLDoc is based on the standard XML schemas for XSD 1.0 and WSDL 1.1.
Those schemas are specified in wsdldoc.xmltype
file and
must be loaded each time when running WSDLDoc. But, of course, not from the Internet.
Rather, local copies stored in {flexdoc-xml}/lib/resources/
directory are used.
The default XML catalog {flexdoc-xml}/lib/resources/catalog.xml
redirects the external schema URLs to those copies.
Their integrity is critical for running WSDLDoc!
License Type | Description |
---|---|
Demo License |
Once you have downloaded FlexDoc/XML archive, you can run WSDLDoc
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. XSD diagrams will be generated as well by any diagramming plugin you choose (DiagramKit by default) and as many as it's allowed by WSDLDoc 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. |
Full License |
The full (or commercial) license unlocks all functionality implemented in WSDLDoc template set.
In particular, you will be able to:
|
Trial License |
The trial license is functionally the same as the full one.
The difference is that:
You can also request a trial of all FlexDoc/XML features (products) together by this link:
https://www.flexdoc.xyz/trial/?pid=flexdoc-xml
See also: {flexdoc-xml}/LICENSE.html | Trial License
Then, you will receive a single 'flexdoc-xml.license' file with the WSDLDoc trial license already included in it.
At that, you won't need to request any other trial licenses (e.g. for template designer or integrations).
|
{flexdoc-xml}/templates/WSDLDoc/
'WSDLDoc/'
directory to any other location and run the WSDLDoc 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 WSDLDoc.
SingleDoc.tpl
(instead of FramedDoc.tpl
)
and select RTF format (instead of HTML).
To generate WSDL / XML schema documentation, please follow these steps:
generator.bat
found in {flexdoc-xml}/bin
directory. You will see the generator dialog.
-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 64-bit you should specify -Xmx1024m
.
FramedDoc.tpl
template.
'templates/WSDLDoc'
directory using File Chooser.
http://www.w3.org/2001/XMLSchema.xsd
)
FramedDoc.tpl
main template can generate only framed HTML documentation!
Diagramming Plugin | Description |
---|---|
DiagramKit | The native diagramming engine of FlexDoc/XML. It creates beautiful XSD diagrams that can be generated simultaneously along with (and inserted into) the documentation generated by WSDLDoc (with the support of all possible hyperlinks). This diagramming plugin is activated by default. You don't need to setup anything. |
See also: Docs | FlexDoc/XML | WSDLDoc | Getting Started | How to include XSD diagrams?
azure-theme.css
is a CSS style sheet that implements an alternative skin (look & feel)
for HTML documentation generated by WSDLDoc. It is applicable with both FramedDoc.tpl
and SingleDoc.tpl
main templates.
(You can use it also as a base for your own customizations.)
To apply azure-theme.css
, please follow the same steps as described in Running WSDLDoc.
On the step of selecting HTML format, click «Options» button and in the HTML Options dialog, which should appear, specify:
azure-theme.css
path name
{flexdoc-xml}/templates/WSDLDoc/CHANGES.html