How to generate simple documentation from XSD using XSLT

Question

We have several XSD files and one of them has the root element and others are imported or included. These XSD files represents an XML service request... for documentation reason, I need to extract all the element names and attributes under the root element.

What I need is to produce something like this:

<table>
  <tr>
     <td>ELELEMENT OR ATTRIBUTE NAME</td> 
     <td>Whether or not mandatory - by checking minOccurs="0"</td>
     <td>EMPTY OR THE TEXT VALUE under annotation/documentation IF AVAILABLE</td>
  </tr> 
</table>

score 2 · Answer 1 · answered Sep 08 '14 at 08:46

2

You might like to consider rendering the schema using Michael Sperberg-McQueen's stylesheet at http://www.w3.org/2008/09/xsd.xsl, or adapting this to your requirements. It works best when the schema contains extensive XHTML-formatted documentation.

answered Sep 08 '14 at 08:46

Michael Kay

156,231
11
92
164

We have Oxygen which generates a very nice HTML documentation but what I need is a simple table of all the elements in our schema in the output. It must be simple... my knowledge in xml stylesheet is very low ... I tried to create one but no luck! – xbmono Sep 08 '14 at 23:17

score 1 · Answer 2 · answered Sep 08 '14 at 19:10

1

There are several tools to generate HTML from sets of XSD schema documents; some are listed at the W3C page on XSD. The page is increasingly out of date, but many of the tools it lists are still available.

answered Sep 08 '14 at 19:10

C. M. Sperberg-McQueen

24,596
5
38
65

score 1 · Accepted Answer · answered May 22 '15 at 17:51

1

I made an xslt stylesheet that does exactly what you asked for: https://github.com/S2-/xsddoc

answered May 22 '15 at 17:51

Simon

422
5
19

How to generate simple documentation from XSD using XSLT

3 Answers3