Products         News         Downloads         Licensing         Shop         Support    

 DocFlex Technology
Overview
Features
Documentation
 DocFlex/XML
Overview
Features
Documentation
XSDDoc
Templates
Parameter Tree
Examples
FAQ
WSDLDoc
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 - XSDDoc - Parameter Tree

About XSDDoc parameters

«Details | Schema Overview» parameter group

This parameter group controls the content of the «Schema Overview» documentation blocks/pages that can be generated for each XML schema being documented.

See Also Parameter:

Generate Details | Schema Overviews”, which specifies whether to generate the Schema Overviews.

Parameter

Name / Type / Description

Schema Profile

doc.schema.profile : boolean

Specify whether to generate the «Schema Profile» section, which includes some general information about the XML schema.

Nested Parameters:

Control what exactly is included in the «Schema Profile» section.

Target Namespace

doc.schema.profile.targetNamespace : boolean

Specify whether to show the namespace URI targeted by the schema.

This is the value of 'targetNamespace' attribute of the <xs:schema> element.

Version

doc.schema.profile.version : boolean

Specify whether to show the XML schema version.

This is the value of 'version' attribute of the <xs:schema> element.

Components

doc.schema.profile.components : boolean

Specify whether to show the number of components by their types defined in the XML schema.

Default NS-Qualified Form

doc.schema.profile.formDefault : boolean

Specify whether to show the default namespace-qualified form for local elements and local attributes defined in the XML schema.

These are the values of 'elementFormDefault' and 'attributeFormDefault' attributes of the <xs:schema> element.

Default Block Attribute

doc.schema.profile.blockDefault : boolean

Specify whether to document 'blockDefault' attribute of the schema (<xs:schema> element).

This attribute specifies the default value of 'block' attribute of <xs:element> and <xs:complexType> elements defined in the schema.

Nested Parameters:

Specify how to document the 'blockDefault' attribute value.

Value

doc.schema.profile.blockDefault.value : boolean

Specify whether to show the actual value of the 'blockDefault' attribute.

Note: Empty or blank value will be ignored (treated as no-value)

Meaning

doc.schema.profile.blockDefault.meaning : boolean

Specify whether to include the text explaining the meaning of the 'blockDefault' attribute value.

Default Final Attribute

doc.schema.profile.finalDefault : boolean

Specify whether to document 'finalDefault' attribute of the schema (<xs:schema> element).

This attribute specifies the default value of 'final' attribute of <xs:element> and <xs:complexType> elements defined in the schema.

Nested Parameters:

Specify how to document the 'finalDefault' attribute value.

Value

doc.schema.profile.finalDefault.value : boolean

Specify whether to show the actual value of the 'finalDefault' attribute.

Note: Empty or blank value will be ignored (treated as no-value)

Meaning

doc.schema.profile.finalDefault.meaning : boolean

Specify whether to include the text explaining the meaning of the 'finalDefault' attribute value.

Schema Location

doc.schema.profile.location : boolean

Specify whether to show the location of the schema source file (or URL).

Relative Path

doc.schema.profile.location.relative : boolean

Specify whether to display schema location as a relative pathname.

When this parameter is selected (true) and the schema file resides on the local system, the file pathname will be converted to a relative one against the documentation destination directory.

Hyperlink

doc.schema.profile.location.hyperlink : boolean

Specify whether to generate a hyperlink to the schema file.

When this parameter is selected (true), the schema location text will be hyperlinked to the actual schema file.

When the displayed schema location is a relative pathname, the hyperlink is generated relatively to the location of the given document file. Otherwise, the hyperlink is generated to an absolute URL either on the local system or remote one.

Related Schemas

doc.schema.profile.relatedSchemas : boolean

Specify whether to show the lists of other XML schemas that this schema imports, includes and redefines.

Annotation

doc.schema.annotation : boolean

Specify whether to generate the «Annotation» section.

The full annotation text is 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.

See Also:

Processing | Annotations” parameter group, where you can specify how annotations are processed and displayed.

Component Summary

doc.schema.comps : boolean

