Products         News         Downloads         Licensing         Shop         Support    

 DocFlex Technology
Overview
Features
Documentation
 DocFlex/XML
Overview
Features
Documentation
XSDDoc
WSDLDoc
Templates
Examples
DiagramKit
Integrations
 DocFlex/Javadoc
Overview
Documentation
JavadocClassic
Tutorials
 DocFlex/Together
Overview
Examples
Basic Templates
Documentation
Tutorials
 Try
Downloads
Registration
Trial License
 Use
Licensing
Shop
Support
 Company
News
Products
Customers
About Us
Imprint
Legal
Contact
Links
 

DocFlex/XML - WSDLDoc - Templates

XML Type

XML Type is a description of a particular kind of XML data sources possible to process by a DocFlex/XML template aplication:
  • XML Type is a source of data type and structure information about all possible XML files that constitute the data source.
  • Every DocFlex/XML template is based on a certain XML Type that provides the data type/structure information necessary both to design the template and iterpret it.
  • All templates included in a particular template applications are based in the same XML Type.
  • XML Type is defined by a special XML Type Configuration File, which is a plain-text file with '.xmltype' extension typically stored along with the template set.
  • Each XML Type is assigned with a certain identifier, by which it is linked to templates.
  • The structure of particular type of XML files is described by a certain XML schema, which is a part of the XML Type (it must be specified in the XML Type config file).
  • An XML data source processed by a template application may consist of multiple XML files linked with each other. Some of those XML files may be described by different XML schemas, all of which are included in the XML Type.
See also: DocFlex/XML | Documentation | Designing Templates | Defining XML Type

WSDLDoc template set is based on «wsdldoc» XML Type defined in the file:
{docflex-xml}/templates/WSDLDoc/wsdldoc.xmltype

It uses the standard XML schemas for XSD 1.0 and WSDL 1.1, which drive the data processing:

DocFlex/XML uses local copies of those schemas stored in the library resource directory:
{docflex-xml}/lib/resources/

Main Templates

Main templates are those, which can be specified for interpretation directly to the generator (either with -template option on the Java command line or in the Generator Dialog). Effectively, each main template represents a separate documentation generator.

FramedDoc.tpl

This is a main template designed to generate Framed HTML Documentation.

On the left you can see it open in the template designer (the template main block). Click on the screenshot to view in full size.

It works basically the same as a similar main template in XSDDoc template set, more details about which you can read here: DocFlex/XML | XSDDoc | Templates | FramedDoc.tpl

SingleDoc.tpl

The second main template that generates Its screenshot is on the left (click to view in full size).

SingleDoc.tpl works basically the same as a similar main template in XSDDoc template set, more details about which you can read here: DocFlex/XML | XSDDoc | Templates | SingleDoc.tpl

Subtemplates

The actual documentation content is generated by subtemplates, which are called both from the main templates and from each other.

Below is the list of all subtemplates by directories:

[lib]
about.tpl,
all-components.tpl,
all-components-frame.tpl,
index-all.tpl,
index-letter.tpl,
init.tpl,
navbar.tpl,
navbar-bottom.tpl,
overview-frame.tpl,
overview-summary.tpl,
TOC.tpl
[lib/diagramming]
DiagramKit.tpl,
OxygenXML.tpl,
XMLSpy.tpl
[lib/doc]
docOutput.tpl, firstSentenceOutput.tpl
[lib/images]
[lib/namespace]
namespace.tpl,
namespace-frame.tpl,
namespaceProfile.tpl,
namespaceSummary.tpl
[lib/wsdl/binding]
binding.tpl,
bindingProfile.tpl,
bindings.tpl,
bindingSummary.tpl,
operationDescription.tpl
[lib/wsdl/file]
wsdl-frame.tpl,
wsdl-source.tpl,
wsdlFile.tpl,
wsdlLinkTitle.tpl,
wsdlName.tpl,
wsdlProfile.tpl,
wsdlSummary.tpl
[lib/wsdl/message]
message.tpl,
messageProfile.tpl,
messageRep.tpl,
messages.tpl,
messageSummary.tpl,
partDescription.tpl
[lib/wsdl/misc]
defLinkTitle.tpl,
defName.tpl,
extensibilityElements.tpl,
firstSentence.tpl
[lib/wsdl/portType]
operationDescription.tpl,
portType.tpl,
portTypeProfile.tpl,
portTypes.tpl,
portTypeSummary.tpl
[lib/wsdl/service]
service.tpl,
serviceProfile.tpl,
services.tpl,
serviceSummary.tpl
[lib/xml]
documentSource.tpl,
nodeSource.tpl,
sourceNote.tpl,
xmlns-bindings.tpl
[lib/xsd/ann]
annotation.tpl, firstSentence.tpl
[lib/xsd/attribute]
attribute.tpl,
attributeProfile.tpl,
attributes.tpl,
attributeSummary.tpl,
contentAttributes.tpl
[lib/xsd/component]
componentLinkTitle.tpl,
componentName.tpl,
diagram.tpl
[lib/xsd/content]
complexContentModel.tpl,
contentType.tpl,
facet.tpl,
simpleContentDerivation.tpl,
simpleContentRep.tpl,
wildcard.tpl,
xmlRep.tpl
[lib/xsd/element]
contentElementList.tpl,
contentElements.tpl,
element.tpl,
elementBlockAttrInfo.tpl,
elementFinalAttrInfo.tpl,
elementList.tpl,
elementListNote.tpl,
elementNameExt.tpl,
elementProfile.tpl,
elements.tpl,
elementSummary.tpl,
substitutionGroupInfo.tpl
[lib/xsd/groups]
attributeGroup.tpl,
attributeGroupProfile.tpl,
attributeGroups.tpl,
attributeGroupSummary.tpl,
group.tpl,
groupProfile.tpl,
groups.tpl,
groupSummary.tpl
[lib/xsd/schema]
schema.tpl,
schema-frame.tpl,
schema-source.tpl,
schemaExport.tpl,
schemaLinkTitle.tpl,
schemaName.tpl,
schemaProfile.tpl,
schemaSummary.tpl
[lib/xsd/type]
complexType.tpl,
complexTypes.tpl,
complexTypeSummary.tpl,
simpleType.tpl,
simpleTypes.tpl,
simpleTypeSummary.tpl,
typeBlockAttrInfo.tpl,
typeDerivationSummary.tpl,
typeDerivationTree.tpl,
typeFinalAttrInfo.tpl,
typeProfile.tpl,
typeRelatedCompLists.tpl,
typeUsage.tpl

Copyright© 2018 Filigris Works, Leonid Rudy Softwareprodukte. All rights reserved.