Generating Documentation for WSDL Documents

You can use Oxygen XML Editor to generate detailed documentation for the components of a WSDL document in HTML format. You can select the WSDL components to include in your output and the level of details to present for each of them. Also, the components are hyperlinked.

Note: The WSDL documentation includes the XML Schema components that belong to the internal or imported XML schemas.

Note: To obtain the documentation in a custom format, use custom stylesheets.

To generate documentation for a WSDL document, select WSDL Documentation... from the Tools > Generate Documentation menu or from the Generate Documentation submenu in the contextual menu of the Project view.

Figure: The Output Panel of the WSDL Documentation Dialog Box

The Input URL field of the dialog panel must contain the full path to the WSDL document that you want to generate documentation for. The WSDL document can be located either local or remote. You can also specify the path to the WSDL document using editor variables.

You can split the output into multiple files using different criteria. For large WSDL documents, choosing a different split criterion may generate smaller output files providing a faster documentation browsing.

The available split criteria are:

By location - each output file contains the components from the same WSDL document.
By namespace - each output file contains information about components with the same namespace.
By component - each output file contains information about one WSDL or XML Schema component.

To export the settings of the WSDL Documentation dialog to an XML file, click the Export settings button. With the exported settings file, you can generate the same documentation from the command-line interface.

Figure: The Settings Panel of the WSDL Documentation Dialog

When you generate documentation for WSDL documents, you can choose what components (services, bindings, messages and others) and details (namespace, location, instance and others) to include in the documentation:

Components
- Services - specifies whether the generated documentation includes the WSDL services.
- Bindings - specifies whether the generated documentation includes the WSDL bindings.
- Port Types - specifies whether the generated documentation includes the WSDL port types.
- Messages - specifies whether the generated documentation includes the WSDL messages.
- XML Schema Components specifies whether the generated documentation includes the XML Schema components.
  - Only global elements and types - specifies whether the generated documentation includes only global elements and types.
Details
- Namespace - presents the namespace information for WSDL or XML Schema components.
- Location - presents the location information for each WSDL or XML Schema component.
- Used by - presents the list of components that reference the current one.
- Documentation - presents the component documentation. In case you choose Escape XML Content, the XML tags are presented in the documentation.
- Source - presents the XML fragment that defines the current component.
- Instance - generates a sample XML instance for the current component.
  Note: This option applies to the XML Schema components only.
- XML Schema Diagram - Displays the diagram for each XML Schema component. You can choose the image format (JPEG, PNG, GIF, SVG) to use for the diagram section.
- Diagram annotations - specifies whether the annotations of the components presented in the diagram sections are included.