You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by ha...@apache.org on 2008/06/09 02:24:31 UTC
svn commit: r664582 - /myfaces/tomahawk/trunk/core/src/site/xdoc/captcha.xml
Author: hazems
Date: Sun Jun 8 17:24:31 2008
New Revision: 664582
URL: http://svn.apache.org/viewvc?rev=664582&view=rev
Log:
Adding CAPTCHA site documentation.
Added:
myfaces/tomahawk/trunk/core/src/site/xdoc/captcha.xml
Added: myfaces/tomahawk/trunk/core/src/site/xdoc/captcha.xml
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/core/src/site/xdoc/captcha.xml?rev=664582&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/core/src/site/xdoc/captcha.xml (added)
+++ myfaces/tomahawk/trunk/core/src/site/xdoc/captcha.xml Sun Jun 8 17:24:31 2008
@@ -0,0 +1,81 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+ <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
+
+ <!--
+This is a standard template meant to be used for the documentation of all custom
+components.
+--><document>
+
+ <body>
+ <!-- Description -->
+ <section name="Description">
+ <p>
+ The captcha component allows generating random images that can be placed with
+ webforms to determine whether the user is human.
+ </p>
+ </section>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+ <div><img src="images/captcha1.jpg" alt="captcha"/></div>
+ <div><img src="images/captcha2.jpg" alt="captcha"/></div>
+ </section>
+
+ <!-- API -->
+ <section name="API">
+ <table>
+ <tr>
+ <td>author</td>
+ <td>Hazem Saleh</td>
+ </tr>
+ <tr>
+ <td>component-family</td>
+ <td>org.apache.myfaces.CAPTCHA</td>
+ </tr>
+ <tr>
+ <td>renderer-type</td>
+ <td>org.apache.myfaces.CAPTCHA</td>
+ </tr>
+ <tr>
+ <td>component-class</td>
+ <td>org.apache.myfaces.custom.captcha.CAPTCHAComponent</td>
+ </tr>
+ <tr>
+ <td>renderer-class</td>
+ <td>org.apache.myfaces.custom.captcha.CAPTCHARenderer</td>
+ </tr>
+ <tr>
+ <td>tag-class</td>
+ <td>org.apache.myfaces.custom.captcha.CAPTCHATag</td>
+ </tr>
+ </table>
+ </section>
+
+ <!-- Usage -->
+ <section name="Usage">
+
+ <source xml:space="preserve">
+ <t:captcha captchaSessionKeyName="#{captchaBean.sessionKeyName}" />
+ </source>
+
+ </section>
+
+ <!-- Syntax -->
+ <section name="Syntax">
+
+ <blockquote><h3><s:captcha></h3>
+ <code>captchaSessionKeyName="It determines the CAPTCHA session key name."</code><br/>
+ <code>imageWidth="An integer to indicate the CAPTCHA width. default is 290."</code><br/>
+ <code>imageHeight="An integer to indicate the CAPTCHA height. default is 81."</code><br/>
+ </blockquote>
+ </section>
+
+ <!-- Additional Information -->
+ <section name="Additional Information">
+ <p>see captcha.jsp in the Tomahawk examples.</p>
+ </section>
+
+ </body>
+
+
+</document>