couchdb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Randall Leeds <randall.le...@gmail.com>
Subject Re: CouchDB and JavaScript Documentation
Date Tue, 28 Feb 2012 03:09:00 GMT
On Tue, Feb 21, 2012 at 07:28, Zachary Zolton <zachary.zolton@gmail.com> wrote:
> 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... (^_^

If you'd like to edit the wiki and haven't been made a contributor
yet, please just post your user name here and I, or someone else, will
add you as soon as we can.

> 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.  Many of these scripts
>> provide tools that are (or should be) useful to developers of applications
>> 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 develop
>> 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
>>    jQuery    (mostly pointers to the online jQuery documentation. Add some
>> comments or examples about specific use with CouchDB)
>>        jQuery Plugins    (similar.  Point out "suggest", "resizer", etc.)
>>    Couch Extensions to jQuery    (full documentation of the
>> "jquery.couch.js" script)
>>    The CouchDB JavaScript Object/Class (full documentation of the "couch.js"
>> script)
>> It would be nice to include both "reference manual pages" kinds of
>> documentation along with practical examples of usage.  And maybe some advice
>> 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, that
>> mostly points back to the existing view/show/list documentation.
>>
>> I'm willing to contribute to producing the wiki pages.  The warning that
>> goes with that offer is that JavaScript is not my "native language" (which
>> 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.  All while learning more about firebug
>> than I ever wanted to know....
>>
>>    Kevin

Mime
View raw message