Prechádzať zdrojové kódy

[DOCUMENTATION] English:

-  manual fixes

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@15973 44c647ce-9c0f-0410-b52a-842ac1e357ba
thomas 16 rokov pred
rodič
commit
63ec6875b1

+ 31 - 28
documentation/manual/en/module_specs/Zend_Captcha-Adapters.xml

@@ -12,8 +12,8 @@
 
 
         <para>
         <para>
             <classname>Zend_Captcha_Word</classname> is an abstract adapter that serves as the base
             <classname>Zend_Captcha_Word</classname> is an abstract adapter that serves as the base
-            class for most other CAPTCHA adapters. It provides mutators for
-            specifying word length, session TTL, the session namespace object
+            class for most other <acronym>CAPTCHA</acronym> adapters. It provides mutators for
+            specifying word length, session <acronym>TTL</acronym>, the session namespace object
             to use, and the session namespace class to use for persistence if
             to use, and the session namespace class to use for persistence if
             you do not wish to use <classname>Zend_Session_Namespace</classname>.
             you do not wish to use <classname>Zend_Session_Namespace</classname>.
             <classname>Zend_Captcha_Word</classname> encapsulates validation logic.
             <classname>Zend_Captcha_Word</classname> encapsulates validation logic.
@@ -22,7 +22,7 @@
         <para>
         <para>
             By default, the word length is 8 characters, the session timeout is
             By default, the word length is 8 characters, the session timeout is
             5 minutes, and <classname>Zend_Session_Namespace</classname> is used for persistence
             5 minutes, and <classname>Zend_Session_Namespace</classname> is used for persistence
-            (using the namespace "Zend_Form_Captcha_&lt;captcha ID&gt;").
+            (using the namespace "<classname>Zend_Form_Captcha_&lt;captcha ID&gt;</classname>").
         </para>
         </para>
 
 
         <para>
         <para>
@@ -49,7 +49,7 @@
                 <methodname>setSessionClass($class)</methodname> and
                 <methodname>setSessionClass($class)</methodname> and
                 <methodname>getSessionClass()</methodname> allow you to specify an
                 <methodname>getSessionClass()</methodname> allow you to specify an
                 alternate <classname>Zend_Session_Namespace</classname> implementation to
                 alternate <classname>Zend_Session_Namespace</classname> implementation to
-                use to persist the CAPTCHA token and to retrieve the
+                use to persist the <acronym>CAPTCHA</acronym> token and to retrieve the
                 current value.
                 current value.
             </para></listitem>
             </para></listitem>
 
 
@@ -60,20 +60,20 @@
 
 
             <listitem><para>
             <listitem><para>
                 <methodname>getWord()</methodname> allows you to retrieve the generated
                 <methodname>getWord()</methodname> allows you to retrieve the generated
-                word to use with the CAPTCHA. It will generate the word for you if
-                none has been generated yet.
+                word to use with the <acronym>CAPTCHA</acronym>. It will generate the word for you
+                if none has been generated yet.
             </para></listitem>
             </para></listitem>
 
 
             <listitem><para>
             <listitem><para>
                 <methodname>setSession(Zend_Session_Namespace $session)</methodname> allows
                 <methodname>setSession(Zend_Session_Namespace $session)</methodname> allows
                 you to specify a session object to use for persisting the
                 you to specify a session object to use for persisting the
-                CAPTCHA token. <methodname>getSession()</methodname> allows you to retrieve
-                the current session object.
+                <acronym>CAPTCHA</acronym> token. <methodname>getSession()</methodname> allows you
+                to retrieve the current session object.
             </para></listitem>
             </para></listitem>
         </itemizedlist>
         </itemizedlist>
 
 
         <para>
         <para>
