[MANUAL] English:

- several manual fixes

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@22747 44c647ce-9c0f-0410-b52a-842ac1e357ba

documentation/manual/en/module_specs/Zend_Http_Response.xml

@@ -45,8 +45,8 @@ $response = Zend_Http_Response::fromString($str);
         </para>
 
         <para>
-            <code>public function __construct($code, $headers, $body = null, $version = '1.1',
-                $message = null)</code>
+            <command>public function __construct($code, $headers, $body = null, $version = '1.1',
+                $message = null)</command>
         </para>
 
         <itemizedlist>
@@ -97,23 +97,23 @@ $response = Zend_Http_Response::fromString($str);
             <itemizedlist>
                 <listitem>
                     <para>
-                        <code>Boolean isSuccessful()</code>: Whether the request was successful or
-                        not. Returns <constant>TRUE</constant> for <acronym>HTTP</acronym> 1xx and
-                        2xx response codes
+                        <methodname>isSuccessful()</methodname>: Whether the request was successful
+                        or not. Returns <constant>TRUE</constant> for <acronym>HTTP</acronym> 1xx
+                        and 2xx response codes
                     </para>
                 </listitem>
 
                 <listitem>
                     <para>
-                        <code>Boolean isError()</code>: Whether the response code implies an error
-                        or not. Returns <constant>TRUE</constant> for <acronym>HTTP</acronym> 4xx
-                        (client errors) and 5xx (server errors) response codes
+                        <methodname>isError()</methodname>: Whether the response code implies an
+                        error or not. Returns <constant>TRUE</constant> for <acronym>HTTP</acronym>
+                        4xx (client errors) and 5xx (server errors) response codes
                     </para>
                 </listitem>
 
                 <listitem>
                     <para>
-                        <code>Boolean isRedirect()</code>: Whether the response is a redirection
+                        <methodname>isRedirect()</methodname>: Whether the response is a redirection
                         response or not. Returns <constant>TRUE</constant> for
                         <acronym>HTTP</acronym> 3xx response codes
                     </para>
@@ -144,28 +144,28 @@ if ($response->isError()) {
             <itemizedlist>
                 <listitem>
                     <para>
-                        <code>int getStatus()</code>: Get the <acronym>HTTP</acronym> response
-                        status code (eg. 200, 504, etc.)
+                        <methodname>getStatus()</methodname>: Get the <acronym>HTTP</acronym>
+                        response status code (eg. 200, 504, etc.)
                     </para>
                 </listitem>
 
                 <listitem>
                     <para>
-                        <code>string getMessage()</code>: Get the <acronym>HTTP</acronym> response
-                        status message (eg. "Not Found", "Authorization Required")
+                        <methodname>getMessage()</methodname>: Get the <acronym>HTTP</acronym>
+                        response status message (eg. "Not Found", "Authorization Required")
                     </para>
                 </listitem>
 
                 <listitem>
                     <para>
-                        <code>string getBody()</code>: Get the fully decoded <acronym>HTTP</acronym>
-                        response body
+                        <methodname>getBody()</methodname>: Get the fully decoded
+                        <acronym>HTTP</acronym> response body
                     </para>
                 </listitem>
 
                 <listitem>
                     <para>
-                        <code>string getRawBody()</code>: Get the raw, possibly encoded
+                        <methodname>getRawBody()</methodname>: Get the raw, possibly encoded
                         <acronym>HTTP</acronym> response body. if the body was decoded using GZIP
                         encoding for example, it will not be decoded.
                     </para>
@@ -173,34 +173,36 @@ if ($response->isError()) {
 
                 <listitem>
                     <para>
-                        <code>array getHeaders()</code>: Get the <acronym>HTTP</acronym> response
-                        headers as an associative array (eg. 'Content-type' => 'text/html')
+                        <methodname>getHeaders()</methodname>: Get the <acronym>HTTP</acronym>
+                        response headers as an associative array (eg. 'Content-type' => 'text/html')
                     </para>
                 </listitem>
 
                 <listitem>
                     <para>
-                        <code>string|array getHeader($header)</code>: Get a specific
+                        <methodname>getHeader($header)</methodname>: Get a specific
                         <acronym>HTTP</acronym> response header, specified by $header
                     </para>
                 </listitem>
 
                 <listitem>
                     <para>
-                        <code>string getHeadersAsString($status_line = true, $br = "\n")</code>: Get
-                        the entire set of headers as a string. If $status_line is
+                        <methodname>getHeadersAsString($status_line, $br)</methodname>: Get
+                        the entire set of headers as a string. If <varname>$status_line</varname> is
                         <constant>TRUE</constant> (default), the first status line (eg. "HTTP/1.1
-                        200 OK") will also be returned. Lines are broken with the $br parameter (Can
-                        be, for example, "&lt;br /&gt;")
+                        200 OK") will also be returned. Lines are broken with the
+                        <varname>$br</varname> parameter (Can be, for example, "&lt;br /&gt;".
+                        Default "\n")
                     </para>
                 </listitem>
 
                 <listitem>
                     <para>
-                        <code>string asString($br = "\n")</code>: Get the entire response message as
+                        <methodname>asString($br)</methodname>: Get the entire response message as
                         a string. Lines are broken with the $br parameter (Can be, for example,
-                        "&lt;br /&gt;"). You can also use the magic method __toString() when casting
-                        the object as a string. It will then proxy to asString()
+                        "&lt;br /&gt;". Default "\n"). You can also use the magic method
+                        <methodname>__toString()</methodname> when casting the object as a string.
+                        It will then proxy to <methodname>asString()</methodname>.
                     </para>
                 </listitem>
             </itemizedlist>
@@ -261,53 +263,56 @@ echo $body;
             <itemizedlist>
                 <listitem>
                     <para>
-                        <code>int Zend_Http_Response::extractCode($response_str)</code>: Extract
-                        and return the <acronym>HTTP</acronym> response code (eg. 200 or 404) from
-                        $response_str
+                        <methodname>Zend_Http_Response::extractCode($response_str)</methodname>:
+                        Extract and return the <acronym>HTTP</acronym> response code (eg. 200 or
+                        404) from <varname>$response_str</varname>
                     </para>
                 </listitem>
 
                 <listitem>
                     <para>
-                        <code>string Zend_Http_Response::extractMessage($response_str)</code>:
+                        <methodname>Zend_Http_Response::extractMessage($response_str)</methodname>:
                         Extract and return the <acronym>HTTP</acronym> response message (eg. "OK" or
-                        "File Not Found") from $response_str
+                        "File Not Found") from <varname>$response_str</varname>
                     </para>
                 </listitem>
 
                 <listitem>
                     <para>
