Parameter/Group |
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 Summaries
|
doc.schema.comps : boolean
Specify whether to generate the
Component Summaries
section.
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 selecting the components are calculated dynamically
from the corresponding parameters of the
“Generate Details” group.
That is, by default, only those components will appear in the summary tables which you have
already specified to be documented in full. The parameters just allow you to override this.
|
|
Summary Item
|
doc.schema.comps.item
This parameter group controls which information about a component will appear in a
summary table item.
|
|
Annotation
|
doc.schema.comps.item.annotation : enum {"first_sentence", "full", "none"}
Specify whether to include the component
annotation
and which part of it.
Possible Choices:
-
"first sentence"
-
Include only the
first sentence
of the annotation text.
-
"full"
-
Include the full annotation.
-
"none"
-
Do not include annotation.
See Also:
“Processing | Annotations”
parameter group, where you can specify how annotations are processed and displayed.
|
|
Component Profile
|
doc.schema.comps.item.profile : boolean
Specifies whether to generate the
Component Profile
section, which shows the general summary information about the 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.
|
|
Sorting
|
doc.schema.comps.sorting : boolean
Specify the sorting order of components.
The exact meaning of this parameter is the same as of
“Generate Details | Sorting | Components”
parameter, from which it also inherits its default value.
|
|
Elements
Local Elements
Complex Types
Simple Types
Element Groups
Global Attributes
Attribute Groups
|
doc.schema.comps.elements : boolean
doc.schema.comps.element.local : enum {"all", "complexType", "none"}
doc.schema.comps.complexTypes : boolean
doc.schema.comps.simpleTypes : boolean
doc.schema.comps.groups : boolean
doc.schema.comps.attributes : boolean
doc.schema.comps.attributeGroups : boolean
Specify whether to generate
component summaries
for particular components types.
Note:
The default values of these parameters are provided dynamically by the respective parameters in
“Generate Details” group
(e.g. “Generate Details | Elements”).
|
|
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.
|
|
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:
|