-            All word CAPTCHAs allow you to pass an array of options to the
+            All word <acronym>CAPTCHA</acronym>s allow you to pass an array of options to the
             constructor, or, alternately, pass them to
             constructor, or, alternately, pass them to
             <methodname>setOptions()</methodname>. You can also pass a
             <methodname>setOptions()</methodname>. You can also pass a
             <classname>Zend_Config</classname> object to <methodname>setConfig()</methodname>. By
             <classname>Zend_Config</classname> object to <methodname>setConfig()</methodname>. By
@@ -97,7 +97,7 @@
         <para>
         <para>
             The <classname>Zend_Captch_Dumb</classname> adapter is mostly self-descriptive. It
             The <classname>Zend_Captch_Dumb</classname> adapter is mostly self-descriptive. It
             provides a random string that must be typed in reverse to validate. As such, it's
             provides a random string that must be typed in reverse to validate. As such, it's
-            not a good CAPTCHA solution and should only be used for
+            not a good <acronym>CAPTCHA</acronym> solution and should only be used for
             testing. It extends <classname>Zend_Captcha_Word</classname>.
             testing. It extends <classname>Zend_Captcha_Word</classname>.
         </para>
         </para>
     </sect2>
     </sect2>
@@ -123,12 +123,13 @@
         <title>Zend_Captcha_Image</title>
         <title>Zend_Captcha_Image</title>
 
 
         <para>
         <para>
-            The Zend_Captcha_Image adapter takes the generated word and renders it as an
-            image, performing various skewing permutations to make it
+            The <classname>Zend_Captcha_Image</classname> adapter takes the generated word and
+            renders it as an image, performing various skewing permutations to make it
             difficult to automatically decipher. It
             difficult to automatically decipher. It
             requires the <ulink url="http://php.net/gd">GD extension</ulink>
             requires the <ulink url="http://php.net/gd">GD extension</ulink>
-            compiled with TrueType or Freetype support. Currently, the Zend_Captcha_Image
-            adapter can only generate PNG images.
+            compiled with TrueType or Freetype support. Currently, the
+            <classname>Zend_Captcha_Image</classname> adapter can only generate
+            <acronym>PNG</acronym> images.
         </para>
         </para>
 
 
         <para>
         <para>
@@ -141,9 +142,9 @@
             <listitem><para>
             <listitem><para>
                 <methodname>setExpiration($expiration)</methodname> and
                 <methodname>setExpiration($expiration)</methodname> and
                 <methodname>getExpiration()</methodname> allow you to specify a maximum
                 <methodname>getExpiration()</methodname> allow you to specify a maximum
-                lifetime the CAPTCHA image may reside on the filesystem. This is
+                lifetime the <acronym>CAPTCHA</acronym> image may reside on the filesystem. This is
                 typically a longer than the session lifetime. Garbage
                 typically a longer than the session lifetime. Garbage
-                collection is run periodically each time the CAPTCHA object is
+                collection is run periodically each time the <acronym>CAPTCHA</acronym> object is
                 invoked, deleting all images that have expired.
                 invoked, deleting all images that have expired.
                 Expiration values should be specified in seconds.
                 Expiration values should be specified in seconds.
             </para></listitem>
             </para></listitem>
@@ -159,45 +160,47 @@
                 <methodname>setFont($font)</methodname> and <methodname>getFont()</methodname> allow
                 <methodname>setFont($font)</methodname> and <methodname>getFont()</methodname> allow
                 you to specify the font you will use. <varname>$font</varname>
                 you to specify the font you will use. <varname>$font</varname>
                 should be a fully qualified path to the font file.
                 should be a fully qualified path to the font file.
-                This value is required; the CAPTCHA will throw an
+                This value is required; the <acronym>CAPTCHA</acronym> will throw an
                 exception during generation if the font file has not been specified.
                 exception during generation if the font file has not been specified.
             </para></listitem>
             </para></listitem>
 
 
             <listitem><para>
             <listitem><para>
                 <methodname>setFontSize($fsize)</methodname> and
                 <methodname>setFontSize($fsize)</methodname> and
                 <methodname>getFontSize()</methodname> allow you to specify the font size in pixels
                 <methodname>getFontSize()</methodname> allow you to specify the font size in pixels
