Mailing-List: contact dev-help@couchdb.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@couchdb.apache.org
Received-SPF: pass (athena.apache.org: domain of zachary.zolton@gmail.com
 designates 209.85.210.52 as permitted sender)
Received-SPF: pass (google.com: domain of zachary.zolton@gmail.com designates
 10.68.73.103 as permitted sender) client-ip=10.68.73.103;
MIME-Version: 1.0
In-Reply-To: <4F427A66.30305@gmail.com>
References: <4F427A66.30305@gmail.com>
From: Zachary Zolton <zachary.zolton@gmail.com>
Date: Tue, 21 Feb 2012 09:28:32 -0600
Message-ID: 
 <CAGnHtbK0X_on14yxzFv82gwvaV4BTtNCCEdZDYwDUnV7CsurzA@mail.gmail.com>
Subject: Re: CouchDB and JavaScript Documentation
To: dev@couchdb.apache.org
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: quoted-printable

Kevin,

I agree that we should at least document the JS libraries distributed
with CouchDB. Of course, whether it should live in the wiki or some
other kind of project documentation has been a perennial discussion on
this list... (^_^

Anyways, if you'd like to add something to the wiki, here are couple
links documentating the jQuery plugin:

http://daleharvey.github.com/jquery.couch.js-docs/symbols/index.html
http://bradley-holt.com/2011/07/couchdb-jquery-plugin-reference/

Futon uses couch.js, and it can serve as a good API reference, but you
generally don't need it to build browser-based apps.


Cheers,

Zach

On Mon, Feb 20, 2012 at 10:52 AM, Kevin R. Coombes
<kevin.r.coombes@gmail.com> wrote:
> Hi,
>
> CouchDB typically ships with a collection of JavaScript files, partly
> because they are used in the implementation of Futon. =A0Many of these sc=
ripts
> provide tools that are (or should be) useful to developers of application=
s
> that use CouchDB. As far as I can tell from poking about on the web site =
and
> wiki, these scripts are essentially undocumented. Providing documentation
> would make them more useful and would make it easier for people to develo=
p
> better applications faster.
>
> I'd like to propose that the Wiki should add a section on "Interfacing
> CouchDB with JavaScript" as a point to start writing and storing this
> documentation. Main subtopics would be
> =A0 =A0jQuery =A0 =A0(mostly pointers to the online jQuery documentation.=
 Add some
> comments or examples about specific use with CouchDB)
> =A0 =A0 =A0 =A0jQuery Plugins =A0 =A0(similar. =A0Point out "suggest", "r=
esizer", etc.)
> =A0 =A0Couch Extensions to jQuery =A0 =A0(full documentation of the
> "jquery.couch.js" script)
> =A0 =A0The CouchDB JavaScript Object/Class (full documentation of the "co=
uch.js"
> script)
> It would be nice to include both "reference manual pages" kinds of
> documentation along with practical examples of usage. =A0And maybe some a=
dvice
> about when you'd want to ise the "couch.js" script and when you'd want to
> use the "jquery.couch.js" script.
>
> We might include a separate section on using JavaScript for map/reduce, t=
hat
> mostly points back to the existing view/show/list documentation.
>
> I'm willing to contribute to producing the wiki pages. =A0The warning tha=
t
> goes with that offer is that JavaScript is not my "native language" (whic=
h
> actually skews more to things like R and perl) and everything I know at
> present comes from fighting with the code to figure out what pieces exist
> and how to invoke them successfully. =A0All while learning more about fir=
ebug
> than I ever wanted to know....
>
> =A0 =A0Kevin