Site Map   PRODUCTS ------------------------------------- DocFlex Technology    About    Key Features    Data Processing    Formatting    Templates/Template Designer    Documentaion   DocFlex/XML    About    Documentaion        Installation & Config Files        Running Generator         Designing Templates    Sample        XMLDoc        Sales Report        Alternative to XSLT    XSDDoc        Features        Organization        Examples        Templates        Parameters        FAQ    Integrations        Apache Ant        Apache Maven        XMLSpy    Tutorials   DocFlex/Javadoc    About    Documentaion    Templates    Examples    Tutorials   DocFlex/Together    About    Examples    Basic Templates    Documentaion    Tutorials   TRY ------------------------------------- Downloads Registration Trial License   BUY ------------------------------------- Licensing/Pricing Shop   COMPANY ------------------------------------- News Products Services Customers About Us Imprint Legal    Terms of Use    Business Terms & Conditions    End User License Terms Contact Links

DocFlex/XML - XSDDoc - Documentation Organization

1. Main Blocks
   • Overview Summary
   • All Component Summary
   • Namespace Overview
   • Schema Overview
   • Component Documentation
   • XML Namespace Bindings
2. Hyperlinks and Navigation

1.  Main Blocks

Overview Summary

Generated By Template:

The Overview Summary block is generated by overview-summary.tpl template.

Controlled By Parameters:

• “Generate Details | Overview Summary” parameter specifies whether to generate the Overview Summary.
• “Details | Overview Summary” parameter group controls the exact content of the Overview Summary block.

The Overview Summary block may include the following sections:

Section	Description	Controlled By Parameters
Namespace Summary	This section enumerates all documented namespaces (i.e. those targeted by at least one of the documented XML schemas) along with brief information about each namespace.	Details | Overview Summary | Namespace Summary
Schema Summary	This section enumerates all documented XML schemas along with a few details about each of them.	Details | Overview Summary | Schema Summary

All Component Summary

Generated By Template:

The All Component Summary block is generated by all-components-summary.tpl template.

Controlled By Parameters:

• “Generate Details | All Component Summary” parameter specifies whether to generate the All Component Summary block.
• “Details | All Component Summary” parameter group controls what is included in the All Component Summary block.

The All Component Summary block may include the following sections:

Section	Description	Generated By Template	Controlled By Parameters
Element Summary	The summary of all global element components and some of the local element components.	elementSummary.tpl	Details | All Component Summary | Elements
Complex Type Summary	The summary of all global complexType components.	complexTypeSummary.tpl	Details | All Component Summary | Complex Types
Complex Type Summary	The summary of all global complexType components.	complexTypeSummary.tpl	Details | All Component Summary | Complex Types
Simple Type Summary	The summary of all global simpleType components.	simpleTypeSummary.tpl	Details | All Component Summary | Simple Types
Element Group Summary	The summary of all global element group components.	groupSummary.tpl	Details | All Component Summary | Element Groups
Global Attribute Summary	The summary of all global attribute components.	attributeSummary.tpl	Details | All Component Summary | Global Attributes
Attribute Group Summary	The summary of all global attribute group components.	attributeGroupSummary.tpl	Details | All Component Summary | Attribute Groups

Namespace Overview

Generated By Template:

The Namespace Overview block is generated by namespace-summary.tpl template.

Controlled By Parameters:

• “Generate Details | Namespace Overviews” parameter specifies whether to generate the Namespace Overview block.
• “Details | Namespace Overview” parameter group controls what is included in the Namespace Overview block.

See Also:

How everything is documented | Namespaces

The Namespace Overview block may include the following sections:

Section	Description	Generated By Template / Template Section	Controlled By Parameters
Namespace Profile	The brief information about the namespace. This includes the list of the XML schemas targeting this namespace, the number of components by types, etc.	namespaceProfile.tpl	Details | Namespace Overview | Namespace Profile
Schema Summary	This section enumerates all documented XML schemas targeting this namespace along with a few details about each schema.	namespace-summary.tpl | "schema summary"	Details | Namespace Overview | Schema Summary
Component Summaries	The summary tables of all global components and local elements that belong to the given namespace (that is defined in all XML schemas which target this namespace).	namespace-summary.tpl | "COMPONENT SUMMARY"	Details | Namespace Overview | Component Summaries