-                        <code>string Zend_Http_Response::extractVersion($response_str)</code>:
+                        <methodname>Zend_Http_Response::extractVersion($response_str)</methodname>:
                         Extract and return the <acronym>HTTP</acronym> version (eg. 1.1 or 1.0) from
-                        $response_str
+                        <varname>$response_str</varname>
                     </para>
                 </listitem>
 
                 <listitem>
                     <para>
-                        <code>array Zend_Http_Response::extractHeaders($response_str)</code>:
+                        <methodname>Zend_Http_Response::extractHeaders($response_str)</methodname>:
                         Extract and return the <acronym>HTTP</acronym> response headers from
-                        $response_str as an array
+                        <varname>$response_str</varname> as an array
                     </para>
                 </listitem>
 
                 <listitem>
                     <para>
-                        <code>string Zend_Http_Response::extractBody($response_str)</code>: Extract
-                        and return the <acronym>HTTP</acronym> response body from $response_str
+                        <methodname>Zend_Http_Response::extractBody($response_str)</methodname>:
+                        Extract and return the <acronym>HTTP</acronym> response body from
+                        <varname>$response_str</varname>
                     </para>
                 </listitem>
 
                 <listitem>
                     <para>
-                        <code>string Zend_Http_Response::responseCodeAsText($code = null, $http11 =
-                        true)</code>: Get the standard <acronym>HTTP</acronym> response message for
-                        a response code $code. For example, will return "Internal Server Error" if
-                        $code is 500. If $http11 is <constant>TRUE</constant> (default), will return
+                        <methodname>Zend_Http_Response::responseCodeAsText($code,
+                            $http11)</methodname>: Get the standard <acronym>HTTP</acronym> response
+                        message for a response code $code. For example, will return "Internal Server
+                        Error" if <varname>$code</varname> is 500. If <varname>$http11</varname> is
+                        <constant>TRUE</constant> (default), will return
                         <acronym>HTTP</acronym>/1.1 standard messages - otherwise
-                        <acronym>HTTP</acronym>/1.0 messages will be returned. If $code is not
-                        specified, this method will return all known <acronym>HTTP</acronym>
-                        response codes as an associative (code => message) array.
+                        <acronym>HTTP</acronym>/1.0 messages will be returned. If
+                        <varname>$code</varname> is not specified, this method will return all known
+                        <acronym>HTTP</acronym> response codes as an associative (code => message)
+                        array.
                     </para>
                 </listitem>
             </itemizedlist>
@@ -320,21 +325,21 @@ echo $body;
             <itemizedlist>
                 <listitem>
                     <para>
-                        <code>string Zend_Http_Response::decodeChunkedBody($body)</code>: Decode
-                        a complete "Content-Transfer-Encoding: Chunked" body
+                        <methodname>Zend_Http_Response::decodeChunkedBody($body)</methodname>:
+                        Decode a complete "Content-Transfer-Encoding: Chunked" body
                     </para>
                 </listitem>
 
                 <listitem>
                     <para>
-                        <code>string Zend_Http_Response::decodeGzip($body)</code>: Decode
+                        <methodname>Zend_Http_Response::decodeGzip($body)</methodname>: Decode
                         a "Content-Encoding: gzip" body
                     </para>
                 </listitem>
 
                 <listitem>
                     <para>
-                        <code>string Zend_Http_Response::decodeDeflate($body)</code>: Decode
+                        <methodname>Zend_Http_Response::decodeDeflate($body)</methodname>: Decode
                         a "Content-Encoding: deflate" body
                     </para>
                 </listitem>

