summaryrefslogtreecommitdiffstats
path: root/user_guide_src/source
diff options
context:
space:
mode:
authorPreetham <me@preetham.in>2014-12-05 03:01:52 +0100
committerPreetham <me@preetham.in>2014-12-05 03:01:52 +0100
commite29136567e2a12726f9ab40762bcb47a7cde759c (patch)
tree71c7282f416a9ca940fc086fca62f4cdcb062a48 /user_guide_src/source
parent0972c2194e1bd66e6a399c61c31da68333db426e (diff)
closing #51. Added img_id and img_name in capcha helper
Signed-off-by: Preetham <me@preetham.in>
Diffstat (limited to 'user_guide_src/source')
-rw-r--r--user_guide_src/source/changelog.rst3
-rw-r--r--user_guide_src/source/helpers/captcha_helper.rst6
2 files changed, 7 insertions, 2 deletions
diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 38fd75971..3dc87b555 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -135,7 +135,8 @@ Release Date: Not Released
- Added *filename* to the returned array elements.
- Updated to use `imagepng()` in case that `imagejpeg()` isn't available.
- Added **font_size** option to allow customization of font size.
-
+ - Added **img_id** and **img_name** options to set id and name attributes of captcha image.
+
- :doc:`Text Helper <helpers/text_helper>` changes include:
- Changed the default tag for use in :func:`highlight_phrase()` to ``<mark>`` (formerly ``<strong>``).
diff --git a/user_guide_src/source/helpers/captcha_helper.rst b/user_guide_src/source/helpers/captcha_helper.rst
index 3cf51330b..7d7f30de8 100644
--- a/user_guide_src/source/helpers/captcha_helper.rst
+++ b/user_guide_src/source/helpers/captcha_helper.rst
@@ -34,6 +34,8 @@ Once loaded you can generate a CAPTCHA like this::
'expiration' => 7200,
'word_length' => 8,
'font_size' => 16,
+ 'img_id' => 'Image id',
+ 'img_name' => 'Image name',
'pool' => '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ',
// White background and border, black text and red grid
@@ -60,7 +62,9 @@ Once loaded you can generate a CAPTCHA like this::
in the captcha folder before it will be deleted. The default is two
hours.
- **word_length** defaults to 8, **pool** defaults to '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
-- **font_size** defaults to 16, the native GD font has a size limit. Specify a "true type" font for bigger sizes.
+- **font_size** defaults to 16, the native GD font has a size limit. Specify a "true type" font for bigger sizes.
+- The **img_id** will be set as the "id" of the captcha image.
+- The **img_name** will be set as the "name" of the captcha image.
- If any of the **colors** values is missing, it will be replaced by the default.
Adding a Database