Schema Overview

Generated By Template:

The Schema Overview block is generated by schema-summary.tpl template.

Controlled By Parameters:

• “Generate Details | Schema Overviews” parameter specifies whether to generate the Schema Overview block.
• “Details | Schema Overview” parameter group controls what is included in the Schema Overview block.

See Also:

DocFlex/XML | XSDDoc | Which XML Schemas you can document

The Schema Overview block may include the following sections:

Section	Description	Generated By Template / Template Section	Controlled By Parameters
Schema Profile	The general summary information about the schema.	schemaProfile.tpl	Details | Schema Overview | Schema Profile
Annotation	This section displays the full annotation text obtained from all <xs:documentation> elements found by the following path: xs:schema / xs:annotation / xs:documentation Multiple <xs:documentation> elements produce separate sections of the annotation text.	annotation.tpl	Details | Schema Overview | Annotation
Component Summaries	The summary tables of all global components and local elements defined in the given XML schema.	schema-summary.tpl | "COMPONENT SUMMARY"	Details | Schema Overview | Component Summaries
XML Source	Full XML source of the schema.	schema-summary.tpl | "XML SOURCE"	Details | Schema Overview | XML Source

Component Documentation

The “Component Documentation” is actually a generic name for different types of main documentation blocks generated for particular XSD component types. However, all such blocks are made of the same sections and their content is controlled by the same parameter group: Details | Component Documentation.

The following table shows all types of Component Documentation blocks that can be generated for particular types of components, the templates generating them and the template parameters to control if such documentation should be generated.

Component Type	Documentation Block	Generated By Template	Controlled By Parameters
Global / Local Elements	Element Documentation	element.tpl	Generate Details | Elements
Complex Types	Complex Type Documentation	complexType.tpl	Generate Details | Complex Types
Simple Types	Simple Type Documentation	simpleType.tpl	Generate Details | Simple Types
Element Groups	Element Group Documentation	group.tpl	Generate Details | Element Groups
Global Attributes	Attribute Documentation	attribute.tpl	Generate Details | Global Attributes
Attribute Group	Attribute Group Documentation	attributeGroup.tpl	Generate Details | Attribute Groups

The following screenshots show samples of Element Documentation, Element Group Documentation and Simple Type Documentation, where all those sections are employed (click to view the HTML):

The Component Documentation is built of the following sections:

