bitfehler / xs3p

Modernized fork of the xs3p XSD documentation tool - using bootstrap, markdown and HTML5.

Project discontinued

I haven't had to deal with XML and releated technologies for many years now and I don't feel capable of making informed decisions about this project anymore. I would like to thank everyone who contributed or wanted to contribute for their interest. I recommend you browse the available forks and find one that is still actively developed.

xs3p XSD documentation generator

This tool generates nice-looking HTML documentation from XML Schema Descriptions.

It is a fork of version 1.1.5 of the xs3p doc tool from http://xml.fiforms.org/xs3p/ - see the original README for more information.

Added features include:

• Complete re-design using Bootstrap
• Output of UTF-8 encoded files
• Output of HTML5
• Support Markdown formatting in <documentation> elements, powered by the Pagedown library

You can see a nice example result here:

• https://bitfehler.net/xs3p/address_annotated.xsd.html

which is the result of one of the examples added specifically to demonstrate the new features of this fork.

Another interesting example is the result for the XML Schema .xsd itself:

• https://bitfehler.net/xs3p/XMLSchema.xsd.html

That one pushes the system to its limits, but it's still useful in my opinion.

Known issues

• There is currently no way to inline the Bootstrap and jQuery sources, thus those files must be fetched when viewing the documentation. Their URLs can be set, though, so you could serve them locally if offline viewing is a requirement.
• While I even added some features (e.g. linking to the source attribute of the <documentation> element, if present), some features that have previously worked may have gone missing. Quite some refactoring was involved and it is quite hard to test some of the more esoteric features of XSD.
• There are some minor display issues, but as far as I can tell none of them impact the usability.

xs3p's Issues

Documentation sections empty since Bootstrap redesign

In the provided example, https://bitfehler.net/xs3p/address_annotated.xsd.html the documentation sections are empty, despite documentation annotations being present in the xsd.

Previously this was working.

Let's encrypt certificate on bitfehler.net is expired.

I guess your apache should be reloaded ?
p.s this tool looks awesome, gonna try this.

Non scrolling sidebar when the screen is wide makes content inacessible

If the page is narrow, the side bar .xs3p-sidebar goes to the top and the content is below. When I scroll the page it scrolls down normally.

If I resize the browser window to a wide size, the .xs3p-sidebar becomes fixed and doesn't scroll anymore. If its content is bigger than the windows size, it becomes impossible to access all the content in the side bar.

I believe the error is in the piece of code below, but I couldn't solve it:

               $(window).scroll(function() {
                  if ($(".xs3p-sidebar").css("position") == "fixed" && $(window).height() < $(".xs3p-sidebar").height()) {
                     var perc = $(window).scrollTop() / $("#xs3p-content").height();
                     var overflow = $(".xs3p-sidebar").height() + 105 - $(window).height();
                     $(".xs3p-sidebar").css("top", (65 - Math.round(overflow * perc)) + "px");
                  }
               });

I'm viewing my xsd schema file in Mozilla Firefox version 53 and processing it just adding the tag as the second line of my schema file.

BTW, thanks for the nice project.