fantasai wrote:
Michael A Nachbaur wrote: > I'm going to leave ECMA-262 for now though, and am progressing on to > DOM Level 2 Core.
I assume you've seen http://www.mozilla.org/docs/dom/domref/ How does what you're doing relate to that?
Well, as you can see at http://nachbaur.com/software/mozilla/ and http://aomdev.nachbaur.com/aboutmozref.xhtml, I started writing Mozilla applications, but had difficulties in finding documentation for the various methods that were available with the object model. The problem, it dawned on me, was that since Mozilla consists of many different specifications, the documentation for which is sometimes incomplete, or inaccurate (e.g. JavaScript documentation on MSDN). It made it hard to track down just what methods and properties were available to me from Mozilla.
So, I decided to document all the objects available to a JavaScript developer in one central place. Thats why I have the sidebar "Ancestry" tree, so for a given object you can see all the methods, inherited or otherwise, that you have access to.
So, essentially, my plan is that my reference could replace the domref on mozilla.org. The same content will be documented, except my site will hopefully document the rest of what is available. My goal is to have code synopsis', prototype definitions, descriptions (for methods, objects, properties and method's parameters) for every object that is available from within Mozilla. The printable and quick ref sheets I'm hoping would be the sort of thing people could print off to set by their keyboard while coding, and there's an RDF view available so that the documentation can be integrated into a Mozilla sidebar.
I'm interested in the back end you're using to generate your site. What format is the reference in, and where does the HTML design come from?
The HTML design was more-or-less written by me, though it was inspired by safari.oreilly.com and ... something else ... the name of which escapes me. On the aboutmozref.xhtml page up above, there's a little description of the technologies used. Its built using AxKit (I'm one of the core commiters for the project), the documentation is in XML, and there's a set of XSL stylesheets for rendering the interface.
The source code for the entire site is available at http://cvs.nachbaur.com/cgi-bin/viewcvs.cgi/MozillaAOMReference/ and there's an online request tracking page at http://rt.mozref.com.
The format of the XML files is custom, mainly to make editing of the content as easy as possible. I also have a series of scripts that analyze the documentation tree to notify me of broken references, incomplete sections, etc.
I'm adding XLIFF support to allow the documentation to be translated to other languages efficiently. (translators wanted. :-)
-- Michael A. Nachbaur <[EMAIL PROTECTED]> http://nachbaur.com/pgpkey.asc
_______________________________________________ mozilla-documentation mailing list [EMAIL PROTECTED] http://mail.mozilla.org/listinfo/mozilla-documentation
