Pārlūkot izejas kodu

Improved consistency of reCAPTCHA and CAPTCHA usage. Corrected grammatical errors. Improved comment formatting. Resolves ZF-5490.

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@18816 44c647ce-9c0f-0410-b52a-842ac1e357ba
jordanryanmoore 16 gadi atpakaļ
vecāks
revīzija
7c227750f8

+ 19 - 19
documentation/manual/en/module_specs/Zend_Service-ReCaptcha.xml

@@ -11,7 +11,7 @@
                 url="http://recaptcha.net/">reCAPTCHA Web Service</ulink>.
             Per the reCAPTCHA site, "reCAPTCHA is a free CAPTCHA service that
             helps to digitize books." Each reCAPTCHA requires the user to input
-            two words, the first of which is the actual captcha, and the second
+            two words, the first of which is the actual CAPTCHA, and the second
             of which is a word from some scanned text that Optical Character
             Recognition (OCR) software has been unable to identify.
             The assumption is that if a user correctly provides the first
@@ -36,7 +36,7 @@
         </para>
 
         <example id="zend.service.recaptcha.example-1">
-            <title>Creating an instance of the ReCaptcha service</title>
+            <title>Creating an instance of the reCAPTCHA service</title>
             <programlisting language="php"><![CDATA[
 $recaptcha = new Zend_Service_ReCaptcha($pubKey, $privKey);
 ]]></programlisting>
@@ -48,7 +48,7 @@ $recaptcha = new Zend_Service_ReCaptcha($pubKey, $privKey);
         </para>
 
         <example id="zend.service.recaptcha.example-2">
-            <title>Displaying the ReCaptcha</title>
+            <title>Displaying the reCAPTCHA</title>
             <programlisting language="php"><![CDATA[
 echo $recaptcha->getHTML();
 ]]></programlisting>
@@ -57,7 +57,7 @@ echo $recaptcha->getHTML();
         <para>
             When the form is submitted, you should receive two fields,
             'recaptcha_challenge_field' and 'recaptcha_response_field'. Pass
-            these to the ReCaptcha object's <methodname>verify()</methodname> method:
+            these to the reCAPTCHA object's <methodname>verify()</methodname> method:
         </para>
 
         <example id="zend.service.recaptcha.example-3">
@@ -77,7 +77,7 @@ $result = $recaptcha->verify(
         </para>
 
         <example id="zend.service.recaptcha.example-4">
-            <title>Validating the ReCaptcha</title>
+            <title>Validating the reCAPTCHA</title>
             <programlisting language="php"><![CDATA[
 if (!$result->isValid()) {
     // Failed validation
@@ -86,11 +86,11 @@ if (!$result->isValid()) {
         </example>
 
         <para>
-            Even simpler is to use <link
-                linkend="zend.captcha.adapters.recaptcha">the ReCaptcha</link>
+            It is even simpler to use <link
+                linkend="zend.captcha.adapters.recaptcha">the reCAPTCHA</link>
             <classname>Zend_Captcha</classname> adapter, or to use that adapter as a
             backend for the <link
-                linkend="zend.form.standardElements.captcha">Captcha form
+                linkend="zend.form.standardElements.captcha">CAPTCHA form
                 element</link>. In each case, the details of rendering and
             validating the reCAPTCHA are automated for you.
         </para>
@@ -102,12 +102,12 @@ if (!$result->isValid()) {
         <para>
             <classname>Zend_Service_ReCaptcha_MailHide</classname> can be used to hide email 
             addresses. It will replace a part of an email address with a link that opens a popup 
-            window with a ReCaptcha challenge. Solving the challenge will reveal the complete 
+            window with a reCAPTCHA challenge. Solving the challenge will reveal the complete 
             email address. 
         </para>
         <para>
             In order to use this component you will need 
-            <ulink url="http://recaptcha.net/whyrecaptcha.html">an account</ulink>, and generate 
+            <ulink url="http://recaptcha.net/whyrecaptcha.html">an account</ulink> to generate 
             public and private keys for the mailhide API.
         </para>
         <example id="zend.service.recaptcha.mailhide.example-1">
@@ -116,8 +116,8 @@ if (!$result->isValid()) {
 // The mail address we want to hide
 $mail = 'mail@example.com';
 
-// Create an instance of the mailhide component, passing it your public and private keys as well as 
-// the mail address you want to hide
+// Create an instance of the mailhide component, passing it your public
+// and private keys, as well as the mail address you want to hide
 $mailHide = new Zend_Service_ReCaptcha_Mailhide();
 $mailHide->setPublicKey($pubKey);
 $mailHide->setPrivateKey($privKey);
@@ -129,10 +129,10 @@ print($mailHide);
         </example>
         <para>
             The example above will display "m...@example.com" where "..." has a link that opens up 
-            a popup windows with a ReCaptcha challenge.
+            a popup window with a reCAPTCHA challenge.
         </para>
         <para>
-            The public key, private key and the email address can also be specified in the 
+            The public key, private key, and the email address can also be specified in the 
             constructor of the class. A fourth argument also exists that enables you to set some
             options for the component. The available options are listed in the following table:
             <table id="zend.service.recaptcha.mailhide.options.table">
@@ -176,15 +176,15 @@ print($mailHide);
             </table>
         </para>
         <para>
-            The configuration options can be set by sending it as the fourth argument to the 
-            constructor or by calling the <methodname>setOptions($options)</methodname> which takes 
+            The configuration options can be set by sending them as the fourth argument to the 
+            constructor or by calling <methodname>setOptions($options)</methodname>, which takes 
             an associative array or an instance of <link linkend="zend.config">Zend_Config</link>.
         </para>
         <example id="zend.service.recaptcha.mailhide.example-2">
             <title>Generating many hidden email addresses</title>
             <programlisting language="php"><![CDATA[
-// Create an instance of the mailhide component, passing it your public and private keys as well as 
-// well the mail address you want to hide
+// Create an instance of the mailhide component, passing it your public
+// and private keys, as well as some configuration options
 $mailHide = new Zend_Service_ReCaptcha_Mailhide();
 $mailHide->setPublicKey($pubKey);
 $mailHide->setPrivateKey($privKey);
@@ -193,7 +193,7 @@ $mailHide->setOptions(array(
     'linkHiddenText' => '+++++',
 ));
 
-// The addresses we want to hide
+// The mail addresses we want to hide
 $mailAddresses = array(
     'mail@example.com',
     'johndoe@example.com',