[OpenAjaxIDE] Visual jQuery and its XML grammar

Jon Ferraiolo jferrai at us.ibm.com
Wed Oct 31 11:06:23 PDT 2007



I met one of the principal jQuery engineers, Yehuda Katz, at Ajax
Experience last week. He is applying for membership as an individual.
Yehuda has developed a system called Visual jQuery. I added an entry to our
IDE Survey page for it as follows you can see below.

Yehuda says that if our metadata format is sufficiently close to his
metadata format, he might be able to modify his code (which he says hasn't
been posted yet as open source, but he would be willing to do so) to
support our format. Whether or not this works out, he does show that if the
metadata format has the right characteristics, it can be used with an XSLT
style sheet to achieve online documentation.

Jon



Visual jQuery


The jQuery team has an online and print documentation system called Visual
jQuery that (apparently) transforms JSDoc annotations into an XML file,
which then goes through XSLT transformations to produce online
documentation for jQuery and print documentation for jQuery. The link to
Visual jQuery is http://visualjquery.com/index.xml. To see the XML markup
language, just do a view source.


Here is a snippet:


<?xml version='1.0' encoding='ISO-8859-1'?>
<?xml-stylesheet type='text/xsl' href='style/cat.xsl'?>
<docs version='1.1'>
<cat value='Core'>
<method cat='Core' type='jQuery' short='This function accepts a string
containing a CSS or
basic XPath selector which is then used to match a set of elements.'
name='$'>
<desc>This function accepts a string containing a CSS or
basic XPath selector which is then used to match a set of elements.

The core functionality of jQuery centers around this function.
Everything in jQuery is based upon this, or uses this in some way.
The most basic use of this function is to pass in an expression
(usually consisting of CSS or XPath), which then finds all matching
elements.

By default, $() looks for DOM elements within the context of the
current HTML document.</desc>
<see>$(Element)</see>
<see>$(Element<Array>)</see>
<params type='String' name='expr'>
<desc>An expression to search with</desc>
</params>

<params type='Element|jQuery' name='context'>
<desc>(optional) A DOM Element, Document or jQuery to use as context</desc>
</params>
<examples>
<desc>Finds all p elements that are children of a div element.</desc>
<before><p>one</p> <div><p>two</p></div> <p>three</p></before>

<code>$("div > p")</code>
<result>[ <p>two</p> ]</result>
</examples>
<examples>
<desc>Searches for all inputs of type radio within the first form in the
document</desc>
<code>$("input:radio", document.forms[0])</code>

</examples>
<examples>
<desc>This finds all div elements within the specified XML document.</desc>
<code>$("div", xml.responseXML)</code>
</examples>
</method>
<method cat='Core' type='jQuery' see='appendTo(String)' short='Create DOM
elements on-the-fly from the provided String of raw HTML.' name='$'>
<desc>Create DOM elements on-the-fly from the provided String of raw
HTML.</desc>
<params type='String' name='html'>
<desc>A string of HTML to create on the fly.</desc>
</params>
<examples>
<desc>Creates a div element (and all of its contents) dynamically,
and appends it to the element with the ID of body. Internally, an
element is created and it's innerHTML property set to the given markup.
It is therefore both quite flexible and limited.</desc>

<code>$("<div><p>Hello</p></div>").appendTo("#body")</code>
</examples>
</method>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://openajax.org/pipermail/ide/attachments/20071031/7a0b9ac1/attachment.html 


More information about the IDE mailing list