[interchange-docs] xmldocs - racke modified refs/captcha.tag
docs at icdevgroup.org
docs at icdevgroup.org
Fri Aug 11 10:24:04 EDT 2006
User: racke
Date: 2006-08-11 14:24:04 GMT
Added: refs captcha.tag
Log:
initial documentation of new captcha tag (work in progress)
Revision Changes Path
1.1 xmldocs/refs/captcha.tag
rev 1.1, prev_rev 1.0
Index: captcha.tag
===================================================================
__NAME__ purpose
Handles captcha images used for authentication
__END__
__NAME__ synopsis
<row>
<entry>
length
</entry>
<entry>
</entry>
<entry>
<!-- REQ -->
</entry>
<entry>
4
</entry>
<entry>
length of the captcha code
</entry>
</row>
__END__
__NAME__ description
This tag generates and/or checks "captcha" images to authenticate user input.
If called for the first time in a page, it generates a code/image pair and
sets the code in the session (at $Vend::Session->{captcha}).
</para>
<para>
The captcha tag provides the following functions:
</para>
<refsect2>
<title>check</title>
<para>
Checks the captcha source code (presumably from the previous page) against
the guess. If it matches, returns 1. If not, returns 0 and puts error
in $Tag->error.
</para>
</refsect2>
<refsect2>
<title>code</title>
Returns the generated code. Generates one if not done previously in session.
</refsect2>
<para>
The image, relative_image and image_tag functions are undocumented.
__END__
More information about the docs
mailing list