Liquid XML Studio
Generate Documentation
Send Feedback
XSD Editor > Tools > Generate Documentation

Glossary Item Box

You can generate HTML documentation for your XML Schema (XSD) using the Liquid XML Schema Documentation Generator. It is only accessible when an XSD file is the selected document, and can be invoked using the tool bar icon (), via the menu (Tools->Generate Documentation) or via the command line.

The generator can output your documentation in the following formats

If you select custom templates then it is possible to provide a set of XSLT stylesheets that will be used to generate your documentation, the HTML and ASP.Net templates are provided as a starting point for this. See Custom XSD Documentation Templates for more information.

Sample output can be seen at http://schemas.liquid-technologies.com

When you select the Schema Documentation Generator tool, a wizard is provided to guide you through the process.

XSD Documentation Generator Wizard Page 1

 

You must select the type of documentation to generate, choose asp.net if you are planning to host the documentation on an IIS server, choose html if you want to use the documentation on a disk or another type of web server. The custom templates allow you to select your own XSLT transform to use. See Custom Templates.

XSD Documentation Generator Wizard Page 2

 

The Documentation title is shown at the top of each output page, and as the html page title, the documentation you provide is added to the home page for your mini site.

 

 XSD Documentation Generator Wizard Page 3

Output Directory

The directory where the documentation files will be placed. This process can create a lot of files so it is recommended that you select an empty folder.

Include DISQUS commenting

Commenting allows users to place comments against each documentation page, this can be useful when a schema is being designed, or can show usage notes etc. To use the commenting system you will need to create a free DISQUS account (visit http://disqus.com/). The Thread ID qualifies each page within your mini-site making the comments unique to it.

DISQUS

 

XSD Documentation Generator Wizard Page 4

Additional Schemas

Some schemas have a number of root level schema files, i.e. you may have one schema with common elements, then a top level schema describing an Invoice and another top level schema describing a Customer. This page allows you to add in any additional schemas you want documenting, and linking into your documentation. For most schemas this is not necessary.

 

Pressing Finish will start the documentation generation, this can take a little time if your schema is very large. The output folder should be opened when the process completes.