Wow. I just created an account and started looking at existing pages to
get a feel for how they are put together. I think I'll need a course in
the syntax before I want to attempt much. :) Here I thought I'd be
able to just start typing... (off to find those links mentioned earlier
in this thread...)
Shawn
Shawn wrote:
> I don't have a problem with the current documentation style. But then
> again, I'm using it as a reference not an instruction guide.
>
> Perhaps the various pages can/should be expanded with "how to" type
> instructions for the more common tasks (mabye another tab?). For instance:
>
> AJAX:
>
> How to replace page content from a remote page:
> $("#pagecontent").load("remote.php");
>
> How to retrieve JSON script and do further processing on it:
> $.ajax({
> url : "remote.php",
> type : "POST",
> data : "param1=" + somevalue + "¶m2=" + somevalue,
> dataType : "json",
> error : function (a,b,c) { alert(a.responseText); },
> success : function (json) {
> //assuming json represents a returned array
> var out = "<ul>";
> for (var x=0; x < json.length; x++) {
> out += "<li>" + json[x] + "</li>";
> }
> out += "</ul>";
> $("#targetelement").html(out);
> }
> });
>
> I find that reading about the "success" method, or the "error" method
> only goes so far. It's after seeing a realistic example that it sinks
> in (for me). But I'm also comfortable "just trying" until I figure it
> out. This how-to approach can just as easily be applied to selectors,
> events, effects, maniplating, etc.
>
> I guess care would need to be taken that these mini how-to's stay very
> focused on demoing real world examples of a very specific piece of
> jQuery functionality. I'd hate to see something like "how to build a
> data driven calendar" in a sample on Ajax - that covers way more than
> just Ajax and should be a blog posting somewhere else.
>
> Anyone really hate this idea? I'm willing to take a crack at the first
> couple of mini how-to's to get the ball rolling.... (just finished a
> large project, so I have *some* time to spare.. :)
>
> My thoughts.
>
> Shawn
>
> Andy Matthews wrote:
>> It's all well and good that the jQuery team is coming out with new
>> release, but what about the equally important documentation issue?
>>
>> 1.2.1 has been out since what Aug? Sept? And documentation still isn't
>> much help?
>>
>> The API browser (http://jquery.com/api/) still references version 1.1.2.
>>
>> Documentation in the wiki is also not that great:
>> http://docs.jquery.com/Main_Page
>>
>> It's very difficult to use, the search isn't very user friendly, there's
>> no alphabetical listing of method names, and for some reason you guys
>> chose to use the tabs plugin to display content in the wiki. >From a
>> usability standpoint, that's horrible. People using the docs are most
>> likely looking for an answer to something that they're working on.
>> Forcing them to jump through extra hoops just to get the info they need.
>>
>> *
>> ____________________________________
>>
>> Andy Matthews
>> *Senior ColdFusion Developer
>>
>> Office: 877.707.5467 x747
>> Direct: 615.627.9747
>> Fax: 615.467.6249
>> [EMAIL PROTECTED]
>> www.dealerskins.com <http://www.dealerskins.com/>
>>
