DocFlex Technology

 DocFlex/XML

 DocFlex/Javadoc

 DocFlex/Together

 Try

 Buy

 Company

Parameter/Group

Name / Type / Description

Specifies the title to be placed at the top of the documentation overview.

For Schemas

Initial

Specify whether to document the XML schema files initially specified on the generator command line (or in the generator dialog).

Imported

Specify whether to document all additional XML schema files loaded by <xs:import> elements.

Note: When an XML schema is both specified initially on the command line and referred from an <xs:import> element, it is loaded only once as the initial XML schema, however, it will be marked as the imported schema as well.

Included

Specify whether to document all additional XML schema files loaded by <xs:include> elements.

Redefined

Specify whether to document all additional XML schema files loaded by <xs:redefine> elements.

Overview Summary

Specifies whether to generate the Overview Summary documentation block.

All Component Summary

Specifies whether to generate the All Component Summary documentation block.

Namespace Overviews

Specifies whether to generate Namespace Overview documentation blocks.

Schema Overviews

Specifies whether to generate Schema Overview documentation blocks.

Elements

Specifies whether to generate the detailed Element Documentation for each global element component and some of the local element components (that are defined in all XML schemas being documented).

Local Elements

Specifies whether to generate the detailed Element Documentation for local elements (i.e. locally defined element components).

Possible Values:

"all"

Document all local elements the same way as global ones (see "How Local Elements are documented | Global Documenting" below).

"complexType" (or "with complex type only" as value name)

Generate the detailed Element Documentation only for local elements with complex types.

Note: Certain XML schema design patterns avoid using global element components almost entirely. Instead, they define a single global element component that describes the root element of a possible XML document. Any other elements, which may be contained in that XML document, are defined using only global types and local element components. What is more, frequently, those XML schemas also avoid defining element attributes. Instead, to store in an XML document the elementary data normally supposed for attributes, they define lots of local elements with primitive simple types. As a result, such an XML schema contains great a lot of insignificant local element components. When all of them are documented separately (and appear in main element component lists) they may overwhelm anything else. This parameter value allows you to avoid exactly such a mess and properly document your XML schemas written according to that pattern!

"none"

Do not generate the Element Documentation for local elements.

Complex Types

Specifies whether to generate the detailed Complex Type Documentation for each global complex type component.

Simple Types

Specifies whether to generate the detailed Simple Type Documentation for each global simple type component

Element Groups

Specifies whether to generate the detailed Element Group Documentation for each global element group component.

Global Attributes

Specifies whether to generate the detailed Global Attribute Documentation for each global attribute component.

Attribute Groups

Specifies whether to generate the detailed Attribute Group Documentation for each global attribute group component.

XML Namespace Bindings

Specifies whether to generate the XML Namespace Bindings report.

Overview Summary

Namespace Summary

Specify whether to generate the Namespace Summary section.

Schema Summary

Specify whether to generate the Schema Summary section that enumerates all documented XML schemas along with a few details about each of them.

Nested Parameter Group:

Specify which details are to be shown about each XML schema.

All Component Summary

Summary Item

Annotation

Specify whether to include the component annotation and which part of it.

Possible Values:

"first_sentence"

Include only the first sentence of the annotation text.

"full"

Include the full annotation.

"none"

Do not include annotation.

Component Profile

Specifies whether to generate the Component Profile section, which provides general summary information about the component.

Nested Parameter Group:

Controls what is included in the Component Profile section.

Elements

Specify whether to generate the Element Summary section.

Complex Types

Specify whether to generate the Complex Type Summary section.

Simple Types

Specify whether to generate the Simple Type Summary section.

Element Groups

Specify whether to generate the Element Group Summary section.

Global Attributes

Specify whether to generate the Global Attribute Summary section.

Attribute Groups

Specify whether to generate the Attribute Group Summary section.

Namespace Overview

Namespace Profile

Specify whether to generate the Namespace Profile section.

Schema Summary

Specify whether to generate the Schema Summary section.

Component Summaries

Specify whether to generate the Component Summaries section.

Schema Overview

Schema Profile

Specify whether to generate the Schema Profile section.

Annotation

Specify whether to generate the Annotation section.

Component Summaries

Specify whether to generate the Component Summaries section.

XML Source

Specify whether to generate the XML Source section.

Component Documentation

• Elements (both global and local ones)
• Complex Types
• Simple Types
• Element Groups
• Global Attributes
• Attribute Groups

Component Profile

Specifies whether to generate the Component Profile section, which contains brief information about the component (such as which namespace it belongs to, where it is declared, type and content, etc.)

Applies To:

All components

Nested Parameter Group:

Controls what exactly is included in the Component Profile section.

Content Model Diagram

Specify whether to generate the Content Model Diagram section, which includes the graphic diagram representation of the component content model.

Applies To:

Elements, Complex Types, Element Groups

Nested Parameter Group:

Control how to direct hyperlinks from the diagram image.

XML Representation Summary

Specifies whether to generate the XML Representation Summary section.

Applies To:

All components

Nested Parameter Group:

...

Simple Content Detail

Specifies whether to generate the Simple Content Detail section.

Applies To:

• Elements with simple content model.
• Complex Types with simple content model.
• All Simple Types. The simple content is exactly what a particular simple type defines.
• All Global Attributes. The attribute value is a particular instance of simple content.

