Oxygen XML Editor plugin
can generate detailed
documentation for the components of an XML Schema in HTML, PDF and DocBook XML formats similar
with the Javadoc documentation for the components of a Java class. You can select the
components and the level of detail. The components are hyperlinked in both HTML and DocBook
documents.
To generate documentation for an XML Schema document use the dialog Schema
Documentation. It is opened with the action .
It can be also opened from the Navigator
contextual menu:
The dialog enables the user to configure a large set of parameters for the process of
generating the documentation.
The Schema URL field of the dialog panel must contain the full path to
the XML Schema (XSD) file you want to generate documentation for. The schema may be a local or
a remote one. You can specify the path to the schema using the editor variables.
The following options are available in the
Settings tab:
You can choose to split the output into multiple files by namespace, location or component.
When you generate documentation for a schema you can choose what components to include in the
output (global elements, global attributes, local elements, local attributes, simple types,
complex types, group, attribute groups, referenced schemas, redefines) and the details to be
included in the documentation:
- Diagram - Displays the diagram for each component. You can choose
the image format (JPEG, PNG, SVG) to use for the diagram
section.
- Diagram annotations - This option controls whether or not the
annotations of the components presented in the diagram sections should be included.
- Namespace - Displays the namespace for each component.
- Location - Displays the schema location for each component.
- Type - Displays the component type if it is not an anonymous
one.
- Type hierarchy - Displays the types hierarchy.
- Model - Displays the model (sequence, choice, all) presented in BNF
form. Different separator characters are used depending on the information item used:
- xs:all - its children will be separated by space characters;
- xs:sequence - its children will be separated by comma
characters;
- xs:choice - its children will be separated by |
characters.
- Children - Displays the list of component's children.
- Instance - Displays an XML instance generated based on each schema
element.
- Used by - Displays the list of all the components that refer the
current one. The list is sorted by component type and name.
- Properties - Displays some of the component's properties.
- Facets - Displays the facets for each simple type
- Identity constraints - Displays the identity constraints for each
element. For each constraint there are presented the name, type (unique, key, keyref), refer
attribute, selector and field(s).
- Attributes - Displays the attributes for the component. For each
attribute there are presented the name, type, fixed or default value, usage and
annotation.
- Annotations - Displays the annotations for the component. If you
choose Escape XML Content, the XML tags are present in the
annotations.
- Source - Displays the text schema source for each component.
- Generate index - Displays an index with the components included in
the documentation.
- Include local elements and attributes - If checked, local elements
and attributes are included in the documentation index.
- Export settings / Load settings - The current settings can be saved
for further usage (for example for generating documentation from command-line interface)
with the Export settings button, and reloaded when necessary with the Load
settings button.
These options are persistent between sessions.