Index: README.txt =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/captcha/README.txt,v retrieving revision 1.13.2.1.2.7 diff -u -u -p -r1.13.2.1.2.7 README.txt --- README.txt 2 Oct 2007 19:21:20 -0000 1.13.2.1.2.7 +++ README.txt 5 Oct 2007 09:26:57 -0000 @@ -3,21 +3,21 @@ $Id: README.txt,v 1.13.2.1.2.7 2007/10/0 ### CAPTCHA Readme captcha.module is the basic CAPTCHA module that offers general CAPTCHA -adminstration and a simple math captcha challenge. +adminstration and a simple math challenge. -text_captcha offers another simple text based CAPTCHA challenge. +text_captcha offers another simple text based challenge. -image_captcha offers an image based CAPTCHA challenge. +image_captcha offers an image based challenge. Installation: Installation is like all normal modules (e.g. extract in the directory sites/all/modules) The basic CAPTCHA module has no dependencies, so nothing special is required. - + Configuration: The configuration page is at admin/user/captcha, here you can configure - the CAPTCHA module and enable captchas for the desired forms. - -Using Image Captcha + the CAPTCHA module and enable challenges for the desired forms. + +Using the Image CAPTCHA: If you plan on using image_captcha, you will have to install TTF fonts into the image_captcha/fonts or files directory. You can find free fonts available at a number of different locations: Index: captcha_api.txt =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/captcha/Attic/captcha_api.txt,v retrieving revision 1.1.4.7 diff -u -u -p -r1.1.4.7 captcha_api.txt --- captcha_api.txt 2 Oct 2007 19:21:20 -0000 1.1.4.7 +++ captcha_api.txt 5 Oct 2007 09:26:57 -0000 @@ -1,6 +1,6 @@ -This documentation is for developers that want to implement their own CAPTCHA -and integrate it with the base CAPTCHA module. +This documentation is for developers that want to implement their own +challenge type and integrate it with the base CAPTCHA module. === Required: hook_captcha($op, $captcha_type='') === @@ -8,19 +8,19 @@ and integrate it with the base CAPTCHA m The hook_captcha() hook is the only required function if you want to integrate with the base CAPTCHA module. Functionality depends on the first argument $op: - * 'list': you should return an array of possible CAPTCHA type names that your - module implements. - * 'generate': generate a CAPTCHA. + * 'list': you should return an array of possible challenge types + that your module implements. + * 'generate': generate a challenge. You should return an array that offers form elements and the solution - of your CAPTCHA, defined by the second argument $captcha_type. + of your challenge, defined by the second argument $captcha_type. The returned array $captcha should have the following items: - $captcha['solution']: this is the solution of your CAPTCHA + $captcha['solution']: this is the solution of your challenge $captcha['form']: an array of the form elements you want to add to the form. There should be a key 'captcha_response' in this array, which points to the form element where the user enters his answer. Let's give a simple example to make this more clear. -We create the CAPTCHA type 'Foo CAPTCHA', which requires the user to +We create the challenge 'Foo CAPTCHA', which requires the user to enter "foo" in a textfield. """ @@ -72,9 +72,9 @@ dependencies = captcha === Recommended: hook_menu($may_cache) === -More advanced CAPTCHA modules probably want some configuration page. To integrate -nicely with the CAPTCHA module you should offer your configuration page as a -MENU_LOCAL_TASK menu entry under 'admin/user/captcha/'. +More advanced CAPTCHA modules probably want some configuration page. +To integrate nicely with the base CAPTCHA module you should offer your +configuration page as a MENU_LOCAL_TASK menu entry under 'admin/user/captcha/'. For our simple foo CAPTCHA module this would mean: @@ -104,7 +104,7 @@ returns the form of your configuration p === Optional: hook_help($section) === -To offer a description/explanation of your CAPTCHA, you can use the +To offer a description/explanation of your challenge, you can use the normal hook_help() system. For our simple foo CAPTCHA module this would mean: @@ -116,7 +116,7 @@ For our simple foo CAPTCHA module this w function foo_captcha_help($section) { switch ($section) { case 'admin/user/captcha/foo_captcha': - return '

'. t('This is a very simple CAPTCHA, which requires users to enter "foo" in a textfield.') .'

'; + return '

'. t('This is a very simple challenge, which requires users to enter "foo" in a textfield.') .'

'; } } """