SOS

Shane O'Sullivan's technical blog… really ties the room together

Dojo documentation getting better by the day!

Posted by Shane O'Sullivan on September 22, 2006

One of the primary criticisms of the Dojo Ajax toolkit is that it’s documentation is at best scattered, and at worst non-existant. The Dojo team, and their many partner companies recognise this fact, and are hard at work to fix it. All Dojo documentation is being consolidated into the Dojo Book, which you can find at http://manual.dojotoolkit.org/WikiHome/DojoDotBook/BookIntroduction, and it’s really starting to fill out nicely.

Another welcome addition is the Dojo Api reference, located at http://dojotoolkit.org/api. It’s built on top of JsLinker, a new Javascript parser developed by the Dojo team and AOL, which understands the common Dojo constructs, like how widgets are defined etc. While it’s not perfect yet (some elements don’t seem to be parse correctly), it’s definitely getting there.

One of the best kept secrets of the toolkit’s documentation (I’m not sure why it’s been kept quiet up to now… probably just an oversight) is the work that the guys on IBM’s WebSphere Portal team are doing to come up with an Eclipse help system for Dojo. It’s essentially putting the Dojo Book into the Eclipse help system, and is hosted at http://www.dojotoolkit.org:8080/help/index.jsp. (Update Feb 13th 2007: this address appears to be down now) Check it out, it’s well worth a read. While it’s not a comprehensive guide to all things Dojo, it’s definitely getting there, and is being added to every day.

One slightly (and I mean slightly) funny thing is that the “Where to find Documentation” page is empty… I presume that’ll be filled in any day now🙂

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

 
%d bloggers like this: