Speaker: Michelle Petersen
Watch this screencast to see how easily you can access the MochiKit docs from your code.


View video

Hi. My name is Michelle, and I'm going to be demonstrating how we've integrated MochiKit's documentation into the Aptana IDE.

The first thing that I'm going to show you is how you can generate an online tooltip that tells you a little bit about a function that you want to know more about. I'm going to hover over this SwapDOM function, and it tells me the parameters that SwapDOM takes and that it replaces one element in a DOM tree with another element and returns the replacement element.

I can also access online help by starting to type a function. Once I start typing, Code Assist pops up with a list of functions that are available to this JS file, sow hat you can see on this list is I can access a number of MochiKit JS files, and, of course, functions that are available through DOM 0 or DOM 1 and 2 or JavaScript Core. I'm going to select getElementsByTagAndClassName and when I hit the parenthesis, I get Argument Assist, and this tells me that the getElementsByTagAndClassName function takes a tagName parameter, a className parameter and an optional parent parameter.

Going to pretend that I'm going to be passing in a paragraph tag and a class called Rounded. Now, these online tool tips are just concise little summaries for functions, and if I want more in-depth information about a function, I can go to the actual MochiKit Online Help. The way I can do that is by clicking on a function, and if I press the F1 key, I pull up a Dynamic Help search.

And here's the summary that we saw in the Tool Tip, but it also pulls up a link to the MochiKit DOM documentation, which is the MochiKit file that the getElementsByTagAndClassName function is taken from, so if I click that, it actually opens up the MochiKit Online Help that we have integrated into the Aptana product. If I click this link, it takes me right to the function summary.

So, hopefully, this feature will help make your coding with MochiKit go a lot more smoothly. Thank you.

[End of Video]