Changeset 2223 in products for quintagroup.formlib.captcha/trunk/README.txt

Timestamp:

Apr 29, 2010 7:50:35 AM (14 years ago)

Author:

olha

Message:

README file updated with usage exmaple.

File:

• quintagroup.formlib.captcha/trunk/README.txt (modified) (1 diff)

quintagroup.formlib.captcha/trunk/README.txt

@@ -4 +4 @@
 quintagroup.formlib.captcha is a package that allows to add captcha to zope.formlib.
 As a result such forms are prevented from automatic submit.
+
+Captchas in a formlib form
+--------------------------
+
+Using quintagroup.formlib.captcha in a formlib form is simple. Just add a
+Captcha field to your schema, and away you go:
+
+  >>> from zope.interface import Interface
+  >>> from quintagroup.formlib.captcha.form import Captcha
+  >>> class CaptchaSchema(Interface):
+  ...     captcha = Captcha(
+  ...         title=_(u'Type the code'),
+  ...         description=_(u'Type the code from the picture shown below.'))
+
+and formlib will take care of the rest. The widget associated with this field 
+will render the captcha and verify the use input automatically.
 
 Supported Plone versions