Document! X supports documentation of XSD Schemas. XSD Schema documentation produces a comprehensive documentation set for your XSD Schemas covering Elements, Simple Types, Complex Types, Groups, Attributes, Attribute Groups, Constraints, and Facets.
Document! X can extract any documentation annotations created in the XSD source against any schema items.
<annotation> <documentation xml:lang="en"> The documentation annotation type allows you to include basic documentation within the XSD schema source. </documentation> </annotation>
Create a New XSD Schema Reference Documentation Project
Creating an empty project creates a project without any content. You can customize its settings according to your needs.
To create an empty project:
The project is created at the default directory which is configurable in the Options Editor (Paths page). However, you can optionally choose a specific directory to save your project by browsing the Project Directory field.
The new empty documentation project is created and opened for edit. You can now add the XSD Schemas that you want to document:
The selected Xsd Schema is added to the Project Explorer under the Xsd Schemas node. You can expand down through the XSD Schema node to select / deselect individual XSD Schema elements in order to include / exclude them from the generated output. Repeat the process above to add additional XSD Schemas to this project.
A Content File is created and added to the project under the Content Files node for each added XSD Schema. You can use this Content File to author additional content in the pages that Document! X automatically generates.
Author Content in the XSD Schema
You can use the XSD Schema annotation feature to author documentation content directly within your XSD Schema. Annotation content is used by default in the Summary section of the related generated page.
<xs:element name="purchaseOrder" type="PurchaseOrderType"> <xs:annotation> <xs:documentation xml:lang="en">The purchase order.</xs:documentation> </xs:annotation> </xs:element>
See Author Content using the Content File Editor for editing outside of the schema.
Author content outside of the schema
If you would like to supplement the content of the pages automatically generated by Document! X and HelpStudio outside of the source code, you can do so using the Document! X and HelpStudio Content File Editor.
The Content File Editor allows you to review and author content for any item for which a reference documentation page is generated.
To open the Content File Editor:
Add Conceptual Topics
Conceptual information is a key part of reference documentation, providing a high level introduction, tutorials, or other conceptual information. You can easily create conceptual topics in Document! X.
You can find more information on Topic Editing in the Topic Editor topic.
Change XSD Schema Documentation Settings
The settings that govern XSD Schema Documentation generation are defined in the Build Profile editor. In a new project there is a single Build Profile but you can define many build profiles if you want to create multiple outputs with different settings.
To edit XSD Schema documentation settings:
In the Build Profile editor, you can find the XSD Schema Settings page under the Reference Documentation section.
You can change the Template used for XSD Schema documentation (which defines the look and feel of generated pages) on the Templates page.
Identify Undocumented Items
An essential part of delivering a complete documentation set is ensuring that all the items have been documented. Document! X includes the Undocumented Items tool to quickly and easily identify undocumented items.
Build and Deploy Database Reference Documentation
Click the Build button on the Project tab to build your XSD Schema reference documentation.
Refer to the Deployment topic for more information on how to deploy your documentation to other machines.