fantasai wrote:

Michael A Nachbaur wrote:

...
So, I decided to document all the objects available to a JavaScript developer in one central place.
...
So, essentially, my plan is that my reference could replace the domref on mozilla.org.


Ok. You might want to contact the domref authors to see if you can just
lift off content from those pages. And talk to Doron, he has some DOM
reference documentation in the works.

Okay, I'll do that. It would definitely save me a lot of time, but I was looking to avoid muddying up the copyright licensing. You wouldn't happen to know what the license is on the DOM reference documentation on mozilla.org, would you? The reason I ask is there's a possibility I might be writing a book on Mozilla at some point, and I'd like to include the object reference with that.


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 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.


Would you be interested in syncing formats with developer.mozilla.org?

Of course, that would be great. I still would like to keep the sidebars, since they provide a great deal of functionality for navigating the site. When all is said and done, there will be quite a number of objects to find your way around in. I don't think this will be a problem however, since the mozilla.org website already has such interface elements.


Additionally, I'm looking to add tutorials, howtos, etc. By putting that content in the site, any tutorial that mentions an object will automatically have cross-reference links inserted to the relevant section of the object reference.

I can help you bring your HTML in line with the mozilla.org style guide

Great, if you can point me at / send me the styleguide and stylesheets, I can convert mozref.com over.


and you can help us set up a compatible back end for similar references
outside the AOM's scope.

Well, if I can get the sources for the Mozilla website as a whole, I'm fairly certain a set of stylesheets can be made to render it dynamically, with XSL, and still be fast. AxKit is extremely quick at rendering pages, and with caching enabled it runs at just slightly under the speed of static Apache requests. And if not, AxKit could still be used to generate static pages to upload to the mozilla.org website. The nice thing about going with a dynamic XSL website is accessibility and i18n.


There's already a lot of high-load websites out there running under AxKit, gentoo.org and opera.com being two of the most notable ones.

So far we've only got Darin's XPCOM reference,
which is also written in XML. We're using a static build system, where
the XSLT transformation is performed once to convert pages from XML in
the source directory to wrapped HTML in the destination directory.

Okay. If I can get access to those stylesheets, then that could save me some effort.


I think we'll probably want to stay static, but having the XML storage
format and the XSLT match seems like a good idea.

Is there any particular reason why you'd like to have the site remain static? Is it for performance reasons?


--
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