On July 22, 2004 10:34 pm, Heikki Toivonen wrote:
> Michael A Nachbaur wrote:
> > Further to a message I sent a few months back, I'd like to now officially
> > announce http://aom.nachbaur.com and the eminent completion of the
> > ECMA-262 specification's documentation on that site.
>
> It looked pretty nice. I imagine this would be useful to many people.
>
> Where do you get the data from, and how do you process it? How automated
> is it, and how up to date can you keep it?

This documentation is 100% written by me.  I got the information about these 
objects from the original specifications themselves.  I had considered the 
idea of extracting the documentation from within IDL and C++ files, but since 
that documentation is targeted to a different audience, I felt it best if the 
documentation was written by hand, specifically to address JavaScript 
developers.

Regarding specifically where I've gotten my information, since I've only 
created object documentation for ECMAScript so far, I've been using the 
ECMA-262 specification itself.

Presumably, since Mozilla is based on public standards, if it deviates from 
the standards (from which I'm writing my documentation) then its a bug in 
Mozilla. :-)  Seriously though, I plan to accomodate any extras that Mozilla 
introduces into the documentation.

As far as how its constructed, its developed on AxKit (http://www.axkit.org).  
This is an XSL publishing application server; so, all my documentation is in 
XML files tuned to the structure of documenting objects, and I have a number 
of XSL stylesheets that produces the interface.  This makes it extremely easy 
to document and keep up to date, without dealing with the tedium of producing 
HTML.  (This is also how I can produce the multiple output styles, PDF, etc).

> I was wondering about there not being any mention of the xmlextras
> objects, for example (XMLHttpRequest etc.), which leads me to the
> question: how complete is this/can it get?

This is mainly due to the fact that I haven't finished yet.  I don't doubt 
that I have a long road ahead of me before this is 100% complete, but I do 
believe I'll get there.  My plan is that all the DOM objects, XMLHttpRequest 
and its friends, and in fact all objects that are accessible to a 
XUL/JavaScript developer will be documented here.

-- 
Michael A. Nachbaur <[EMAIL PROTECTED]>
http://nachbaur.com/pgpkey.asc
_______________________________________________
mozilla-documentation mailing list
[EMAIL PROTECTED]
http://mail.mozilla.org/listinfo/mozilla-documentation

Reply via email to