Oct 162008
 

Today I finally got around to rewriting the XMLHttpRequest documentation on MDC.  The documentation has been a mess for a long time, and I’ve been meaning to redo it for a couple of years now.

With the large number of XHR changes in Firefox 3.1, it seemed like a good time to break down and take care of it.

There’s work to be done yet (some of the stuff that’s new in Gecko 1.9.1 is not labeled as such yet, for example, and there are no examples for the new capabilities yet either), but it’s a definite improvement, I think.

Instead of one article providing documentation-by-example, there’s now a reference for XMLHttpRequest as well as an article on how to use XMLHttpRequest, which includes the examples.

I’m glad to finally have this done, and look forward to getting the cool new capabilities we’ve added in Firefox 3.1 properly documented over the next day or so.

 Posted by at 6:07 PM
Oct 132008
 

OK, @font-face was pretty easy to write up — someone wrote it up all the way back in February.  I just had to remove the notes about it not being implemented yet, add a live example, and tie it into the Firefox 3.1 for developers page.  I love it when things go nice and easy like that.

 Posted by at 4:52 PM
Oct 132008
 

With the exception of a couple of questions about the non-standard referenceNode and pointerBeforeReferenceNode properties, I’ve completed the documentation for NodeIterator.

My questions revolve around not actually knowing what those two properties do, for certain, although I presume that referenceNode lets you peek at the node currently referenced without moving the iterator.

Next up, I plan to start working on the documentation for @font-face.

 Posted by at 4:26 PM
Oct 132008
 

Over the weekend, I did some cleanup work on the documentation for media queries and various other topics; these should all be in pretty good shape now.

This morning, I wrote up the documentation for the MozAfterPaint event (courtesy of the blog post by roc that went up while I was asleep, which made the work much, much easier).

Remember: in open source, there’s no such thing as plagiarism. :)

Lots to do but the progress is great.

 Posted by at 1:02 PM
Oct 112008
 

I mostly spent today twiddling documentation I wrote over the course of the week.  Little fixes as suggestions come in, a few organizational corrections, that kind of thing.  It was a great week of work, and I’m really pleased.

There are some moderately significant corrections remaining to be made in the media queries documentation; I plan to work on that tomorrow.

I’ve been getting fantastic feedback, which I really appreciate.  I’m sure there’ll be plenty more!

 Posted by at 12:04 AM
Oct 102008
 

I’ve posted the article “Using geolocation“, which provides introductory information on using the new geolocation API being introduced in Firefox 3.1.  I’ll be adding a working example tomorrow (later today, actually, now that I look at my clock and see it’s already Friday).  I’ve also not yet documented the interfaces behind geolocation, but I’ll be doing those tomorrow.

As always, if you happen to notice any errors, please feel free to correct them or let me know what needs fixing so I can do it.

Enjoy!

 Posted by at 12:45 AM
Oct 092008
 

Since video and audio have such similar syntax, once I got audio documented, the documentation for video came together really fast.  Enjoy!

 Posted by at 7:19 PM
Oct 092008
 

I’ve just completed documentation for the HTML 5 audio element.  This is pretty nifty stuff; I’ll be working on the video element tonight and tomorrow morning.  I’m waiting for email back in response to a couple of questions (it’s possible I may have documented some attributes we don’t yet support), and I’m sure I’ll be updating the content in the next day or two.

Also, I wrote an example which doesn’t work yet — I think because the MDC server doesn’t currently serve up .ogg files with the correct MIME type; I’ve filed a ticket to address that.

One great thing that sometimes happens while writing documentation is that your simple samples you throw together uncover bugs that you get to report.  That’s sort of “bonus, value-added work” as far as I’m concerned.  In this case, I discovered that the fallback text always appears, even if the audio plays.

Anyway, if you happen to notice any problems with this documentation, feel free — as always — to correct it, or drop me a note if you’d rather I handle the correction.

 Posted by at 6:56 PM
Oct 092008
 

I’ve just completed the documentation for CSS media queries.  This is a very, very nifty capability that lets you select different style sheets based on very precise criteria.  For example, you can use different style sheets on standard versus widescreen displays, or based on the dimensions of the browser window, or whether the screen is 24-bit color or monochrome.

This is very exciting stuff, and hopefully the documentation will be helpful!

 Posted by at 12:06 PM
Oct 072008
 

The documentation for CSS transforms in Firefox 3.1 is now more or less complete.  Both the -moz-transform and -moz-transform-origin properties have been documented, and there’s also documentation for the CSS transform functions.

Let me know what you think, and feel free to edit and add more examples!

 Posted by at 6:02 PM