Specify whether to generate summary tables of global components and local elements that are defined in the given XML schema.

Nested Parameters:

Specify the types of the components to be shown in the summary tables, the ordering of the components and which information must be displayed about each component.

The default values of the parameters are copied dynamically from the values of corresponding parameters in the group: Details | Fragments | Component Summary

Generate For

doc.schema.comps.for

The parameters in this group control for what type of components the summary is generated.

Elements
Local Elements
Complex Types
Simple Types
Element Groups
Attribute Groups
Global Attributes

doc.schema.comps.for.elements : boolean
doc.schema.comps.for.element.local : enum {"all", "complexType", "none"}
doc.schema.comps.for.complexTypes : boolean
doc.schema.comps.for.simpleTypes : boolean
doc.schema.comps.for.groups : boolean
doc.schema.comps.for.attributeGroups : boolean
doc.schema.comps.for.attributes : boolean

Specify whether to generate component summaries for particular components types.

Default Value:

The default values of these parameters are copied dynamically from the corresponding parameters in the group: Details | Fragments | Component Summary | Generate For

Sorting

doc.schema.comps.sorting : boolean

With this parameter you can specify the sorting order of components.

The parameter has the following meaning:

  • When it is selected (true), the XSD components will be sorted alphabetically by their names (ignoring letter case).

    The component name is assumed to be that under which the component appears (is referenced to) at the given documentation location. This is typically the component qualified name (which is the actual namespace prefix plus the component local name). That, however, can be changed using “Show | Namespace Prefixes” parameter.

    Additionally, in the case of local elements, the component name may also include a special extension used to distinguish the equally named local elements. For more details about this, please see “Show | Element Name Extensions” parameter.

  • When the parameter is unselected (false), the XSD components are not sorted. In that case they will follow in a certain "physical" order produced according to the following.

    When components come from different XML schemas, first, they will be grouped by their schemas. The ordering of those groups is determined by what XSD files have been specified initially and how they reference (e.g. import) other XSD files.

    Within a group of components that belong to the same XML schema, they will follow in the same order as they are defined in that schema.

    This allows you to control a particular ordering of components (e.g. elements) by yourself. Simply define the most important components (e.g. an XML document's root element) on the top of the XML schema. If you have several schemas to document, specify the most important of them the first. That will produce the component ordering as you wish (or something close to it).

Default Value:
Copied dynamically from the value of the parameter: Details | Fragments | Component Summary | Sorting

Annotation

doc.schema.comps.annotation : enum {"first_sentence", "full", "none"}

Specify whether to include in the summary item the XSD component annotation and which part of it.

The full annotation text is obtained from all <xs:documentation> elements found by the following path:

xs:component/xs:annotation/xs:documentation
where 'xs:component' is the particular XML element that defines the component (e.g. xs:complexType). Multiple <xs:documentation> elements produce different sections of the annotation text.

Possible Choices:

"first sentence"
Include only the first sentence of the annotation text.
"full"
Include the full annotation.
"none"
Do not include annotation.
Default Value:
Copied dynamically from the value of the parameter: Details | Fragments | Component Summary | Annotation
See Also:
Processing | Annotations” parameter group, where you can specify how annotations are processed and displayed.

Component Profile

doc.schema.comps.profile : boolean

Specify whether to include in the summary item the «Component Profile» section, which shows some general information about the XSD component.

Nested Parameters:

Control what is included in the Component Profile section. These parameters are similar to those found in “Detail | Component Documentation | Component Profile” parameter group.
Default Value:
The default values of this and nested parameters are copied dynamically from the corresponding parameters in the group: Details | Fragments | Component Summary | Component Profile

Related Component Lists

doc.schema.comps.lists : boolean

Specify whether to generate various summary lists of other XML schema components related to the given one.

Nested Parameters:

Control the generation of particular component lists and their appearance.
Default Value:
Copied dynamically from the value of the parameter: Details | Fragments | Component Summary | Related Component Lists

Content Attributes

doc.schema.comps.lists.contentAttributes : boolean

Specifies whether to generate the list of «Content Model Attributes».

This list shows all elements declared in the Content Model of the given component. These are the same attributes as shown in the component's XML Representation Summary (or in the component diagram).

Applies To:

  • Global & Local Elements
  • Complex Types
  • Attribute Groups
Default Value:
Copied dynamically from the value of the parameter: Details | Fragments | Component Summary | Related Component Lists | Content Attributes

Show Type/Value Info

doc.schema.comps.lists.contentAttributes.value : boolean

Specify whether to show the sumary informaton about the attribute's data type and possible values.

When true (selected), the attribute list will look the same as in the component's XML Representation Summary.

When false (unselected), only attribute names will be listed.

Default Value:

Copied dynamically from the value of the parameter: Details | Fragments | Component Summary | Related Component Lists | Content Attributes | Show Type/Value Info

Include Wildcards

doc.schema.comps.lists.contentAttributes.wildcards : boolean

Specifies whether the list of Content Model Attributes should include attribute wildcards. Default Value:

Copied dynamically from the value of the parameter: Details | Fragments | Component Summary | Related Component Lists | Content Attributes | Include Wildcards

Content Elements

doc.schema.comps.lists.contentElements : boolean

Specifies whether to generate the list of «Content Model Elements».

This list shows all elements declared in the 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 (or in the component diagram). 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.

Applies To:

  • Global & Local Elements
  • Complex Types
  • Element Groups
Default Value:
Copied dynamically from the value of the parameter: Details | Fragments | Component Summary | Related Component Lists | Content Elements

List Layout

doc.schema.comps.lists.contentElements.layout : enum {"flow", "one_column", "two_columns", "optimal"}

This parameter controls how the list items are displayed.

Possible Choices:

"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.

"one column"
The list will be printed in a single column: each item on a separate line.

This layout suits best for the lists containing long strings (particularly with spaces).

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

This representation suits more for the lists, whose items include strings with spaces.

However, when the list contains long strings, the two-column table may stretch far beyond the visible (printable) page width. In that case, the one-column layout suits better.

Also, the two-column layout may be not very good for big lists made of short word items (because it will occupy too much space). In that case the flow layout may fit better.

"optimal"
This choice allows for the list layout to be selected automatically during the generation so as to represent each particular list in both the most dense and readable form. (This is programmed in templates.)
Default Value:
Copied dynamically from the value of the parameter: Details | Fragments | Component Summary | Related Component Lists | List Layout

Include Wildcards

doc.schema.comps.lists.contentElements.wildcards : boolean

Specifies whether the list of Content Model Elements should include element wildcards.

Default Value:

Copied dynamically from the value of the parameter: Details | Fragments | Component Summary | Related Component Lists | Include Wildcards

XML Source

doc.schema.xml : boolean

Specify whether to generate the «XML Source» section that reproduces the XML source of the whole XML schema.

Nested Parameters:

Control how the reproduced XML source will look and what it should include.

Separate File

doc.schema.xml.separate : boolean

Specify whether the XML schema source must be placed in a separate HTML file.

Some XML schemas may be large enough. When XML source of such a schema is included in the «Schema Overview» page (along with the schema description and component summaries), that page becomes difficult to manage in a web-browser. This parameter allows you to split it into two pages:

  • When the parameter is selected (true), the XML schema source will be reproduced in a separate page (schema-source.html file).
  • When the parameter is unselected (false), the XML schema source will be included at the end the «Schema Overview» page.

Enclose in Box

doc.schema.xml.box : boolean

Specifies if the reproduced XML should be enclosed in a box.

Remove Annotations

doc.schema.xml.remove.anns : boolean

Specifies whether to remove all <xs:annotation> elements from the reproduced XML source of the whole schema.

You may want to exclude the <xs:annotation> elements from the reproduced XML source because such elements may occupy a lot of space (especially, when you use XHTML to format your annotations), so they could overwhelm anything else making it difficult to read other important things. Moreover, the actual content of the <xs:annotation> elements may be already shown (as a formatted text) in the corresponding «Annotation» sections of the documentation.

See Also Parameters:

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