[Mono-docs-list] Re: xslt update -- it's getting interesting

Miguel de Icaza miguel@ximian.com
29 Oct 2002 10:36:05 -0500


> Announcing release 0.2 of statidoc, code named "Clark is Paid by the
> Pound".  Things are starting to get interesting.

Awesome job!

> Statidoc is an XSLT-based documentation generator.  It is meant to be
> the basis for online documentation viewers, but it produces perfectly
> good static HTML documentation as well.
> First, the demo.
>    http://www.rinspin.com/~bronson/mono/statidoc-0.2/output/index.html
> The struck out links show where xml documentation files are missing. 
> All other links should now work.  If you find any that don't, please
> email me.

The demo is excellent ;-)

> Building:
> If you want to build the docs on your own machine, you only need the
> monodoc CVS tree and the Sablotron XSL processor.  Download statidoc-0.2
> from
>    http://www.rinspin.com/~bronson/mono/statidoc-0.2/statidoc-0.2.tar.gz
> unzip it in your monodoc directory, and follow the directions in the
> readme.

How much of the stuff is particular to the Sablotron XSL processor?  We
will be using a different processor for the Mono implementation, and I
would like to know if it is easy to replace (we will be using libxslt
through the .NET Xstl API). 

> Overloading works, but I don't like the way it's laid out.  Right now, I
> don't include arguments, so you see a bunch of identical method names,
> so it's confusing.  When I do include arguments, however, it's too
> cluttered and, yes, confusing.  Does anybody have any suggestions on how
> to nicely handle overloading?

In the Microsoft documentation a single entry is shown for it, and if
you click on it, you go to a page where you see the N overloaded members
(you get basically a summary page for them).

My only suggestion at this point is to try to make the output match the
layout of the Microsoft docs, which is what most of us are familiar
with.   But this is only a tiny suggestion, you have now done all the
really hard work, and it is now up to us to produce the documentation

Thanks a lot for the work.