Document! X for XSD (XML Schema)Documentation
Document! X supports documentation of XSD Schemas. XSD Schema documentation covers the following schema items:
-
Elements
-
Simple Types
-
Complex Types
-
Attributes
Authoring content
Document! X can extract any documentation annotations created in the XSD source.
Example:
<annotation>
<documentation xml:lang="en">
The documentation annotation type allows you to include basic
documentation within the XSD schema
source.
</documentation>
</annotation>
Document! X Content Files are another way to create and edit content for your XSD 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.
Schema Diagrams
In addition to documenting the XSD 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
Customization
The template based configuration that Document! X is based on makes it easy to:
- Create new comment types for use in source code comments;
- Add additional standard content to the generated documentation (for example a glossary or company information);
- 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.
Help where you need it
The Document! X IDE includes a comprehensive help system, including a Contents, Index and Dynamic Help window. The Dynamic Help window provides a list of help topics,
tutorials, getting started guides and movies relevant to your current activity enabling both new and experienced users to get to grips with Document! X functionality as quickly as
possible.
Document! X includes several printable 'Getting Started' PDF booklets to enable you to get immediate results from Document! X.
Authoring examples
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.
Localization
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.
Model Comments - re-usable common descriptions
Model Comments allow you to define common descriptions in a model comment profile for re-use in future projects. For example, ActiveX controls usually support a set of
common properties and events (e.g. KeyPress event, BackColor property) - Model Comments allow you to define descriptions for these members once and have Document! X use them
wherever the members appear in order to reduce duplication and effort.