On 9/28/07, Juha Suni SC <[EMAIL PROTECTED]> wrote: > > In the meanwhile it would help tremendously if the documentation and API > links were consistent in where they point to, and the 1.2 api in the wiki > was easy to find. > > FYI: The 1.2 API in the wiki is at: http://docs.jquery.com/Core (or by > clicking "jQuery Core" in the wiki main page at http://docs.jquery.com) > > Problems: > > Most documentation main page links point to the 1.1.2 -version API. For > example clicking "Attributes" on the main page (http://docs.jquery.com) > under the DOM in the right, takes you to 1.1.2 API. As do all the other > under the DOM-title. "Traversing" for example takes you to > http://docs.jquery.com/DOM/Traversing which is 1.1.2, but to get to the > 1.2 traversing-section you need to click "jQuery Core" first, then choose > traversing from the left to get to http://docs.jquery.com/Traversing which > is 1.2. >
Fixed. This is made even more difficult by the fact that all the API-links you find > in Google and in jQuery-related discussions point to different places, none > of them being 1.2 or even having a link to 1.2 or even mentioning they > might be out of date. http://docs.jquery.com/Api again has links pointing > both to 1.2 and 1.1.2 docs nicely mixed together. The "official" (it is, > right?) API on the other hand is only 1.1.2 with no mention of it being > outdated. Same goes with the visualjquery.com -site which is certainly > very popular and many links point to it. > Fixed the jQuery site - Visual jQuery is still a work in progress, we've gotta figure some other things out before we can get it up to date. This is extremely confusing for new users, and even for us regulars. I > spent 10 minutes trying to find the 1.2 API that I remembered stumbling > upon before. Many new users might have no idea they are browsing an old > version of the API (its easy to confuse 1.2 with 1.1.2). This is made even > more important by the fact that 1.2 and 1.1.2 actually do have major > differences and some 1.1.2 stuff just won't work under 1.2. > I've added a notice to all 1.1.2 pages pointing people to the current version. One of jQuery's key strengths is the low learning curve and good > documentation. With outdated documentation (especially when up-to-date > documentation _is_ available) making things harder for new users these > benefits disappear. > > I'm certainly not trying to bash anyone and I do understand the possible > difficulties in getting things to work smoothly and in keeping docs up to > date. I'm just suggesting that since we do have a decent up-to-date API at > http://docs.jquery.com/Core, shouldn't most links point to that instead of > the outdated 1.1.2? And even though the 1.1.2 API would still be > available, I'd strongly suggest placing a visible text informing the user > that the information might be outdated with a link to the latest API. > See above. We're starting to do some more work on the jQuery documentation over in the jQuery Docs list: http://groups.google.com/group/jquery-docs --John ----- Original Message ----- > *From:* Brandon Aaron <[EMAIL PROTECTED]> > *To:* jquery-en@googlegroups.com > *Sent:* Thursday, September 27, 2007 6:24 PM > *Subject:* [jQuery] Re: When will the API be updated for 1.2.1? > > The documentation is going through some growing pains. Currently the only > source of documentation for 1.2.x is on the wiki. I've been thinking about > how we can take those docs and create an XML file like we had before ... > currently the only idea I have is to screen scrape which if you look at the > actual markup of the Wiki is a pain and doesn't scale well for inclusion of > plugins, etc. I've made a little progress (still have a long way to go) with > using Hpricot to at least get the core docs into XML. > > -- > Brandon Aaron > > On 9/27/07, Andy Matthews <[EMAIL PROTECTED]> wrote: > > > > I use this: > > http://jquery.com/api/ > > > > all the time because it's the simplest, easiest, reference for jQuery > > methods and behaviours. But it still lists it's version as 1.1.2. Are > > there plans to update this reference? > > > > Alternately, I'd argue that there needs to be ONE single point of entry > > (on the jQuery site at least) for a straight up reference. I'm not talking > > about the fluffy examples found in the wiki area, but just a terse > > explanation of the method, it's parameters, and how to use it. > > > > * ____________________________________ > > > > Andy Matthews > > *Senior ColdFusion Developer > > > > Office: 877.707.5467 x747 > > Direct: 615.627.9747 > > Fax: 615.467.6249 > > [EMAIL PROTECTED] > > www.dealerskins.com > > > > > >
<<dealerskinslogo.bmp>>
