Browse Source

[MANUAL] English:

- several manual fixes

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@22757 44c647ce-9c0f-0410-b52a-842ac1e357ba
thomas 15 years ago
parent
commit
099ba066b2

+ 3 - 3
documentation/manual/en/module_specs/Zend_OpenId-Consumer.xml

@@ -712,10 +712,10 @@ if ($consumer->verify($_GET, $id, $sreg)) {
             Zend Framework provides a special class to support user
             Zend Framework provides a special class to support user
             authentication: <classname>Zend_Auth</classname>. This class can be used together
             authentication: <classname>Zend_Auth</classname>. This class can be used together
             with <classname>Zend_OpenId_Consumer</classname>. The following example shows how
             with <classname>Zend_OpenId_Consumer</classname>. The following example shows how
-            <code>OpenIdAdapter</code> implements
+            <classname>OpenIdAdapter</classname> implements
             the <classname>Zend_Auth_Adapter_Interface</classname> with the
             the <classname>Zend_Auth_Adapter_Interface</classname> with the
-            <code>authenticate</code> method. This performs an authentication query and
-            verification.
+            <methodname>authenticate()</methodname> method. This performs an authentication query
+            and verification.
         </para>
         </para>
 
 
         <para>
         <para>

+ 3 - 3
documentation/manual/en/module_specs/Zend_OpenId-Provider.xml

@@ -17,7 +17,7 @@
         <para>
         <para>
             The following example includes code for creating a user account
             The following example includes code for creating a user account
             using <classname>Zend_OpenId_Provider::register</classname>. The link element with
             using <classname>Zend_OpenId_Provider::register</classname>. The link element with
-            <code>rel="openid.server"</code> points to our own server script. If you
+            <command>rel="openid.server"</command> points to our own server script. If you
             submit this identity to an OpenID-enabled site, it will perform
             submit this identity to an OpenID-enabled site, it will perform
             authentication on this server.
             authentication on this server.
         </para>
         </para>
@@ -300,8 +300,8 @@ if ($_SERVER['REQUEST_METHOD'] == 'GET' &&
             If you compare this example with previous examples split in to
             If you compare this example with previous examples split in to
             separate pages, you will see only the one
             separate pages, you will see only the one
             difference besides the dispatch code:
             difference besides the dispatch code:
-            <methodname>unset($_GET['openid_action'])</methodname>. This call to <code>unset</code>
-            is necessary to route the next request to main handler.
+            <methodname>unset($_GET['openid_action'])</methodname>. This call to
+            <methodname>unset()</methodname> is necessary to route the next request to main handler.
         </para>
         </para>
     </sect2>
     </sect2>
 
 

+ 3 - 3
documentation/manual/en/module_specs/Zend_Paginator-Advanced.xml

@@ -37,7 +37,7 @@
 
 
         <para>
         <para>
             If you've ever used the SPL interface <ulink
             If you've ever used the SPL interface <ulink
-                url="http://www.php.net/~helly/php/ext/spl/interfaceCountable.html"><code>Countable</code></ulink>,
+                url="http://www.php.net/~helly/php/ext/spl/interfaceCountable.html">Countable</ulink>,
             you're familiar with <methodname>count()</methodname>. As used with
             you're familiar with <methodname>count()</methodname>. As used with
             <classname>Zend_Paginator</classname>, this is the total number of items
             <classname>Zend_Paginator</classname>, this is the total number of items
             in the data collection.
             in the data collection.
@@ -234,8 +234,8 @@ interface Zend_Paginator_AdapterAggregate
         <para>
         <para>
             The interface is fairly small and only expects you to return an instance of
             The interface is fairly small and only expects you to return an instance of
             <classname>Zend_Paginator_Adapter_Abstract</classname>. An Adapter Aggregate instance is
             <classname>Zend_Paginator_Adapter_Abstract</classname>. An Adapter Aggregate instance is
-            then recognized by both <code>Zend_Paginator::factory</code> and the constructor of
-            <classname>Zend_Paginator</classname> and handled accordingly.
+            then recognized by both <methodname>Zend_Paginator::factory()</methodname> and the
+            constructor of <classname>Zend_Paginator</classname> and handled accordingly.
         </para>
         </para>
     </sect2>
     </sect2>
 </sect1>
 </sect1>

+ 3 - 3
documentation/manual/en/module_specs/Zend_ProgressBar_Adapter_JsPull.xml

@@ -11,13 +11,13 @@
         the adapter sends a <acronym>JSON</acronym> string to the browser, which looks exactly
         the adapter sends a <acronym>JSON</acronym> string to the browser, which looks exactly
         like the <acronym>JSON</acronym> string which is send by the jsPush adapter. The only
         like the <acronym>JSON</acronym> string which is send by the jsPush adapter. The only
         difference is, that it contains an additional parameter,
         difference is, that it contains an additional parameter,
-        <code>finished</code>, which is either <constant>FALSE</constant> when
+        <property>finished</property>, which is either <constant>FALSE</constant> when
         <methodname>update()</methodname> is called or <constant>TRUE</constant>, when
         <methodname>update()</methodname> is called or <constant>TRUE</constant>, when
         <methodname>finish()</methodname> is called.
         <methodname>finish()</methodname> is called.
     </para>
     </para>
 
 
     <para>
     <para>
-        You can set the adapter options either via the <code>set*</code> methods
+        You can set the adapter options either via the <methodname>set*()</methodname> methods
         or give an array or a <classname>Zend_Config</classname> instance with options as first
         or give an array or a <classname>Zend_Config</classname> instance with options as first
         parameter to the constructor. The available options are:
         parameter to the constructor. The available options are:
     </para>
     </para>
@@ -25,7 +25,7 @@
     <itemizedlist>
     <itemizedlist>
         <listitem>
         <listitem>
             <para>
             <para>
-                <code>exitAfterSend</code>: Exits the current request after the
+                <property>exitAfterSend</property>: Exits the current request after the
                 data were send to the browser. Default is <constant>TRUE</constant>.
                 data were send to the browser. Default is <constant>TRUE</constant>.
             </para>
             </para>
         </listitem>
         </listitem>

+ 5 - 5
documentation/manual/en/module_specs/Zend_Search_Lucene-BestPractice.xml

@@ -12,15 +12,15 @@
 
 
         <para>
         <para>
             Nevertheless it's a good idea not to use '<emphasis>id</emphasis>' and
             Nevertheless it's a good idea not to use '<emphasis>id</emphasis>' and
-            '<emphasis>score</emphasis>' names to avoid ambiguity in <code>QueryHit</code>
+            '<emphasis>score</emphasis>' names to avoid ambiguity in <classname>QueryHit</classname>
             properties names.
             properties names.
         </para>
         </para>
 
 
         <para>
         <para>
-            The <classname>Zend_Search_Lucene_Search_QueryHit</classname> <code>id</code> and
-            <code>score</code> properties always refer to internal Lucene document id and hit <link
-                linkend="zend.search.lucene.searching.results-scoring">score</link>. If the indexed
-            document has the same stored fields, you have to use the
+            The <classname>Zend_Search_Lucene_Search_QueryHit</classname> <property>id</property>
+            and <property>score</property> properties always refer to internal Lucene document id
+            and hit <link linkend="zend.search.lucene.searching.results-scoring">score</link>. If
+            the indexed document has the same stored fields, you have to use the
             <methodname>getDocument()</methodname> method to access them:
             <methodname>getDocument()</methodname> method to access them:
         </para>
         </para>
 
 

+ 10 - 8
documentation/manual/en/module_specs/Zend_Search_Lucene-QueryLanguage.xml

@@ -171,17 +171,19 @@ test*
             <footnote>
             <footnote>
                 <para>
                 <para>
                     Please note, that it's not a
                     Please note, that it's not a
-                    <code>Zend_Search_Lucene_Search_QueryParserException</code>, but a
-                    <code>Zend_Search_Lucene_Exception</code>. It's thrown during query rewrite
-                    (execution) operation.
+                    <classname>Zend_Search_Lucene_Search_QueryParserException</classname>, but a
+                    <classname>Zend_Search_Lucene_Exception</classname>. It's thrown during query
+                    rewrite (execution) operation.
                 </para>
                 </para>
             </footnote>.
             </footnote>.
         </para>
         </para>
 
 
         <para>
         <para>
             It can be altered using
             It can be altered using
-            <code>Zend_Search_Lucene_Search_Query_Wildcard::getMinPrefixLength()</code> and
-            <code>Zend_Search_Lucene_Search_Query_Wildcard::setMinPrefixLength()</code> methods.
+            <methodname>Zend_Search_Lucene_Search_Query_Wildcard::getMinPrefixLength()</methodname>
+            and
+            <methodname>Zend_Search_Lucene_Search_Query_Wildcard::setMinPrefixLength()</methodname>
+            methods.
         </para>
         </para>
     </sect2>
     </sect2>
 
 
@@ -282,8 +284,8 @@ roam~0.8
         <para>
         <para>
             So <classname>Zend_Search_Lucene</classname> sets a limit of matching terms per query
             So <classname>Zend_Search_Lucene</classname> sets a limit of matching terms per query
             (subquery). This limit can be retrieved and set using
             (subquery). This limit can be retrieved and set using
-            <code>Zend_Search_Lucene::getTermsPerQueryLimit()</code>/<code>Zend_Search_Lucene::setTermsPerQueryLimit($limit)</code>
-            methods.
+            <methodname>Zend_Search_Lucene::getTermsPerQueryLimit()</methodname> and
+            <methodname>Zend_Search_Lucene::setTermsPerQueryLimit($limit)</methodname> methods.
         </para>
         </para>
 
 
         <para>
         <para>
@@ -478,7 +480,7 @@ PHP^4 framework
             </para>
             </para>
 
 
             <para>
             <para>
-                This is set to <code>OR</code> by default.
+                This is set to 'OR' by default.
             </para>
             </para>
 
 
             <para>
             <para>