[DOCUMENTATION] English: manual fixes

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

documentation/manual/en/module_specs/Zend_Db_Select.xml

@@ -1251,8 +1251,7 @@ $sql2 = "SELECT ...";
 $select = $db->select()
     ->union(array($sql1, $sql2))
     ->order("id");
-]]>
-                </programlisting>
+]]></programlisting>
             </example>
         </sect3>
 

documentation/manual/en/module_specs/Zend_Dojo-View-Helpers.xml

@@ -663,7 +663,7 @@ echo $view->editor('foo');
 
                     <para>
                         The Editor dijit uses an <acronym>HTML</acronym> <acronym>DIV</acronym> by
-                        default.  The <classname>dijit._editor.RichText</classname> documentation
+                        default. The <classname>dijit._editor.RichText</classname> documentation
                         indicates that having it built on an HTML <acronym>TEXTAREA</acronym> can
                         potentially have security implications.
                     </para>

documentation/manual/en/module_specs/Zend_Feed_Reader.xml

@@ -440,25 +440,25 @@ foreach ($links as $link) {
         is a lazy loaded attempt - feeds are never loaded until you try to
         access them using this method.</para>
   </sect2>
-  
+
   <sect2 id="zend.feed.reader.attribute-collections">
         <title>Attribute Collections</title>
-        
+
         <para>In an attempt to simplify return types, with Zend Framework 1.10 return
         types from the various feed and entry level methods may include an object
         of type <classname>Zend_Feed_Reader_Collection_CollectionAbstract</classname>.
         Despite the special class name which I'll explain below, this is just a simple
         subclass of SPL's <classname>ArrayObject</classname>.</para>
-        
+
         <para>The main purpose here is to allow the presentation of as much data as possible
         from the requested elements, while still allowing access to the most relevant
         data as a simple array. This also enforces a standard approach to returning
         such data which previously may have wandered between arrays and objects.</para>
-        
+
         <para>The new class type acts identically to <classname>ArrayObject</classname>
         with the sole addition being a new method <methodname>getValues()</methodname>
         which returns a simple flat array containing the most relevant information.</para>
-        
+
         <para>A simple example of this is
         <methodname>Zend_Feed_Reader_FeedInterface::getCategories()</methodname>.
         When used with any RSS or Atom feed, this method will return category data as
@@ -468,10 +468,10 @@ foreach ($links as $link) {
         with URIs). The scheme represents a categorisation scheme (usually a URI identifier) also
         known as a "domain" in RSS 2.0. The "label" is a human readable category name which supports
         html entities.</para>
-        
+
         <para>To access category labels by themselves in a simple value array,
         you might commit to something like:</para>
-        
+
         <programlisting language="php"><![CDATA[
 $feed = Zend_Feed_Reader::import('http://www.example.com/atom.xml');
 $categories = $feed->getCategories();
@@ -483,14 +483,14 @@ foreach ($categories as $cat) {
 
     <para>It's a contrived example, but the point is that the labels are tied up with
     other information.</para>
-    
+
     <para>However, the container class allows you to access the "most relevant" data
     as a simple array using the <methodname>getValues()</methodname> method. The concept
     of "most relevant" is obviously a judgement call. For categories it means the category labels
     (not the terms or schemes) while for authors it would be the authors' names
     (not their email addresses or URLs). The simple array is flat (just values) and passed
     through <methodname>array_unique</methodname> to remove duplication.</para>
-    
+
     <programlisting language="php"><![CDATA[
 $feed = Zend_Feed_Reader::import('http://www.example.com/atom.xml');
 $categories = $feed->getCategories();
@@ -500,7 +500,7 @@ $labels = $categories->getValues();
     <para>The above example shows how to extract only labels and nothing else thus
     giving simple access to the category labels without any additional work to extract
     that data by itself.</para>
-        
+
   </sect2>
 
   <sect2 id="zend.feed.reader.retrieve-info">
@@ -664,7 +664,7 @@ $labels = $categories->getValues();
                             Protocol, allowing subscriptions to the feed for real-time updates.
                         </entry>
                     </row>
-                    
+
                     <row>
                         <entry><methodname>getCategories()</methodname></entry>
 
@@ -1006,7 +1006,7 @@ $labels = $categories->getValues();
                             Atom/<acronym>RSS</acronym> depending on current feed type).
                         </entry>
                     </row>
-                    
+
                     <row>
                         <entry><methodname>getCategories()</methodname></entry>
 

documentation/manual/en/module_specs/Zend_Http_Client-Advanced.xml

@@ -284,14 +284,14 @@ $client->setUri('http://christer:secret@example.com');
         <note>
             <title>Resetting parameters</title>
             <para>
-                Note that non-request specific headers are not reset by default 
-                when the <methodname>resetParameters()</methodname> method is used. 
+                Note that non-request specific headers are not reset by default
+                when the <methodname>resetParameters()</methodname> method is used.
                 Only the 'Content-length' and 'Content-type' headers are reset. This
                 allows you to set-and-forget headers like 'Accept-language' and
                 'Accept-encoding'
             </para>
             <para>
-            To clean all headers and other data except for URI and method, use 
+            To clean all headers and other data except for URI and method, use
             <methodname>resetParameters(true)</methodname>.
             </para>
         </note>
@@ -353,12 +353,12 @@ $_SESSION['cookiejar'] = $client->getCookieJar();
             By default, <classname>Zend_Http_Client</classname> accepts and returns data as PHP strings.
             However, in many cases there are big files to be sent or received, thus keeping them
             in memory might be unnecessary or too expensive. For these cases, <classname>Zend_Http_Client</classname>
-            supports reading data from files (and in general, PHP streams) and writing data to files (streams).  
+            supports reading data from files (and in general, PHP streams) and writing data to files (streams).
         </para>
         <para>
-        	In order to use stream to pass data to <classname>Zend_Http_Client</classname>, 
-        	use <methodname>setRawData()</methodname> method with data argument being stream resource
-        	(e.g., result of <methodname>fopen()</methodname>).
+            In order to use stream to pass data to <classname>Zend_Http_Client</classname>,
+            use <methodname>setRawData()</methodname> method with data argument being stream resource
+            (e.g., result of <methodname>fopen()</methodname>).
             <example id="zend.http.client.streaming.example-1">
                 <title>Sending file to HTTP server with streaming</title>
                 <programlisting language="php"><![CDATA[
@@ -371,24 +371,24 @@ $client->setRawData($fp, 'application/zip')->request('PUT');
         <para>
         Only PUT requests currently support sending streams to HTTP server.
         </para>
-        
+
         <para>
         In order to receive data from the server as stream, use <methodname>setStream()</methodname>.
-        Optional argument specifies the filename where the data will be stored. If the argument is just 
+        Optional argument specifies the filename where the data will be stored. If the argument is just
         TRUE (default), temporary file will be used and will be deleted once response object is destroyed.
-        Setting argument to FALSE disables the streaming functionality.  
+        Setting argument to FALSE disables the streaming functionality.
         </para>
-        
+
         <para>
         When using streaming, <methodname>request()</methodname> method will return object of class
         <classname>Zend_Http_Client_Response_Stream</classname>, which has two useful methods:
-        <methodname>getStreamName()</methodname> will return the name of the file where the response is stored, 
-        and <methodname>getStream()</methodname> will return stream from which the response could be read.   
+        <methodname>getStreamName()</methodname> will return the name of the file where the response is stored,
+        and <methodname>getStream()</methodname> will return stream from which the response could be read.
         </para>
-        
+
         <para>
-        You can either write the response to pre-defined file, or use temporary file for storing it and 
-        send it out or write it to another file using regular stream functions.  
+        You can either write the response to pre-defined file, or use temporary file for storing it and
+        send it out or write it to another file using regular stream functions.
         <example id="zend.http.client.streaming.example-2">
                 <title>Receiving file from HTTP server with streaming</title>
                 <programlisting language="php"><![CDATA[
@@ -405,6 +405,6 @@ $client->setStreaming("my/downloads/myfile)->request('GET');
 </programlisting>
             </example>
         </para>
-        
+
     </sect2>
 </sect1>

documentation/manual/en/module_specs/Zend_Mail-Introduction.xml

@@ -118,10 +118,10 @@ $mail->send();
             <title>Sendmail Transport and Windows</title>
 
             <para>
-                As the PHP manual states the <code>mail()</code> function has different
+                As the PHP manual states the <methodname>mail()</methodname> function has different
                 behaviour on Windows and on *nix based systems. Using the Sendmail
                 Transport on Windows will not work in combination with <methodname>addBcc()</methodname>.
-                The <code>mail()</code> function will sent to the BCC recipient such
+                The <methodname>mail()</methodname> function will sent to the BCC recipient such
                 that all the other recipients can see him as recipient!
             </para>
 

documentation/manual/en/module_specs/Zend_Paginator-Usage.xml

@@ -178,7 +178,7 @@ $this->view->paginator = $paginator;
         <para>
             To use the DbSelect and DbTableSelect adapters you don't have to retrieve the data upfront from
             the database. Both adapters do the retrieval for you, aswell as the counting of the total pages.
-            If additional work has to be done on the database results the adapter <code>getItems()</code> method
+            If additional work has to be done on the database results the adapter <methodname>getItems()</methodname> method
             has to be extended in your application.
         </para>
 

documentation/manual/en/module_specs/Zend_Service_Amazon_S3.xml

@@ -373,17 +373,17 @@ foreach($list as $name) {
        </itemizedlist>
     </sect2>
     <sect2 id="zend.service.amazon.s3.streaming">
-    	<title>Data Streaming</title>
-    	<para>
-    	It is possible to get and put objects using not stream data held in memory but files or PHP streams.
-    	This is especially useful when file sizes are large in order not to overcome memory limits. 
-    	</para>
-    	<para>
-    	To receive object using streaming, use method <methodname>getObjectStream($object, $filename)</methodname>. This method
-    	will return <classname>Zend_Http_Response_Stream</classname>, which can be used as described in 
-    	<link linkend="zend.http.client.streaming">HTTP Client Data Streaming</link> section.  
-    	<example id="zend.service.amazon.s3.streaming.example1">
-    	<title>Zend_Service_Amazon_S3 Data Streaming Example</title>
+        <title>Data Streaming</title>
+        <para>
+        It is possible to get and put objects using not stream data held in memory but files or PHP streams.
+        This is especially useful when file sizes are large in order not to overcome memory limits.
+        </para>
+        <para>
+        To receive object using streaming, use method <methodname>getObjectStream($object, $filename)</methodname>. This method
+        will return <classname>Zend_Http_Response_Stream</classname>, which can be used as described in
+        <link linkend="zend.http.client.streaming">HTTP Client Data Streaming</link> section.
+        <example id="zend.service.amazon.s3.streaming.example1">
+        <title>Zend_Service_Amazon_S3 Data Streaming Example</title>
              <programlisting language="php"><![CDATA[
 $response = $amazon->getObjectStream("mybycket/zftest");
 // copy file
@@ -392,22 +392,22 @@ copy($response->getStreamName(), "my/downloads/file");
 $fp = fopen("my/downloads/file2", "w");
 stream_copy_to_stream($response->getStream(), $fp);
 ]]></programlisting>
-		</example>
-    	</para>
-    	<para>Second parameter for <methodname>getObjectStream()</methodname> is optional and specifies target file
-    	 to write the data. If not specified, temporary file is used, which will be deleted after 
-    	 the respons eobject is destroyed.
-    	 </para>
-    	 
-    	 <para>
-    	 To send object using streaming, use <methodname>putFileStream()</methodname> which has the same signature as
-    	 <methodname>putFile()</methodname> but will use streaming and not read the file into memory.
-    	 </para>
-    	 
-    	 <para>
-    	 Also, you can pass stream resource to <methodname>putObject()</methodname> method data parameter,
-    	 in which case the data will be read from the stream when sending the request to the server. 
-    	 </para>
+        </example>
+        </para>
+        <para>Second parameter for <methodname>getObjectStream()</methodname> is optional and specifies target file
+         to write the data. If not specified, temporary file is used, which will be deleted after
+         the respons eobject is destroyed.
+         </para>
+
+         <para>
+         To send object using streaming, use <methodname>putFileStream()</methodname> which has the same signature as
+         <methodname>putFile()</methodname> but will use streaming and not read the file into memory.
+         </para>
+
+         <para>
+         Also, you can pass stream resource to <methodname>putObject()</methodname> method data parameter,
+         in which case the data will be read from the stream when sending the request to the server.
+         </para>
     </sect2>
     <sect2 id="zend.service.amazon.s3.streams">
         <title>Stream wrapper</title>

documentation/manual/en/module_specs/Zend_Service_LiveDocx.xml

@@ -588,7 +588,7 @@ file_put_contents('document.pdf', $document);
             <para>
                 <varname>$fromPage</varname> is the lower-bound page number of the page range that
                 should be returned as an image and <varname>$toPage</varname> the upper-bound page
-                number.  <varname>$zoomFactor</varname> is the size of the images, as a percent,
+                number. <varname>$zoomFactor</varname> is the size of the images, as a percent,
                 relative to the original page size. The range of this parameter is 10 to 400.
                 <varname>$format</varname> is the format of the images returned by this method. The
                 supported formats can be obtained by calling

documentation/manual/en/module_specs/Zend_Test-PHPUnit-Db-Adapter.xml

@@ -73,8 +73,7 @@ $stmt = $adapter->query("SELECT * FROM bugs");
 $qp = $adapter->getProfiler()->getLastQueryProfile();
 
 echo $qp->getQuerY(); // SELECT * FROM bugs
-]]>
-    </programlisting>
+]]></programlisting>
 
     <para>
         The test adapter never checks if the query specified is really of the type SELECT, DELETE,

documentation/manual/en/module_specs/Zend_Test-PHPUnit-Testing.xml

@@ -84,7 +84,7 @@ class FooControllerTest extends Zend_Test_PHPUnit_ControllerTestCase
 
         <important>
             <para>
-                The redirect action helper issues an <code>exit()</code> statement
+                The redirect action helper issues an <methodname>exit()</methodname> statement
                 when using the method <methodname>gotoAndExit()</methodname>
                 and will then obviously also stops a test running for this method.
                 For testability of your application dont use that method on the
@@ -116,13 +116,12 @@ class MyController extends Zend_Controller_Action
         // do some stuff here
     }
 }
-]]>
-        </programlisting>
+]]></programlisting>
 
         <important>
             <para>
-                Depending on your application this is not enough as additional action, <code>preDispatch()</code> or
-                <code>postDispatch()</code> logic might be executed. This cannot be handled in a good way with
+                Depending on your application this is not enough as additional action, <methodname>preDispatch()</methodname> or
+                <methodname>postDispatch()</methodname> logic might be executed. This cannot be handled in a good way with
                 Zend Test currently.
             </para>
         </important>

documentation/manual/en/module_specs/Zend_Tool_Framework-WritingProviders.xml

@@ -71,7 +71,7 @@
                 with a special filename ending with "Manifest.php".
                 A Provider Manifest is an implementation of the
                 <interface>Zend_Tool_Framework_Manifest_ProviderManifestable</interface>
-                and requires the <code>getProviders()</code> method to return
+                and requires the <methodname>getProviders()</methodname> method to return
                 an array of instantiated providers. In anticipation of our first
                 own provider <classname>My_Component_HelloProvider</classname>
                 we will create the following manifest:
@@ -87,8 +87,8 @@
             );
         }
     }