Section	Description
Component Profile	The summary information about the component (such as which namespace it belongs to, where it is declared, type and content, etc.) Generated For: All components Generated By Template: (depending on the component type) elementProfile.tpl, typeProfile.tpl, groupProfile.tpl, attributeProfile.tpl, attributeGroupProfile.tpl Controlled By Parameter Group: Details | Component Documentation | Component Profile
Content Model Diagram	Shows a graphic diagram representation of the component content model. Currently, the content model diagrams can be generated only by an extension of DocFlex/XML that employs the functionality provided by some other software (for instance, the integration with Altova XMLSpy; see "Integrations | XMLSpy" parameter group). Generated For: Elements Complex Types Element Groups Generated By Template: diagram.tpl Controlled By Parameter Group: Details | Component Documentation | Content Model Diagram See Also: How everything is documented | Complex Content | Content Model | Content Model Diagram
XML Representation Summary	Shows a schematic text representation of all possible XML constructions this component describes as well as how those constructions may look in an XML file. Generated For: All components Generated By Template: xmlRep.tpl Controlled By Parameter Group: Details | Component Documentation | XML Representation Summary See Also: How everything is documented | Complex Content | Content Model | XML Representation Summary
Simple Content Detail	Describes the simple content defined by (or associated with) this component. Under the term "simple content", we mean any data that comply with one of the XSD basic datatypes (e.g. xs:string or xs:boolean). In the case of XML elements, such data may represent the content of some element. In the case of attributes, it is the attribute value. Generated For: 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. Generated By Template Section: (depending on the component type) element.tpl | "Simple Contant Detail" simpleType.tpl, complexType.tpl | "Simple Content Restrictions" attribute.tpl | "Attribute Value Detail" Controlled By Parameter Group: Details | Component Documentation | Simple Content Detail See Also: How everything is documented | Simple Content
Lists of Content Elements	This list shows all elements declared in the Element Content Model of the given component. These are the same elements as shown in the Complex Content Model of the component's XML Representation Summary. However, unlike in the model representation, the elements in this list are ordered alphabetically, never repeat and hyper-linked directly to the corresponding Element Documentations. Generated For: Global / Local Elements Complex Types Element Groups Generated By Template: contentElementList.tpl Controlled By Parameter: Details | Component Documentation | Lists of Related Components | Content Elements See Also: How everything is documented | Complex Content
Lists of Containing Elements	This list is generated only for Element Components, where it appears under the heading "Included in content model of elements". The list shows all elements whose content models explicitly include the given element. (Here, "explicitly" means that element wildcards are not taken into account.) Generated For: Global / Local Elements Generated By Template Section: element.tpl | "Lists of related elements" | "List of Containing Elements" Controlled By Parameter: Details | Component Documentation | Lists of Related Components | Containing Elements See Also: How everything is documented | Global Elements, Local Elements
Lists of Substitutable Elements	The list of elements this element may substitute for (that is, the given element may be used anywhere instead of the elements in the list). This list will appear under the heading "May substitute for elements". Generated For: Global Elements Generated By Template Section: element.tpl | "Lists of related elements" | "List of elements this element may substitute for" Controlled By Parameter: Details | Component Documentation | Lists of Related Components | Substitutable Elements See Also: How everything is documented | Global Elements | Substitution Groups
Lists of Substituting Elements	The list of elements that may substitute for the given element. (These are the members of the substitution group headed by the given element.) The list will appear under the heading "May be substituted with elements". Generated For: Global Elements Generated By Template Section: element.tpl | "Lists of related elements" | "List of elements this element may be substituted with" Controlled By Parameter: Details | Component Documentation | Lists of Related Components | Substituting Elements See Also: How everything is documented | Global Elements | Substitution Groups
Lists of Possible Children By Substitutions	The list of all known elements that may be included in the given element by substitutions. In particular, the list shows all members of the substitution groups whose head elements are declared in the content model of the given element component. The list will appear under the heading "May contain elements by substitutions". Generated For: Global / Local Elements Generated By Template Section: element.tpl | "Lists of related elements" | "List of possible children by substitutions" Controlled By Parameter: Details | Component Documentation | Lists of Related Components | Children By Substitutions See Also: How everything is documented | Global Elements | Substitution Groups
Lists of Possible Parents By Substitutions	The list of all known elements that may include the given element by substitutions. In particular, the list shows all elements whose content models include the head element of a substitution group which the given element is member of. The list will appear under the heading "May be included in elements by substitutions". Generated For: Global Elements Generated By Template Section: element.tpl | "Lists of related elements" | "List of possible parents by substitutions" Controlled By Parameter: Details | Component Documentation | Lists of Related Components | Parents By Substitutions See Also: How everything is documented | Global Elements | Substitution Groups
List of Direct Subtypes	The list of all known Simple/Complex Type components that are directly derived from the given Type component. Note: A type is said to be directly derived from the given type, when its definition contains an explicit reference to the given type. Generated For: Simple Types Complex Types Generated By Template Section: typeRelatedCompLists.tpl | "Known Direct Subtypes" Controlled By Parameter: Details | Component Documentation | Lists of Related Components | Direct Subtypes See Also: How everything is documented | Types
List of Indirect Subtypes	The list of all known Simple/Complex Type components that are indirectly derived from the given Type component. Note: A type is said to be indirectly derived from the given type, when its definition contains no explicit references to the given type but a reference to a certain third type that is directly or indirectly derived from the given type. Generated For: Simple Types Complex Types Generated By Template Section: typeRelatedCompLists.tpl | "Known Direct Subtypes" Controlled By Parameter: Details | Component Documentation | Lists of Related Components | Indirect Subtypes See Also: How everything is documented | Types
List of All Based Elements	This list is generated for each Simple/Complex Type component. It shows all elements whose type is either the given type itself or directly/indirectly derived from the given type. Generated For: Simple Types Complex Types Generated By Template Section: typeRelatedCompLists.tpl | "All direct/indirect based elements" Controlled By Parameter: Details | Component Documentation | Lists of Related Components | All Based Elements See Also: How everything is documented | Types, Global Elements, Local Elements
List of All Based Attributes	This list is generated for each Simple Type component. It shows all attributes (defined both globally and locally) whose type is either the given type itself or directly/indirectly derived from the given type. Generated For: Simple Types Generated By Template Section: typeRelatedCompLists.tpl | "All direct/indirect based attributes" Controlled By Parameter: Details | Component Documentation | Lists of Related Components | All Based Attributes See Also: How everything is documented | Types, Attributes
Usage / Definition Locations	For global components, this section shows where and how the given component is used within this XML schema (where the component is defined) and within other XML schemas included in the documentation. For local elements, any usage locations are actually where the element is defined. So, the section is called "Definition Locations". For more details, see Local Elements. Generated For: All components Generated By Template / Template Section: (depending on the component type) typeUsage.tpl element.tpl | "Usage / Definition Locations" group.tpl | "Usage Locations" attribute.tpl | "Usage locations" attributeGroup.tpl | "Usage locations" Controlled By Parameter Group: Details | Component Documentation | Usage / Definition Locations
Annotation	This section displays the full annotation specified for the given component. The annotation text is obtained from the <xs:documentation> elements found by the following path: xs:component/xs:annotation/xs:documentation where 'xs:component' is the particular XSD element which defines the component (e.g. xs:complexType). Multiple <xs:documentation> elements produce separate sections of the annotation text. Generated For: All components Generated By Template: annotation.tpl Controlled By Parameter Group: Details | Component Documentation | Annotation See Also: How everything is documented | Annotations
Type Definition Detail	This section shows the details about the definition of the type associated with (or represented by) the given component. It may include: The Type Derivation Tree summary, which depicts how this type was derived from the most basic types. The type annotation (which is generated in the case of an element or attribute component). In the case of a simple type (or a complex type with simple content), this section may also include all details about how the datatype was derived including all facets and annotations to them. With the nested "Simple Content Derivation" parameter, you can specify whether to document in that way the entire type derivation tree produced by all known XML schema components involved. Generated For: Global / Local Elements Global Attributes Simple Types Complex Types Generated By Template Section: (depending on the component type) element.tpl | "TYPE DETAIL" attribute.tpl | "TYPE DETAIL" simpleType.tpl | "TYPE DEFINITION DETAIL" complexType.tpl | "TYPE DEFINITION DETAIL" Controlled By Parameter Group: Details | Component Documentation | Type Definition Detail See Also: How everything is documented | Types | Type Definition Detail
XML source	The reproduced fragment of the XML schema source that defined the given component. Generated For: All components Generated By Template: nodeSource.tpl Controlled By Parameter Group: Details | Component Documentation | XML Source See Also: How everything is documented | XML Source
Attribute Detail	This section documents the attribute declarations (both specified within the component itself and inherited from its ancestors) that define the attribute model represented by the given component. This may include: Local attribute definitions References to global attribute Attribute wildcards Prohibitions of attributes Generated For: Global / Local Elements Complex Types Attribute Groups Generated By Template: attributes.tpl Controlled By Parameter Group: Details | Component Documentation | Attribute Detail See Also: How everything is documented | Complex Content, Attributes
Content Element Detail	This section documents the element declarations (both specified within the component itself and inherited from its ancestors) that define the element content model represented by the given component. This may include: Local element definitions References to global elements Element wildcards Generated For: Global / Local Elements Complex Types Element Groups Generated By Template: contentElements.tpl Controlled By Parameter Group: Details | Component Documentation | Content Element Detail See Also: How everything is documented | Complex Content

XML Namespace Bindings

Here is how it looks in both HTML and RTF (click to see the real HTML or enlarge):

Generated By Template:

The XML Namespace Bindings block is generated by xmlns-bindings.tpl template.

Controlled By Parameter:

Whether to generate it is controlled by the template parameter: Generate Details | XML Namespace Bindings.

See Also:

How everything is documented | Namespaces

2.  Hyperlinks and Navigation