Products         Downloads         Licensing         Shop         Customers         Support    

 DocFlex Technology
Overview
Features
Documentation
 DocFlex/XML
Overview
Features
Documentation
XSDDoc
Features
Organization
Examples
Templates
Subtemplates
Parameters
FAQ
WSDLDoc
Integrations
Bundles
 DocFlex/Javadoc
Overview
Documentation
Basic Templates
JavadocPro
Examples
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 - XSDDoc - Parameters

About XSDDoc parameters

Parameter Tree


“Show” parameter group

This parameter group controls the generation of various small fragments (like parts of component names, specific sections etc.)

Parameter

Name / Type / Description

Link Titles (Tooltips) show.linkTitle : boolean

Specify whether to generate hyperlink titles.

In HTML, hyperlink titles are specified using title attribute, like this:

<a ... title="link tooltip text"> ... </a>
Most browsers will interpret it as a hyperlink tooltip (a tiny window with the text that appears near the hyperlink when the mouse cursor is moved over it).

Component Name

show.linkTitle.name : boolean

Specify whether the component link title (tooltip) will include the name of the component. This will look as on the screenshot:

The component's name might be helpful in the link tooltips over diagrams (as well as in other cases).

Namespace URI

show.linkTitle.namespace : boolean

When a hyperlink appears on a schema component name, it would be helpful to use the link tooltip to quickly see what a namespace this component belongs to.

This might be particularly useful when the XML schemas you document define many components with equal local names, however, in different namespaces and no prefixes are defined for those namespaces at that.

This parameter allows you to generate such tooltips. When it is selected (true), the titles of hyperlinks leading from component names will include the namespace URI of those components, as shown on the following screenshot:
But note that since the namespace URIs are typically rather long strings, when added to each hyperlink, they may considerably blow out the generated HTML files. That's why this parameter was introduced: to be able to switch them off.

Defined in Schema

show.linkTitle.schema : boolean

Specify whether the component link title (tooltip) will include the name of the XML schema file, where the component is defined.

For global components, that will add a text like this:

defined in XMLSchema.xsd
For unified local elements, the additional text may be more complex:
Namespace Prefixes show.nsPrefix : boolean

Specify whether to add namespace prefixes to any XML names appearing in the generated documentation.

As you may know, each XML name is not just a string. Rather, it is a vector of two values: { namespace URI, local name }

Any namespace prefixes used in the output documentation originate from the namespace URI/prefix bindings declared in the source XSD files. For a particular XML name, its namespace prefix is generated according to the binding for the given namespace found the nearest to the documentation context where that XML name appears.

Example:

Suppose you generate documentation for two XML schemas: schema1 and schema2.

The schema1 is targeted to the namespace associated with 'namespace_uri_1' URI, which is bound to 'myns' prefix. This schema defines some MyType type component.

The schema2 is targeted to a different namespace, however, it also uses MyType, which it imports from the schema1. To reference to that type, the schema2 binds the 'namespace_uri_1' to the prefix 'ns1', so MyType looks in it as:

ns1:MyType
How will MyType look in the output documentation when this parameter is selected?

In the parts of the documentation related to schema1 you will see:

myns:MyType
In parts related to schema2, you will see:
ns1:MyType
However, both names will be connected via hyperlinks to the same details of MyType type.
Local Element Extensions show.localElementExt : enum {"always", "repeating", "never"}

Specify whether to generate extended names of local elements.

Local elements are the locally defined element components. For more information, please see: How everything is documented | Local Elements.

The extended name of a local element is made of its normal name extended with some short info about the possible element location or its type. For example:

configuration (in plugin in plugins in reporting)
xs:complexType (type xs:localComplexType)
here in the brackets are the local element name extensions.

The name extension is needed to distinguish that element in the documentation from other local elements, which share the same XML name, however have different content.

The name extensions may be not necessary for local element with unique names. For instance, some XML schemas are designed (or generated) so that almost all element components are declared locally, except only the root element. At that, all element names may be unique. So, the name extensions are not really needed and will only overload the documentation.

Possible Choices:

"always"
Generate name extensions for all local elements.
"for repeating names only"
Generate name extension only for local elements with non-unique names (i.e. whose XML names are shared by any other element components).
"never"
Do not generate the name extensions.
See Also:
How everything is documented | Local Elements | Global Naming of Local Elements
About (footer) show.about : enum {"full", "short", "none"}

Specify whether to generate the "About" section added at the bottom of each generated document.

This section shows certain information about DocFlex/XML software and XSDDoc template set, which power this XML Schema Documentation Generator.

Possible Values:

"full"
Generate the detailed information.
"short"
Generate only a brief notice.
"none"
Do not generate the "About" section.
Note:
Actually, all what you can see in the "About" section is generated entirely by the about.tpl template.

Once you acquire a full license for DocFlex/XML SDK, you will be able to modify this template as you wish (as well as all other XSDDoc templates) so as to generate in the "About" section something of your own. For instance, to insert you company info, logotype, copyright statement about your software (your XML schema), etc.

Copyright© 2003-2014 Filigris Works, Leonid Rudy Softwareprodukte. All rights reserved.