[Checkins] SVN: z3c.formjs/trunk/src/z3c/formjs/ Some more
documentation cleanup.
Stephan Richter
srichter at cosmos.phy.tufts.edu
Thu Jul 5 21:14:16 EDT 2007
Log message for revision 77495:
Some more documentation cleanup.
Changed:
U z3c.formjs/trunk/src/z3c/formjs/README.txt
U z3c.formjs/trunk/src/z3c/formjs/jsbutton.txt
U z3c.formjs/trunk/src/z3c/formjs/tests.py
-=-
Modified: z3c.formjs/trunk/src/z3c/formjs/README.txt
===================================================================
--- z3c.formjs/trunk/src/z3c/formjs/README.txt 2007-07-06 00:41:42 UTC (rev 77494)
+++ z3c.formjs/trunk/src/z3c/formjs/README.txt 2007-07-06 01:14:14 UTC (rev 77495)
@@ -1,14 +1,25 @@
-==========
-z3c.formjs
-==========
+===========================
+Form Javascript Integration
+===========================
-The z3c.formjs package provides additional support for javascript and
-ajax for the z3c.form package.
+This package is designed to provide a Python API to common Javascript
+features for forms written with the ``z3c.form*`` packages. While the
+reference backend-implementation is for the JQuery library, any other
+Javascript library can be hooked into the Python API.
-Different functionality is documented/tested in different *.txt
-files. You should look at:
+The documents are ordered in the way they should be read:
-jsevent.txt - for all information regarding JavaScript events
+- ``jsbutton.txt`` [must read]
-jsbutton.txt - for all information regarding JavaScript buttons
+ This document describes how JS scripts can be connected to events on a
+ button.
+- ``jsvalidator.txt`` [must read]
+
+ This document demonstrates how "live" widget value validation can be
+ achieved.
+
+- ``jsevent.txt`` [advanced users]
+
+ This documents describes the generalization that allows hooking up script to
+ events on any field.
Modified: z3c.formjs/trunk/src/z3c/formjs/jsbutton.txt
===================================================================
--- z3c.formjs/trunk/src/z3c/formjs/jsbutton.txt 2007-07-06 00:41:42 UTC (rev 77494)
+++ z3c.formjs/trunk/src/z3c/formjs/jsbutton.txt 2007-07-06 01:14:14 UTC (rev 77495)
@@ -118,5 +118,7 @@
>>> addform.update()
>>> zope.component.provideAdapter(jsevent.JSFormEventsRenderer)
>>> print jsinterfaces.IJSFormEventsRenderer(addform).render()
- $("#form-buttons-apply").bind("click", function(){alert("You Clicked the Apply Button!");});
- $("#form-buttons-cancel").bind("dblclick", function(){alert("You Double Clicked the Cancel Button!");});
+ $("#form-buttons-apply").bind("click",
+ function(){alert("You Clicked the Apply Button!");});
+ $("#form-buttons-cancel").bind("dblclick",
+ function(){alert("You Double Clicked the Cancel Button!");});
Modified: z3c.formjs/trunk/src/z3c/formjs/tests.py
===================================================================
--- z3c.formjs/trunk/src/z3c/formjs/tests.py 2007-07-06 00:41:42 UTC (rev 77494)
+++ z3c.formjs/trunk/src/z3c/formjs/tests.py 2007-07-06 01:14:14 UTC (rev 77495)
@@ -6,11 +6,6 @@
def test_suite():
return unittest.TestSuite((
zope.testing.doctest.DocFileSuite(
- 'README.txt',
- setUp=testing.setUp, tearDown=testing.tearDown,
- optionflags=zope.testing.doctest.NORMALIZE_WHITESPACE |
- zope.testing.doctest.ELLIPSIS),
- zope.testing.doctest.DocFileSuite(
'jsevent.txt',
setUp=testing.setUp, tearDown=testing.tearDown,
optionflags=zope.testing.doctest.NORMALIZE_WHITESPACE |
More information about the Checkins
mailing list