Browse Source

[DOCUMENTATION] English:

- manual fixes

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@15735 44c647ce-9c0f-0410-b52a-842ac1e357ba
thomas 16 years ago
parent
commit
816838039b

+ 11 - 11
documentation/manual/en/module_specs/Zend_Auth_Adapter_DbTable.xml

@@ -18,7 +18,7 @@
             <itemizedlist>
             <itemizedlist>
                 <listitem>
                 <listitem>
                     <para>
                     <para>
-                        <code>tableName</code>: This is the name of the database
+                        <emphasis>tableName</emphasis>: This is the name of the database
                          table that contains the authentication credentials,
                          table that contains the authentication credentials,
                         and against which the database authentication query is
                         and against which the database authentication query is
                         performed.
                         performed.
@@ -26,7 +26,7 @@
                 </listitem>
                 </listitem>
                 <listitem>
                 <listitem>
                     <para>
                     <para>
-                        <code>identityColumn</code>: This is the name of the
+                        <emphasis>identityColumn</emphasis>: This is the name of the
                         database table column used to represent the identity.
                         database table column used to represent the identity.
                         The identity column must contain unique values, such as
                         The identity column must contain unique values, such as
                         a username or e-mail address.
                         a username or e-mail address.
@@ -34,22 +34,22 @@
                 </listitem>
                 </listitem>
                 <listitem>
                 <listitem>
                     <para>
                     <para>
-                        <code>credentialColumn</code>: This is the name of the
+                        <emphasis>credentialColumn</emphasis>: This is the name of the
                         database table column used to represent the credential.
                         database table column used to represent the credential.
                         Under a simple identity and password authentication
                         Under a simple identity and password authentication
                         scheme, the credential value corresponds to the
                         scheme, the credential value corresponds to the
-                        password. See also the <code>credentialTreatment</code>
+                        password. See also the <emphasis>credentialTreatment</emphasis>
                         option.
                         option.
                     </para>
                     </para>
                 </listitem>
                 </listitem>
                 <listitem>
                 <listitem>
                     <para>
                     <para>
-                        <code>credentialTreatment</code>: In many cases,
+                        <emphasis>credentialTreatment</emphasis>: In many cases,
                         passwords and other sensitive data are encrypted,
                         passwords and other sensitive data are encrypted,
                         hashed, encoded, obscured, salted or otherwise treated
                         hashed, encoded, obscured, salted or otherwise treated
                         through some function or algorithm. By specifying a
                         through some function or algorithm. By specifying a
                         parameterized treatment string with this method, such as
                         parameterized treatment string with this method, such as
-                         <code>'MD5(?)'</code> or <code>'PASSWORD(?)'</code>, a
+                        'MD5(?)' or 'PASSWORD(?)', a
                         developer may apply such arbitrary SQL upon input
                         developer may apply such arbitrary SQL upon input
                         credential data. Since these functions are specific to
                         credential data. Since these functions are specific to
                         the underlying RDBMS, check the database manual for the
                         the underlying RDBMS, check the database manual for the
@@ -125,7 +125,7 @@ $authAdapter
                 At this point, the authentication adapter instance is ready to
                 At this point, the authentication adapter instance is ready to
                 accept authentication queries. In order to formulate an
                 accept authentication queries. In order to formulate an
                 authentication query, the input credential values are passed to
                 authentication query, the input credential values are passed to
-                the adapter prior to calling the <code>authenticate()</code>
+                the adapter prior to calling the <methodname>authenticate()</methodname>
                 method:
                 method:
             </para>
             </para>
             <programlisting language="php"><![CDATA[
             <programlisting language="php"><![CDATA[
@@ -139,7 +139,7 @@ $authAdapter
 ]]></programlisting>
 ]]></programlisting>
             <para>
             <para>
                 In addition to the availability of the
                 In addition to the availability of the
-                <code>getIdentity()</code> method upon the authentication result
+                <methodname>getIdentity()</methodname> method upon the authentication result
                 object, <classname>Zend_Auth_Adapter_DbTable</classname> also supports
                 object, <classname>Zend_Auth_Adapter_DbTable</classname> also supports
                 retrieving the table row upon authentication success:
                 retrieving the table row upon authentication success:
             </para>
             </para>
@@ -175,8 +175,8 @@ Array
             authentication. Another use case scenario, where developers want to
             authentication. Another use case scenario, where developers want to
             store to the persistent storage mechanism of <classname>Zend_Auth</classname>
             store to the persistent storage mechanism of <classname>Zend_Auth</classname>
             an identity object containing other useful information, is solved by
             an identity object containing other useful information, is solved by
