Document! X for Xsd (Xml Schema) Documentation
Document! X supports documentation of Xml Schemas (Xsd files). Xml Schema documentation covers the following schema items:
View samples of XSD documentation generated by Document! X
Document! X Content File Editor - editing a Content File for an XSD Schema
Download a free evaluation version
Document! X can extract any documentation annotations created in the XSD source.
The documentation annotation type allows you to include basic
documentation within the XSD schema source.
Document! X Content Files are another way to create and edit content for your Xml Schema documentation. You can use both Xsd Schema annotations and a content file. Creating content using a Content File allows you to edit your documentation in an editable preview of the generated pages and is the most productive way to create and edit new documentation content.
In addition to documenting the Xml Schema objects themselves, Document! X will also generate relationship diagrams to illustrate the relationships between schema items (example below).
Example schema diagram generated by Document! X
The template based configuration that Document! X is based on makes it easy to:
- Create new comment types for use in source code comments;
- Adapt existing templates to match your existing corporate style and color scheme;
- Customize Table of Contents definitions according to your requirements;
- Fine tune the standard phrases and terminology used by Document! X to match your standards.
The easy to use Example code designer included in the Content Editors makes adding multi-language examples a breeze. In-line or linked examples can be created and example code is automatically colorized in the generated output.
Document! X supports several different languages (English, French, German, Dutch, Italian and Russian) for the phrases used in the generated output. All of the phrases and terminology in the generated output can be configured according to preference.
Document! X allows you to author content for multiple languages within a single project, showing you an embedded tip for the primary locale content when you are authoring in the Content File Editor for a secondary locale. If you use the Document! X and HelpStudio bundle you can export and import your localized content in XLIFF format; the industry standard for sending and receiving translation content from translation providers.