Nested Parameter Group:

Controls generation of specific details about simple content.

Lists Of Related Components

List Layout

This parameter controls how the list items are displayed.

Possible Values:

"flow"

The list items will appear as a comma delimited text flow within a single paragraph.

This layout produces a very compact representation of the list. However, it may be difficult to read, particularly when some items contain spaces.

"two_columns"

The list items will be arranged in a two-column table.

This representation is better to read, however, it will occupy more space. It suits more for the lists, whose items are strings with spaces. It may be worse for the big lists made of short word items.

"optimal"

This choice allows the list layout to be selected automatically (this is programmed in templates). If the list is expected to include items with spaces, the two-column layout will be used. Otherwise, the list is displayed as a comma separated text flow.

Content Elements

Specify whether to generate the List of Content Elements.

Applies To:

Global & Local Elements, Complex Types, Element Groups

Containing Elements

Specify whether to generate the List of Containing Elements.

Applies To:

Global & Local Elements

Substitutable Elements

Specify whether to generate the Lists of Substitutable Elements.

Applies To:

Global Elements

Substituting Elements

Specify whether to generate the Lists of Substituting Elements.

Applies To:

Global Elements

Children By Substitutions

Specify whether to generate the Lists of Possible Children By Substitutions.

Applies To:

Global & Local Elements

Parents By Substitutions

Specify whether to generate the Lists of Possible Parents By Substitutions.

Applies To:

Global Elements

Parents By Substitutions

Specify whether to generate the Lists of Possible Parents By Substitutions.

Applies To:

Global Elements

Direct Subtypes

Specify whether to generate the List of Direct Subtypes.

Applies To:

Simple Types, Complex Types

Indirect Subtypes

Specify whether to generate the List of Indirect Subtypes.

Applies To:

Simple Types, Complex Types

All Based Elements

Specify whether to generate the List of All Based Elements.

Applies To:

Simple Types, Complex Types

All Based Attributes

Specify whether to generate the List of All Based Attributes.

Applies To:

Simple Types

Usage / Definition Locations

Specify whether to generate the Usage / Definition Locations section.

Applies To:

All components

Annotation

Specify whether to generate the Annotation section.

Applies To:

All components

Type Definition Detail

Specify whether to generate the Type Definition Detail section.

Applies To:

Elements, Global Attributes, Simple Types, Complex Types

XML Source

Specify whether to generate the XML source section.

Applies To:

All components

Attribute Detail

Specify whether to generate the Attribute Detail section.

Applies To:

Elements, Complex Types, Attribute Groups

Content Element Detail

Specify whether to generate the Content Element Detail section.

Applies To:

Elements, Complex Types, Element Groups

Namespace Prefixes

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

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

myns:MyType

ns1:MyType

Local Element Extensions

...

About (footer)

...

XMLSpy

Show Application

Delete Temporary Docs

Specify whether to delete all files temporarily generated by XMLSpy.

The integration of DocFlex/XML XSDDoc with XMLSpy works by calling XMLSpy to generate its own (reduced) documentation for each initially specified XML schema file. Further, that intermediate documentation is used by DocFlex/XML (the integration bridge) to obtain the diagram images (and hypertext maps to them) created by XMLSpy so as to insert them in the documentation output generated by XSDDoc. Once, XSDDoc finishes, the original XMLSpy documentation is not needed any longer and can be deleted. This parameter controls whether to delete or leave it.

All temporary files produced by XMLSpy are stored in the directory

{documentation_files}/xmlspy

The documentation originally generated by XMLSpy for each initial XML schema is stored in a separate subdirectory within xmlspy under the name derived from the XML schema file's name, for example:

{documentation_files}/xmlspy/schema-for-xslt20_xsd

Diagram Format

Select the graphics format of the diagrams generated by XMLSpy.

Possible Values:

"PNG"

All diagrams will be in PNG formats.

This is the default format. It is best for HTML documentation. (However, in RTF/PDF documentation it will work as well.)

"EMF"

The diagrams will be generated in EMF format.

This format is more suitable for printable RTF/PDF documentation. (In case of HTML, the diagrams will be generated in EMF as well, however, whether you can see them will depend on your HTML browser.)

Important: The generation of diagrams in EMF format is possible only since XMLSpy 2009 or later. (Although, XMLSpy itself supported EMF much earlier, they provided the Java API for it only since 2009.) Therefore, if you have an earlier version of XMLSpy and select "EMF" in this parameter, only PNG graphics will be generated instead.

Fix Imagemap Coordinates

Specify whether to correct imagemap coordinates generated by XMLSpy.

As of the versions XMLSpy 2004-2009, all rectangle areas contained in the hypertext imagemaps associated with the content model diagrams generated by XMLSpy are shifted slightly to the top and left, which makes every clickable area to appear somewhat displaced from where it should be.

We have found no rational purpose behind this and assumed that it was simply a bug. Therefore, we programmed a correction by adding (+10,+5) to every (x,y) coordinate found in the imagemaps.

Now, this works fine. But since it is likely the bug of XMLSpy, they may fix it some time later. In that case, our correction would actually produce a distortion by itself.

With this parameter, you can disable any corrections. Unselect it (or specify false) to have only the original imagemap coordinates (generated by XMLSpy) used in the result documentation.