<?xml version="1.0" encoding="UTF-8" ?>
<rdf:RDF xmlns="http://usefulinc.com/ns/doap#" xmlns:foaf="http://xmlns.com/foaf/0.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"><Project><name>jquery</name>
<shortdesc>Jquery javascript library for TurboGears</shortdesc>
<description>Feature
===============

jquery is a jquery javascript library wrapper and ajax helper for happy
TurboGears web designers.

Available widgets
====================

  * Jquery (basic jquery libray wrapper for Turbogears)

It also contains 3 extra ajax widgets based on jquery.

  * addCallback / link_to_remote(target ,update, href, callback)
        
  * addPeriodBack / periodically_call_remote(update, href, interval)

  * addFormback / form_remote_tag(target, update, href)

Which are inspired from Ruby on Rails/pquery and give them the twisted syntax.
    

Install
==============
Use setuptools to install::
    
    $easy_install jquery


Usage
==============

jquery
~~~~~~~~~

include in config/app.cfg::

    tg.include_widgets = ['jquery.jquery']

jquery ajax usage:
~~~~~~~~~~~~~~~~~~~~~

import in controllers.py::

    from jquery import addCallback
    from jquery import addPeriodback
    from jquery import addFormback
    ....
    return dict(addCallback = addCallback, 
            addPeriodback = addPeriodback,
            addFormback = addFormback)

.. note:: 
    Update notice form 1.1.2 jquery widget: you need return dict(link = addPeriodback) instead of 
    return dict(link = addPeriodback()) in the following versions

in template::
    
    [div id="timelink"][a href = "#"]get time[/a][/div]
    [div id="timediv"][/div]
    ${addCallback(target="timelink" ,update="timediv", href="/time")}

.. note::
    With genshi template, you should add 'ET' prefix before the callback, such as::
    
        ${ET(addCallback(target="timelink" ,update="timediv", href="/time"))}
    
or::

    [div id="timediv"][/div]
    ${addPeriodback(update="timediv", href="/time", interval="3000")}

or:: 

    [form class="timelink" action="ajax"  method="get" ]
       Field : [input type="text" name="field" /][br /]
       [input type="submit" /] 
    [/form]
    [div id="timediv"][/div]
    ${addFormback(target="timelink", update="timediv", href="ajax")}

.. note:: 
    The addCallback/addPeriodback/addFormback call could be placed anywhere in your template.
    Check http://docs.turbogears.org/1.0/RemoteLink for detail.

Reference
============

    - jquery http://jquery.com
    - pquery http://www.ngcoders.com/pquery/

Source
============

Source is available in 

http://svn.turbogears.org/projects/tgJquery/trunk


History
=============

1.2.3:

  * update to jquery 1.2.3
  * host in TurboGears svn

1.2.2:

  * update to jquery 1.2.2
  
1.1.2w2: 

  * new twisted style ajax call
  * new addFormback/form_remote_tag call
  * passing ajax function no need extra '()' at all.</description>
<maintainer><foaf:Person><foaf:name>Fred Lin</foaf:name>
<foaf:mbox_sha1sum>70fcb8b20c0d91fad2fe08f97e240c7f3998b94d</foaf:mbox_sha1sum></foaf:Person></maintainer>
<release><Version><revision>1.2.3</revision></Version></release>
</Project></rdf:RDF>