-    ]]>
-            </programlisting>
+
+]]></programlisting>
 
         </example>
     </sect2>
@@ -150,8 +150,7 @@ class My_Component_HelloProvider
         $this->_registry->getResponse()->appendContent("Hello from my provider!");
     }
 }
-]]>
-        </programlisting>
+]]></programlisting>
 
         <para>
             As you can see one has to extend the <classname>Zend_Tool_Framework_Provider_Abstract</classname>
@@ -227,8 +226,7 @@ class My_Component_HelloProvider
         echo 'Hello' . $name . ', from my provider!';
     }
 }
-]]>
-            </programlisting>
+]]></programlisting>
 
             <para>
                 This command throws an exception if the current client is not
@@ -310,8 +308,7 @@ class My_Component_HelloProvider
         }
     }
 }
-]]>
-            </programlisting>
+]]></programlisting>
         </sect3>
 
         <sect3 id="zend.tool.framework.writing-providers.advanced.configstorage">
@@ -339,8 +336,7 @@ class My_Component_HelloProvider
         }
     }
 }
-]]>
-            </programlisting>
+]]></programlisting>
 
             <para>
                 The returned configuration is of the type <classname>Zend_Tool_Framework_Client_Config</classname>
@@ -364,8 +360,7 @@ class My_Component_HelloProvider
         echo "Hello $aValue!";
     }
 }
-]]>
-            </programlisting>
+]]></programlisting>
 
             <para>
                 The API of the storage is very simple:
@@ -382,8 +377,7 @@ class Zend_Tool_Framework_Client_Storage
     public function remove($name);
     public function getStreamUri($name);
 }
-]]>
-            </programlisting>
+]]></programlisting>
 
             <important>
                 <para>