-                for generating the CAPTCHA. The default is 24px.
+                for generating the <acronym>CAPTCHA</acronym>. The default is 24px.
             </para></listitem>
             </para></listitem>
 
 
             <listitem><para>
             <listitem><para>
                 <methodname>setHeight($height)</methodname> and <methodname>getHeight()</methodname>
                 <methodname>setHeight($height)</methodname> and <methodname>getHeight()</methodname>
                 allow you to specify the height in pixels of the generated
                 allow you to specify the height in pixels of the generated
-                CAPTCHA image. The default is 50px.
+                <acronym>CAPTCHA</acronym> image. The default is 50px.
             </para></listitem>
             </para></listitem>
 
 
             <listitem><para>
             <listitem><para>
                 <methodname>setWidth($width)</methodname> and <methodname>getWidth()</methodname>
                 <methodname>setWidth($width)</methodname> and <methodname>getWidth()</methodname>
                 allow you to specify the width in pixels of the generated
                 allow you to specify the width in pixels of the generated
-                CAPTCHA image. The default is 200px.
+                <acronym>CAPTCHA</acronym> image. The default is 200px.
             </para></listitem>
             </para></listitem>
 
 
             <listitem><para>
             <listitem><para>
                 <methodname>setImgDir($imgDir)</methodname> and <methodname>getImgDir()</methodname>
                 <methodname>setImgDir($imgDir)</methodname> and <methodname>getImgDir()</methodname>
-                allow you to specify the directory for storing CAPTCHA images.
-                The default is "./images/captcha/", relative to the bootstrap script.
+                allow you to specify the directory for storing <acronym>CAPTCHA</acronym> images.
+                The default is "<filename>./images/captcha/</filename>", relative to the bootstrap
+                script.
             </para></listitem>
             </para></listitem>
 
 
             <listitem><para>
             <listitem><para>
                 <methodname>setImgUrl($imgUrl)</methodname> and <methodname>getImgUrl()</methodname>
                 <methodname>setImgUrl($imgUrl)</methodname> and <methodname>getImgUrl()</methodname>
-                allow you to specify the relative path to a CAPTCHA image to
-                use for HTML markup. The default is "/images/captcha/".
+                allow you to specify the relative path to a <acronym>CAPTCHA</acronym> image to
+                use for <acronym>HTML</acronym> markup. The default is
+                "<filename>/images/captcha/</filename>".
             </para></listitem>
             </para></listitem>
 
 
             <listitem><para>
             <listitem><para>
                 <methodname>setSuffix($suffix)</methodname> and <methodname>getSuffix()</methodname>
                 <methodname>setSuffix($suffix)</methodname> and <methodname>getSuffix()</methodname>
-                allow you to specify the filename suffix for the CAPTCHA image. The
-                default is ".png". Note: changing this value will not change the
-                type of the generated image.
+                allow you to specify the filename suffix for the <acronym>CAPTCHA</acronym> image.
+                The default is "<filename>.png</filename>". Note: changing this value will not
+                change the type of the generated image.
             </para></listitem>
             </para></listitem>
         </itemizedlist>
         </itemizedlist>
 
 
@@ -214,7 +217,7 @@
         <para>
         <para>
             The <classname>Zend_Captcha_ReCaptcha</classname> adapter uses <link
             The <classname>Zend_Captcha_ReCaptcha</classname> adapter uses <link
                 linkend="zend.service.recaptcha">Zend_Service_ReCaptcha</link>
                 linkend="zend.service.recaptcha">Zend_Service_ReCaptcha</link>
-            to generate and validate CAPTCHAs. It exposes the following
+            to generate and validate <acronym>CAPTCHA</acronym>s. It exposes the following
             methods:
             methods:
         </para>
         </para>