documentation/manual/en/module_specs/Zend_InfoCard-Basics.xml

@@ -45,13 +45,13 @@
 ]]></programlisting>
 
         <para>
-            In the example above, the <code>requiredClaims</code>
-            <code>&lt;param&gt;</code> tag is used to identify pieces of
-            information known as claims (i.e. person's first name, last name)
-            which the web site (a.k.a "relying party") needs in order a user to
-            authenticate using an information card. For your reference, the full
-            <acronym>URI</acronym> (for instance the <code>givenname</code> claim) is as follows:
-            <code>http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname</code>
+            In the example above, the <property>requiredClaims</property>
+            &lt;param&gt; tag is used to identify pieces of information known as claims (i.e.
+            person's first name, last name) which the web site (a.k.a "relying party") needs in
+            order a user to authenticate using an information card. For your reference, the full
+            <acronym>URI</acronym> (for instance the <emphasis>givenname</emphasis> claim) is as
+            follows:
+            <filename>http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname</filename>
         </para>
 
         <para>
@@ -65,7 +65,7 @@
         </para>
 
         <para>
-            Note, Information cards can only be <code>HTTP POST</code>ed to
+            Note, Information cards can only be <acronym>HTTP</acronym> <acronym>POST</acronym>ed to
             <acronym>SSL</acronym>-encrypted <acronym>URL</acronym>s. Please consult your web
             server's documentation on how to set up <acronym>SSL</acronym> encryption.
         </para>
@@ -143,10 +143,9 @@ if (isset($_POST['xmlToken'])) {
             <classname>Zend_Auth_Adapter_InfoCard</classname> and pass the <acronym>XML</acronym>
             data posted by the card selector into it. Once an instance has been created you
             must then provide at least one <acronym>SSL</acronym> certificate public/private key
-            pair used by the web server that received the <code>HTTP
-            POST</code>. These files are used to validate the destination
-            of the information posted to the server and are a requirement when
-            using Information Cards.
+            pair used by the web server that received the <acronym>HTTP</acronym>
+            <acronym>POST</acronym>. These files are used to validate the destination of the
+            information posted to the server and are a requirement when using Information Cards.
         </para>
 
         <para>
@@ -231,13 +230,13 @@ if (isset($_POST['xmlToken'])) {
             can be ascertained by calling the
             <methodname>Zend_InfoCard_Claims::isValid()</methodname> method. Claims
             themselves can either be retrieved by simply accessing the
-            identifier desired (i.e. <code>givenname</code>) as a property of
+            identifier desired (i.e. <property>givenname</property>) as a property of
             the object or through the <methodname>getClaim()</methodname> method.
         </para>
 
         <para>
             In most cases you will never need to use the <methodname>getClaim()</methodname>
-            method. However, if your <code>requiredClaims</code> mandate that
+            method. However, if your <property>requiredClaims</property> mandate that
             you request claims from multiple different sources/namespaces then
             you will need to extract them explicitly using this method (simply
             pass it the full <acronym>URI</acronym> of the claim to retrieve its value from within
@@ -265,8 +264,8 @@ if (isset($_POST['xmlToken'])) {
             authentication system by storing the private personal identifier
             (PPI) to a previously traditionally-authenticated account and
             including at least the
-            <code>http://schemas.xmlsoap.org/ws/2005/05/identity/claims/privatepersonalidentifier</code>
-            claim as part of the <code>requiredClaims</code> of the request. If
+            <filename>http://schemas.xmlsoap.org/ws/2005/05/identity/claims/privatepersonalidentifier</filename>
+            claim as part of the <property>requiredClaims</property> of the request. If
             this claim is requested then the <classname>Zend_InfoCard_Claims</classname>
             object will provide a unique identifier for the specific card that
             was submitted by calling the <methodname>getCardID()</methodname> method.

documentation/manual/en/module_specs/Zend_Json-Objects.xml

@@ -40,7 +40,7 @@ $phpNative = Zend_Json::decode($encodedValue, Zend_Json::TYPE_OBJECT);
 ]]></programlisting>
 
         <para>
-            Any objects thus decoded are returned as <code>StdClass</code> objects
+            Any objects thus decoded are returned as <classname>StdClass</classname> objects
             with properties corresponding to the key/value pairs in the <acronym>JSON</acronym>
             notation.
         </para>
@@ -105,9 +105,10 @@ Zend_Json::$useBuiltinEncoderDecoder = true:
             object. It implements the value object pattern and is immutable. You can set the
             javascript expression as the first constructor argument. By default
             <classname>Zend_Json::encode</classname> does not encode javascript callbacks, you have
-            to pass the option <code>'enableJsonExprFinder' = true</code> into the
-            <code>encode</code> function. If enabled the expression support works for all nested
-            expressions in large object structures. A usage example would look like:
+            to pass the option <property>enableJsonExprFinder</property> and set it to
+            <constant>TRUE</constant> into the <methodname>encode()</methodname> function. If
+            enabled the expression support works for all nested expressions in large object
+            structures. A usage example would look like:
         </para>
 
         <programlisting language="php"><![CDATA[