views:

72

answers:

3

My application uses an XML file of some complexity for configuration. It's not much - about two dozen elements - but still non-trivial.

Currently I'm writing XML schema for it, and was wondering if there was a tool which would generate documentation from this schema? Something human-readable that can be used by a person who has to write the XML file. Definitely with the possibility of including my own comments for each XML element.

+1  A: 

Have you checked out XMLSpy or oXygen XML Editors?

They both claim to format XMLSchema in an easy to read format.

Also XML Schema is an XML format, so it should not be hard to write an XSLT tranform to format it for user friendlier display.

Sarah Happy
I don't think you understood what I want. I want to **document** my XML schema. As in - generate a help file with explanations for every element in the schema.
Vilx-
I would personally attempt to insert the commentary into an xml schema file, in the comments sections on each defined element, then run a transform to make it look friendlier, this assumes that the audience of the document understands how to write XML files.
Sarah Happy
Turns out we have XMLSpy and it can generate some sort of help file. Not much, but can live with it.
Vilx-
A: 

You can use Doxygen for that!

Check this page out it has a brief tutorial and review of other tools.

Aron
Really? I don't see anything about XML schema mentioned there...
Vilx-
For Doxygen the XML schema is just a simple XML document.It will only search for comments.
Aron
A: 

I think, what you need is a XSD Documentation Generator. Try DocFlex or xsddoc from W3C Schema site.

dma_k