-             using the <code>getResultRowObject()</code> method to return a
-            <code>stdClass</code> object. The following code snippet illustrates
+             using the <methodname>getResultRowObject()</methodname> method to return a
+            <emphasis>stdClass</emphasis> object. The following code snippet illustrates
             its use:
             its use:
         </para>
         </para>
         <programlisting language="php"><![CDATA[
         <programlisting language="php"><![CDATA[
@@ -291,7 +291,7 @@ $adapter = new Zend_Auth_Adapter_DbTable(
             </para>
             </para>
         </note>
         </note>
         <para>
         <para>
-            Another alternative is to use the <code>getDbSelect()</code> method
+            Another alternative is to use the <methodname>getDbSelect()</methodname> method
             of the Zend_Auth_Adapter_DbTable after the adapter has been constructed.
             of the Zend_Auth_Adapter_DbTable after the adapter has been constructed.
             This method will return the Zend_Db_Select object instance it will use
             This method will return the Zend_Db_Select object instance it will use
             to complete the authenticate() routine. It is important to note that
             to complete the authenticate() routine. It is important to note that

+ 7 - 7
documentation/manual/en/module_specs/Zend_Auth_Adapter_Digest.xml

@@ -22,12 +22,12 @@
             <itemizedlist>
             <itemizedlist>
                 <listitem>
                 <listitem>
                     <para>
                     <para>
-                        username, such as "<code>joe.user</code>"
+                        username, such as "<emphasis>joe.user</emphasis>"
                     </para>
                     </para>
                 </listitem>
                 </listitem>
                 <listitem>
                 <listitem>
                     <para>
                     <para>
-                        realm, such as "<code>Administrative Area</code>"
+                        realm, such as "<emphasis>Administrative Area</emphasis>"
                     </para>
                     </para>
                 </listitem>
                 </listitem>
                 <listitem>
                 <listitem>
@@ -37,7 +37,7 @@
                 </listitem>
                 </listitem>
             </itemizedlist>
             </itemizedlist>
             The above elements are separated by colons, as in the following example (in which the password is
             The above elements are separated by colons, as in the following example (in which the password is
-            "<code>somePassword</code>"):
+            "<emphasis>somePassword</emphasis>"):
         </para>
         </para>
 
 
         <programlisting language="txt"><![CDATA[
         <programlisting language="txt"><![CDATA[
@@ -74,7 +74,7 @@ someUser:Some Realm:fde17b91c3a510ecbaf7dbd37f59d4f8
                     </para>
                     </para>
                 </listitem>
                 </listitem>
             </itemizedlist>
             </itemizedlist>
-            These parameters must be set prior to calling <code>authenticate()</code>.
+            These parameters must be set prior to calling <methodname>authenticate()</methodname>.
         </para>
         </para>
 
 
     </sect2>
     </sect2>
@@ -85,9 +85,9 @@ someUser:Some Realm:fde17b91c3a510ecbaf7dbd37f59d4f8
 
 
         <para>
         <para>
             The digest authentication adapter returns a <classname>Zend_Auth_Result</classname> object, which has been
             The digest authentication adapter returns a <classname>Zend_Auth_Result</classname> object, which has been
-            populated with the identity as an array having keys of <code>realm</code> and
-            <code>username</code>. The respective array values associated with these keys correspond to the
-            values set before <code>authenticate()</code> is called.
+            populated with the identity as an array having keys of <emphasis>realm</emphasis> and
+            <emphasis>username</emphasis>. The respective array values associated with these keys correspond to the
+            values set before <methodname>authenticate()</methodname> is called.
         </para>
         </para>
 
 
         <programlisting language="php"><![CDATA[
         <programlisting language="php"><![CDATA[

+ 13 - 13
documentation/manual/en/module_specs/Zend_Auth_Adapter_Http.xml

@@ -100,37 +100,37 @@
                     </thead>
                     </thead>
                     <tbody>
                     <tbody>
                         <row>
                         <row>
-                            <entry><code>accept_schemes</code></entry>
+                            <entry><emphasis>accept_schemes</emphasis></entry>
                             <entry>Yes</entry>
                             <entry>Yes</entry>
                             <entry>
                             <entry>
                                 Determines which authentication schemes the adapter will accept from the client. Must be
                                 Determines which authentication schemes the adapter will accept from the client. Must be
-                                a space-separated list containing <code>'basic'</code> and/or <code>'digest'</code>.
+                                a space-separated list containing <emphasis>'basic'</emphasis> and/or <emphasis>'digest'</emphasis>.
                             </entry>
                             </entry>
                         </row>
                         </row>
                         <row>
                         <row>
-                            <entry><code>realm</code></entry>
+                            <entry><emphasis>realm</emphasis></entry>
                             <entry>Yes</entry>
                             <entry>Yes</entry>
                             <entry>
                             <entry>
                                 Sets the authentication realm; usernames should be unique within a given realm.
                                 Sets the authentication realm; usernames should be unique within a given realm.
                             </entry>
                             </entry>
                         </row>
                         </row>
                         <row>
                         <row>
-                            <entry><code>digest_domains</code></entry>
-                            <entry>Yes, when <code>'accept_schemes'</code> contains <code>'digest'</code></entry>
+                            <entry><emphasis>digest_domains</emphasis></entry>
+                            <entry>Yes, when <emphasis>'accept_schemes'</emphasis> contains <emphasis>'digest'</emphasis></entry>
                             <entry>
                             <entry>
                                 Space-separated list of URIs for which the same authentication information is valid. The
                                 Space-separated list of URIs for which the same authentication information is valid. The
                                 URIs need not all point to the same server.
                                 URIs need not all point to the same server.
                             </entry>
                             </entry>
                         </row>
                         </row>
                         <row>
                         <row>
-                            <entry><code>nonce_timeout</code></entry>
-                            <entry>Yes, when <code>'accept_schemes'</code> contains <code>'digest'</code></entry>
+                            <entry><emphasis>nonce_timeout</emphasis></entry>
+                            <entry>Yes, when <emphasis>'accept_schemes'</emphasis> contains <emphasis>'digest'</emphasis></entry>
                             <entry>
                             <entry>
                                 Sets the number of seconds for which the nonce is valid. See notes below.
                                 Sets the number of seconds for which the nonce is valid. See notes below.
                             </entry>
                             </entry>
                         </row>
                         </row>
                         <row>
                         <row>
-                            <entry><code>proxy_auth</code></entry>
+                            <entry><emphasis>proxy_auth</emphasis></entry>
                             <entry>No</entry>
                             <entry>No</entry>
                             <entry>
                             <entry>
                                 Disabled by default. Enable to perform Proxy authentication, instead of normal origin
                                 Disabled by default. Enable to perform Proxy authentication, instead of normal origin
@@ -144,7 +144,7 @@
 
 
         <note>
         <note>
             <para>
             <para>
-                The current implementation of the <code>nonce_timeout</code> has some interesting side effects. This
+                The current implementation of the <emphasis>nonce_timeout</emphasis> has some interesting side effects. This
                 setting is supposed to determine the valid lifetime of a given nonce, or effectively how long a client's
                 setting is supposed to determine the valid lifetime of a given nonce, or effectively how long a client's
                 authentication information is accepted. Currently, if it's set to 3600 (for example), it will cause the
                 authentication information is accepted. Currently, if it's set to 3600 (for example), it will cause the
                 adapter to prompt the client for new credentials every hour, on the hour. This will be resolved in a
                 adapter to prompt the client for new credentials every hour, on the hour. This will be resolved in a
@@ -177,7 +177,7 @@
 
 
             <para>
             <para>
                 The file resolver is a very simple class. It has a single property specifying a filename, which can also
                 The file resolver is a very simple class. It has a single property specifying a filename, which can also
-                be passed to the constructor. Its <code>resolve()</code> method walks through the text file, searching
+                be passed to the constructor. Its <methodname>resolve()</methodname> method walks through the text file, searching
                 for a line with a matching username and realm. The text file format similar to Apache htpasswd files:
                 for a line with a matching username and realm. The text file format similar to Apache htpasswd files:
                 <programlisting language="txt"><![CDATA[
                 <programlisting language="txt"><![CDATA[
 <username>:<realm>:<credentials>\n
 <username>:<realm>:<credentials>\n
@@ -223,9 +223,9 @@ $config = array(
 );
 );
 ]]></programlisting>
 ]]></programlisting>
             This array will cause the adapter to accept either Basic or Digest authentication, and will require
             This array will cause the adapter to accept either Basic or Digest authentication, and will require
-            authenticated access to all the areas of the site under <code>/members_only</code> and
-            <code>/my_account</code>. The realm value is usually displayed by the browser in the password dialog box.
-            The <code>nonce_timeout</code>, of course, behaves as described above.
+            authenticated access to all the areas of the site under <filename>/members_only</filename> and
+            <filename>/my_account</filename>. The realm value is usually displayed by the browser in the password dialog box.
+            The <emphasis>nonce_timeout</emphasis>, of course, behaves as described above.
         </para>
         </para>
 
 
         <para>
         <para>

+ 46 - 46
documentation/manual/en/module_specs/Zend_Auth_Adapter_Ldap.xml

@@ -75,12 +75,12 @@ if ($log_path) {
         <para>
         <para>
             The <classname>Zend_Config_Ini</classname> code is used above to load the adapter options. It is also optional. A
             The <classname>Zend_Config_Ini</classname> code is used above to load the adapter options. It is also optional. A
             regular array would work equally well. The following is an example
             regular array would work equally well. The following is an example
-            <code>application/config/config.ini</code> file that has options for two separate servers. With multiple
+            <filename>application/config/config.ini</filename> file that has options for two separate servers. With multiple
             sets of server options the adapter will try each, in order, until the credentials are successfully
             sets of server options the adapter will try each, in order, until the credentials are successfully
-            authenticated. The names of the servers (e.g., <code>server1</code> and <code>server2</code>) are largely
+            authenticated. The names of the servers (e.g., 'server1' and 'server2') are largely
             arbitrary. For details regarding the options array, see the <emphasis>Server Options</emphasis> section
             arbitrary. For details regarding the options array, see the <emphasis>Server Options</emphasis> section
             below. Note that <classname>Zend_Config_Ini</classname> requires that any values with "equals" characters
             below. Note that <classname>Zend_Config_Ini</classname> requires that any values with "equals" characters
-            (<code>=</code>) will need to be quoted (like the DNs shown below).
+            (<emphasis>=</emphasis>) will need to be quoted (like the DNs shown below).
             <programlisting language="ini"><![CDATA[
             <programlisting language="ini"><![CDATA[
 [production]
 [production]
 
 
@@ -105,8 +105,8 @@ ldap.server2.accountCanonicalForm = 3
 ldap.server2.baseDn = "CN=Users,DC=w,DC=net"
 ldap.server2.baseDn = "CN=Users,DC=w,DC=net"
 ]]></programlisting>
 ]]></programlisting>
             The above configuration will instruct <classname>Zend_Auth_Adapter_Ldap</classname> to attempt to authenticate users
             The above configuration will instruct <classname>Zend_Auth_Adapter_Ldap</classname> to attempt to authenticate users
-            with the OpenLDAP server <code>s0.foo.net</code> first. If the authentication fails for any reason, the AD
-            server <code>dc1.w.net</code> will be tried.
+            with the OpenLDAP server <filename>s0.foo.net</filename> first. If the authentication fails for any reason, the AD
+            server <filename>dc1.w.net</filename> will be tried.
         </para>
         </para>
 
 
         <para>
         <para>
@@ -138,9 +138,9 @@ ldap.server2.baseDn = "CN=Users,DC=w,DC=net"
         </para>
         </para>
 
 
         <para>
         <para>
-            Below is <ulink url="http://php.net/print_r"><code>print_r()</code></ulink> output of an example options
-            parameter containing two sets of server options for LDAP servers <code>s0.foo.net</code> and
-            <code>dc1.w.net</code> (the same options as the above INI representation):
+            Below is <ulink url="http://php.net/print_r"><methodname>print_r()</methodname></ulink> output of an example options
+            parameter containing two sets of server options for LDAP servers <filename>s0.foo.net</filename> and
+            <filename>dc1.w.net</filename> (the same options as the above INI representation):
             <programlisting language="output"><![CDATA[
             <programlisting language="output"><![CDATA[
 Array
 Array
 (
 (
@@ -169,7 +169,7 @@ Array
 )
 )
 ]]></programlisting>
 ]]></programlisting>
             The information provided in each set of options above is different mainly because AD does not require a
             The information provided in each set of options above is different mainly because AD does not require a
-            username be in DN form when binding (see the <code>bindRequiresDn</code> option in the
+            username be in DN form when binding (see the <emphasis>bindRequiresDn</emphasis> option in the
             <emphasis>Server Options</emphasis> section below), which means we can omit a number of options
             <emphasis>Server Options</emphasis> section below), which means we can omit a number of options
             associated with retrieving the DN for a username being authenticated.
             associated with retrieving the DN for a username being authenticated.
         </para>
         </para>
@@ -187,10 +187,10 @@ Array
         </note>
         </note>
 
 
         <para>
         <para>
-            The names of servers (e.g. '<code>server1</code>' and '<code>server2</code>' shown above) are largely
+            The names of servers (e.g. 'server1' and 'server2' shown above) are largely
             arbitrary, but for the sake of using <classname>Zend_Config</classname>, the identifiers should be present (as
             arbitrary, but for the sake of using <classname>Zend_Config</classname>, the identifiers should be present (as
             opposed to being numeric indexes) and should not contain any special characters used by the associated file
             opposed to being numeric indexes) and should not contain any special characters used by the associated file
-            formats (e.g. the '<code>.</code>' INI property separator, '<code>&amp;</code>' for XML entity references,
+            formats (e.g. the '<emphasis>.</emphasis>' INI property separator, '<emphasis>&amp;</emphasis>' for XML entity references,
             etc).
             etc).
         </para>
         </para>
 
 
@@ -202,7 +202,7 @@ Array
         <note>
         <note>
             <title>The Gory Details: What Happens in the Authenticate Method?</title>
             <title>The Gory Details: What Happens in the Authenticate Method?</title>
             <para>
             <para>
-                When the <code>authenticate()</code> method is called, the adapter iterates over each set of server
+                When the <methodname>authenticate()</methodname> method is called, the adapter iterates over each set of server
                 options, sets them on the internal <classname>Zend_Ldap</classname> instance, and calls the
                 options, sets them on the internal <classname>Zend_Ldap</classname> instance, and calls the
                 <classname>Zend_Ldap::bind()</classname> method with the username and password being authenticated. The
                 <classname>Zend_Ldap::bind()</classname> method with the username and password being authenticated. The
                 <classname>Zend_Ldap</classname> class checks to see if the username is qualified with a domain (e.g., has a
                 <classname>Zend_Ldap</classname> class checks to see if the username is qualified with a domain (e.g., has a
@@ -214,16 +214,16 @@ Array
                 qualified username, <classname>Zend_Ldap</classname> proceeds to try to bind with the supplied credentials. If
                 qualified username, <classname>Zend_Ldap</classname> proceeds to try to bind with the supplied credentials. If
                 the bind is not successful, <classname>Zend_Ldap</classname> throws a <classname>Zend_Ldap_Exception</classname> which is
                 the bind is not successful, <classname>Zend_Ldap</classname> throws a <classname>Zend_Ldap_Exception</classname> which is
                 caught by <classname>Zend_Auth_Adapter_Ldap</classname> and the next set of server options is tried. If the bind
                 caught by <classname>Zend_Auth_Adapter_Ldap</classname> and the next set of server options is tried. If the bind
-                is successful, the iteration stops, and the adapter's <code>authenticate()</code> method returns a
+                is successful, the iteration stops, and the adapter's <methodname>authenticate()</methodname> method returns a
                 successful result. If all server options have been tried without success, the authentication fails, and
                 successful result. If all server options have been tried without success, the authentication fails, and
-                <code>authenticate()</code> returns a failure result with error messages from the last iteration.
+                <methodname>authenticate()</methodname> returns a failure result with error messages from the last iteration.
             </para>
             </para>
         </note>
         </note>
 
 
         <para>
         <para>
             The username and password parameters of the <classname>Zend_Auth_Adapter_Ldap</classname> constructor represent the
             The username and password parameters of the <classname>Zend_Auth_Adapter_Ldap</classname> constructor represent the
             credentials being authenticated (i.e., the credentials supplied by the user through your HTML login form).
             credentials being authenticated (i.e., the credentials supplied by the user through your HTML login form).
-            Alternatively, they may also be set with the <code>setUsername()</code> and <code>setPassword()</code>
+            Alternatively, they may also be set with the <methodname>setUsername()</methodname> and <methodname>setPassword()</methodname>
             methods.
             methods.
         </para>
         </para>
 
 
@@ -257,8 +257,8 @@ Array
                     <entry><emphasis>port</emphasis></entry>
                     <entry><emphasis>port</emphasis></entry>
                     <entry>
                     <entry>
                         The port on which the LDAP server is listening. If <emphasis>useSsl</emphasis> is
                         The port on which the LDAP server is listening. If <emphasis>useSsl</emphasis> is
-                        <code>true</code>, the default <emphasis>port</emphasis> value is 636. If
-                        <emphasis>useSsl</emphasis> is <code>false</code>, the default
+                        <constant>TRUE</constant>, the default <emphasis>port</emphasis> value is 636. If
+                        <emphasis>useSsl</emphasis> is <constant>FALSE</constant>, the default
                         <emphasis>port</emphasis> value is 389.
                         <emphasis>port</emphasis> value is 389.
                     </entry>
                     </entry>
                   </row>
                   </row>
@@ -266,19 +266,19 @@ Array
                     <entry>useStartTls</entry>
                     <entry>useStartTls</entry>
                     <entry>
                     <entry>
                         Whether or not the LDAP client should use TLS (aka SSLv2) encrypted transport. A value of
                         Whether or not the LDAP client should use TLS (aka SSLv2) encrypted transport. A value of
-                        <code>true</code> is strongly favored in production environments to prevent passwords from
-                        be transmitted in clear text. The default value is <code>false</code>, as servers
+                        <constant>TRUE</constant> is strongly favored in production environments to prevent passwords from
+                        be transmitted in clear text. The default value is <constant>FALSE</constant>, as servers
                         frequently require that a certificate be installed separately after installation.
                         frequently require that a certificate be installed separately after installation.
-                        The <code>useSsl</code> and <code>useStartTls</code> options are mutually exclusive.
-                        The <code>useStartTls</code> option should be favored over <code>useSsl</code> but
+                        The <emphasis>useSsl</emphasis> and <emphasis>useStartTls</emphasis> options are mutually exclusive.
+                        The <emphasis>useStartTls</emphasis> option should be favored over <emphasis>useSsl</emphasis> but
                         not all servers support this newer mechanism.
                         not all servers support this newer mechanism.
                     </entry>
                     </entry>
                   </row>
                   </row>
                   <row>
                   <row>
                     <entry>useSsl</entry>
                     <entry>useSsl</entry>
                     <entry>
                     <entry>
-                        Whether or not the LDAP client should use SSL encrypted transport. The <code>useSsl</code>
-                        and <code>useStartTls</code> options are mutually exclusive, but <code>useStartTls</code>
+                        Whether or not the LDAP client should use SSL encrypted transport. The <emphasis>useSsl</emphasis>
+                        and <emphasis>useStartTls</emphasis> options are mutually exclusive, but <emphasis>useStartTls</emphasis>
                         should be favored if the server and LDAP client library support it.
                         should be favored if the server and LDAP client library support it.
                         This value also changes the default <emphasis>port</emphasis> value (see
                         This value also changes the default <emphasis>port</emphasis> value (see
                         <emphasis>port</emphasis> description above).
                         <emphasis>port</emphasis> description above).
@@ -289,7 +289,7 @@ Array
                     <entry>
                     <entry>
                         The DN of the account used to perform account DN lookups. LDAP servers that require the
                         The DN of the account used to perform account DN lookups. LDAP servers that require the
                         username to be in DN form when performing the "bind" require this option. Meaning, if
                         username to be in DN form when performing the "bind" require this option. Meaning, if
-                        <emphasis>bindRequiresDn</emphasis> is <code>true</code>, this option is
+                        <emphasis>bindRequiresDn</emphasis> is <constant>TRUE</constant>, this option is
                         required. This account does not need to be a privileged account; an account with read-only
                         required. This account does not need to be a privileged account; an account with read-only
                         access to objects under the <emphasis>baseDn</emphasis> is all that is necessary
                         access to objects under the <emphasis>baseDn</emphasis> is all that is necessary
                         (and preferred based on the <emphasis>Principle of Least Privilege</emphasis>).
                         (and preferred based on the <emphasis>Principle of Least Privilege</emphasis>).
@@ -307,14 +307,14 @@ Array
                     <entry>
                     <entry>
                         Some LDAP servers require that the username used to bind be in DN form like
                         Some LDAP servers require that the username used to bind be in DN form like
                         <emphasis>CN=Alice Baker,OU=Sales,DC=foo,DC=net</emphasis> (basically all servers
                         <emphasis>CN=Alice Baker,OU=Sales,DC=foo,DC=net</emphasis> (basically all servers
-                        <emphasis>except</emphasis> AD). If this option is <code>true</code>, this instructs
+                        <emphasis>except</emphasis> AD). If this option is <constant>TRUE</constant>, this instructs
                         <classname>Zend_Ldap</classname> to automatically retrieve the DN corresponding to the username being
                         <classname>Zend_Ldap</classname> to automatically retrieve the DN corresponding to the username being
                         authenticated, if it is not already in DN form, and then re-bind with the proper DN. The
                         authenticated, if it is not already in DN form, and then re-bind with the proper DN. The
-                        default value is <code>false</code>. Currently only Microsoft Active Directory Server (ADS) is
+                        default value is <constant>FALSE</constant>. Currently only Microsoft Active Directory Server (ADS) is
                         known <emphasis>not</emphasis> to require usernames to be in DN form when binding, and
                         known <emphasis>not</emphasis> to require usernames to be in DN form when binding, and
-                        therefore this option may be <code>false</code> with AD (and it should be, as retrieving the DN
+                        therefore this option may be <constant>FALSE</constant> with AD (and it should be, as retrieving the DN
                         requires an extra round trip to the server). Otherwise, this option must be set to
                         requires an extra round trip to the server). Otherwise, this option must be set to
-                        <code>true</code> (e.g. for OpenLDAP). This option also controls the default
+                        <constant>TRUE</constant> (e.g. for OpenLDAP). This option also controls the default
                         <emphasis>acountFilterFormat</emphasis> used when searching for accounts. See the
                         <emphasis>acountFilterFormat</emphasis> used when searching for accounts. See the
                         <emphasis>accountFilterFormat</emphasis> option.
                         <emphasis>accountFilterFormat</emphasis> option.
                     </entry>
                     </entry>
@@ -358,7 +358,7 @@ Array
                     <entry><emphasis>accountDomainName</emphasis></entry>
                     <entry><emphasis>accountDomainName</emphasis></entry>
                     <entry>
                     <entry>
                         The FQDN domain name for which the target LDAP server is an authority (e.g.,
                         The FQDN domain name for which the target LDAP server is an authority (e.g.,
-                        <code>example.com</code>). This option is used to canonicalize names so that the username
+                        <filename>example.com</filename>). This option is used to canonicalize names so that the username
                         supplied by the user can be converted as necessary for binding. It is also used to determine if
                         supplied by the user can be converted as necessary for binding. It is also used to determine if
                         the server is an authority for the supplied username (e.g., if
                         the server is an authority for the supplied username (e.g., if
                         <emphasis>accountDomainName</emphasis> is <emphasis>foo.net</emphasis> and the
                         <emphasis>accountDomainName</emphasis> is <emphasis>foo.net</emphasis> and the
@@ -387,20 +387,20 @@ Array
                     <entry><emphasis>accountFilterFormat</emphasis></entry>
                     <entry><emphasis>accountFilterFormat</emphasis></entry>
                     <entry>
                     <entry>
                         The LDAP search filter used to search for accounts. This string is a
                         The LDAP search filter used to search for accounts. This string is a
-                        <ulink url="http://php.net/printf"><code>printf()</code></ulink>-style expression that must
-                        contain one '<code>%s</code>' to accomodate the username. The default value is
-                        '<code>(&amp;(objectClass=user)(sAMAccountName=%s))</code>', unless
-                        <emphasis>bindRequiresDn</emphasis> is set to <code>true</code>, in which case
-                        the default is '<code>(&amp;(objectClass=posixAccount)(uid=%s))</code>'. For example, if for
-                        some reason you wanted to use <code>bindRequiresDn = true</code> with AD you would need to set
-                        <code>accountFilterFormat = '(&amp;(objectClass=user)(sAMAccountName=%s))</code>'.
+                        <ulink url="http://php.net/printf"><methodname>printf()</methodname></ulink>-style expression that must
+                        contain one '<emphasis>%s</emphasis>' to accomodate the username. The default value is
+                        '<emphasis>(&amp;(objectClass=user)(sAMAccountName=%s))</emphasis>', unless
+                        <emphasis>bindRequiresDn</emphasis> is set to <constant>TRUE</constant>, in which case
+                        the default is '<emphasis>(&amp;(objectClass=posixAccount)(uid=%s))</emphasis>'. For example, if for
+                        some reason you wanted to use <emphasis>bindRequiresDn = true</emphasis> with AD you would need to set
+                        <emphasis>accountFilterFormat = '(&amp;(objectClass=user)(sAMAccountName=%s))</emphasis>'.
                     </entry>
                     </entry>
                   </row>
                   </row>
                   <row>
                   <row>
                     <entry><emphasis>optReferrals</emphasis></entry>
                     <entry><emphasis>optReferrals</emphasis></entry>
                     <entry>
                     <entry>
-                        If set to <code>true</code>, this option indicates to the LDAP client that referrals should
-                        be followed. The default value is <code>false</code>.
+                        If set to <constant>TRUE</constant>, this option indicates to the LDAP client that referrals should
+                        be followed. The default value is <constant>FALSE</constant>.
                     </entry>
                     </entry>
                   </row>
                   </row>
                 </tbody>
                 </tbody>
@@ -410,11 +410,11 @@ Array
 
 
         <note>
         <note>
             <para>
             <para>
-                If you enable <code>useStartTls = true</code> or <code>useSsl = true</code> you may find that
+                If you enable <emphasis>useStartTls = true</emphasis> or <emphasis>useSsl = true</emphasis> you may find that
                 the LDAP client generates an error
                 the LDAP client generates an error
                 claiming that it cannot validate the server's certificate. Assuming the PHP LDAP extension is
                 claiming that it cannot validate the server's certificate. Assuming the PHP LDAP extension is
                 ultimately linked to the OpenLDAP client libraries, to resolve this issue you can set
                 ultimately linked to the OpenLDAP client libraries, to resolve this issue you can set
-                "<code>TLS_REQCERT never</code>" in the OpenLDAP client <code>ldap.conf</code> (and restart the web
+                "<emphasis>TLS_REQCERT never</emphasis>" in the OpenLDAP client <filename>ldap.conf</filename> (and restart the web
                 server) to indicate to the OpenLDAP client library that you trust the server. Alternatively, if you are
                 server) to indicate to the OpenLDAP client library that you trust the server. Alternatively, if you are
                 concerned that the server could be spoofed, you can export the LDAP server's root certificate and put
                 concerned that the server could be spoofed, you can export the LDAP server's root certificate and put
                 it on the web server so that the OpenLDAP client can validate the server's identity.
                 it on the web server so that the OpenLDAP client can validate the server's identity.
@@ -428,7 +428,7 @@ Array
         <title>Collecting Debugging Messages</title>
         <title>Collecting Debugging Messages</title>
 
 
         <para>
         <para>
-            <classname>Zend_Auth_Adapter_Ldap</classname> collects debugging information within its <code>authenticate()</code>
+            <classname>Zend_Auth_Adapter_Ldap</classname> collects debugging information within its <methodname>authenticate()</methodname>
             method. This information is stored in the <classname>Zend_Auth_Result</classname> object as messages. The array
             method. This information is stored in the <classname>Zend_Auth_Result</classname> object as messages. The array
             returned by <classname>Zend_Auth_Result::getMessages()</classname> is described as follows:
             returned by <classname>Zend_Auth_Result::getMessages()</classname> is described as follows:
 
 
@@ -504,14 +504,14 @@ Array
                       <row>
                       <row>
                         <entry><emphasis>useStartTls</emphasis></entry>
                         <entry><emphasis>useStartTls</emphasis></entry>
                         <entry>
                         <entry>
-                            For the sake of security, this should be <code>true</code> if the server has the necessary
+                            For the sake of security, this should be <constant>TRUE</constant> if the server has the necessary
                             certificate installed.
                             certificate installed.
                         </entry>
                         </entry>
                       </row>
                       </row>
                       <row>
                       <row>
                         <entry><emphasis>useSsl</emphasis></entry>
                         <entry><emphasis>useSsl</emphasis></entry>
                         <entry>
                         <entry>
-                            Possibly used as an alternative to <code>useStartTls</code> (see above).
+                            Possibly used as an alternative to <emphasis>useStartTls</emphasis> (see above).
                         </entry>
                         </entry>
                       </row>
                       </row>
                       <row>
                       <row>
@@ -594,14 +594,14 @@ Array
                       <row>
                       <row>
                         <entry><emphasis>useStartTls</emphasis></entry>
                         <entry><emphasis>useStartTls</emphasis></entry>
                         <entry>
                         <entry>
-                            For the sake of security, this should be <code>true</code> if the server has the necessary
+                            For the sake of security, this should be <constant>TRUE</constant> if the server has the necessary
                             certificate installed.
                             certificate installed.
                         </entry>
                         </entry>
                       </row>
                       </row>
                       <row>
                       <row>
                         <entry><emphasis>useSsl</emphasis></entry>
                         <entry><emphasis>useSsl</emphasis></entry>
                         <entry>
                         <entry>
-                            Possibly used as an alternative to <code>useStartTls</code> (see above).
+                            Possibly used as an alternative to <emphasis>useStartTls</emphasis> (see above).
                         </entry>
                         </entry>
                       </row>
                       </row>
                       <row>
                       <row>
@@ -621,7 +621,7 @@ Array
                       <row>
                       <row>
                         <entry><emphasis>bindRequiresDn</emphasis></entry>
                         <entry><emphasis>bindRequiresDn</emphasis></entry>
                         <entry>
                         <entry>
-                            Required and must be <code>true</code>, as OpenLDAP requires that usernames be in DN form
+                            Required and must be <constant>TRUE</constant>, as OpenLDAP requires that usernames be in DN form
                             when performing a bind.
                             when performing a bind.
                         </entry>
                         </entry>
                       </row>
                       </row>

+ 2 - 2
documentation/manual/en/module_specs/Zend_Auth_Adapter_OpenId.xml

@@ -42,7 +42,7 @@
         <para>
         <para>
             As is the case for all <classname>Zend_Auth</classname> adapters, the <classname>Zend_Auth_Adapter_OpenId</classname>
             As is the case for all <classname>Zend_Auth</classname> adapters, the <classname>Zend_Auth_Adapter_OpenId</classname>
             class implements <classname>Zend_Auth_Adapter_Interface</classname>, which
             class implements <classname>Zend_Auth_Adapter_Interface</classname>, which
-            defines one method: <code>authenticate()</code>. This method performs
+            defines one method: <methodname>authenticate()</methodname>. This method performs
             the authentication itself, but the object must be prepared prior to
             the authentication itself, but the object must be prepared prior to
             calling it. Such adapter preparation includes setting up the OpenID
             calling it. Such adapter preparation includes setting up the OpenID
             identity and some other <classname>Zend_OpenId</classname> specific options.
             identity and some other <classname>Zend_OpenId</classname> specific options.
@@ -65,7 +65,7 @@
             The following example shows the usage of <classname>Zend_Auth_Adapter_OpenId</classname>.
             The following example shows the usage of <classname>Zend_Auth_Adapter_OpenId</classname>.
             As previously mentioned, the <classname>Zend_Auth_Adapter_OpenId::authenticate()</classname>
             As previously mentioned, the <classname>Zend_Auth_Adapter_OpenId::authenticate()</classname>
             must be called two times. The first time is after the user submits the HTML form with the
             must be called two times. The first time is after the user submits the HTML form with the
-            <varname>$_POST['openid_action']</varname> set to <code>"login"</code>,
+            <varname>$_POST['openid_action']</varname> set to <emphasis>"login"</emphasis>,
             and the second time is after the HTTP redirection from OpenID server with
             and the second time is after the HTTP redirection from OpenID server with
             <varname>$_GET['openid_mode']</varname> or <varname>$_POST['openid_mode']</varname>
             <varname>$_GET['openid_mode']</varname> or <varname>$_POST['openid_mode']</varname>
             set.
             set.