[MANUAL] English:

- structural fixes (no translations needed)

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

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

@@ -23,21 +23,26 @@
                         <entry>Description</entry>
                     </row>
                 </thead>
+
                 <tbody>
                     <row>
                         <entry>Array</entry>
                         <entry>Use a <acronym>PHP</acronym> array</entry>
                     </row>
+
                     <row>
                         <entry>DbSelect</entry>
+
                         <entry>
                             Use a <link
                                 linkend="zend.db.select"><classname>Zend_Db_Select</classname></link>
                             instance, which will return an array
                         </entry>
                     </row>
+
                     <row>
                         <entry>DbTableSelect</entry>
+
                         <entry>
                             Use a <link
                                 linkend="zend.db.table.fetch-all"><classname>Zend_Db_Table_Select</classname></link>
@@ -47,16 +52,20 @@
                             result set, such as column names.
                         </entry>
                     </row>
+
                     <row>
                         <entry>Iterator</entry>
+
                         <entry>
                             Use an <ulink
                                 url="http://www.php.net/~helly/php/ext/spl/interfaceIterator.html"><classname>Iterator</classname></ulink>
                             instance
                         </entry>
                     </row>
+
                     <row>
                         <entry>Null</entry>
+
                         <entry>
                             Do not use <classname>Zend_Paginator</classname> to manage
                             data pagination. You can still take advantage of
@@ -169,6 +178,7 @@ $this->view->paginator = $paginator;
 
     <sect2 id="zend.paginator.usage.dbselect">
         <title>The DbSelect and DbTableSelect adapter</title>
+
         <para>
             The usage of most adapters is pretty straight-forward. However, the
             database adapters require a more detailed explanation regarding
@@ -176,18 +186,19 @@ $this->view->paginator = $paginator;
         </para>
 
         <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 <methodname>getItems()</methodname> method
-            has to be extended in your application.
+            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 <methodname>getItems()</methodname> method has to be extended in your
+            application.
         </para>
 
         <para>
-            Additionally these adapters do <emphasis>not</emphasis> fetch all records from the database
-            in order to count them. Instead, the adapters manipulates the original query to produce
-            the corresponding COUNT query. Paginator then executes that COUNT query to get the
-            number of rows. This does require an extra round-trip to the database, but this is many
-            times faster than fetching an entire result set and using
+            Additionally these adapters do <emphasis>not</emphasis> fetch all records from the
+            database in order to count them. Instead, the adapters manipulates the original query to
+            produce the corresponding COUNT query. Paginator then executes that COUNT query to get
+            the number of rows. This does require an extra round-trip to the database, but this is
+            many times faster than fetching an entire result set and using
             <methodname>count()</methodname>. Especially with large collections of data.
         </para>
 
@@ -302,9 +313,11 @@ $paginator = new Zend_Paginator($adapter);
                         <entry>Description</entry>
                     </row>
                 </thead>
+
                 <tbody>
                     <row>
                         <entry>All</entry>
+
                         <entry>
                             Returns every page. This is useful for dropdown
                             menu pagination controls with relatively few
@@ -312,23 +325,29 @@ $paginator = new Zend_Paginator($adapter);
                             available to the user at once.
                         </entry>
                     </row>
+
                     <row>
                         <entry>Elastic</entry>
+
                         <entry>
                             A Google-like scrolling style that expands and
                             contracts as a user scrolls through the pages.
                         </entry>
                     </row>
+
                     <row>
                         <entry>Jumping</entry>
+
                         <entry>
                             As users scroll through, the page number advances
                             to the end of a given range, then starts again at
                             the beginning of the new range.
                         </entry>
                     </row>
+
                     <row>
                         <entry>Sliding</entry>
+
                         <entry>
                             A Yahoo!-like scrolling style that positions the
                             current page number in the center of the page
@@ -543,84 +562,86 @@ $('paginationControl').observe('change', function() {
                             <entry>Description</entry>
                         </row>
                     </thead>
+
                     <tbody>
                         <row>
                             <entry>first</entry>
                             <entry>integer</entry>
                             <entry>First page number (i.e., 1)</entry>
                         </row>
+
                         <row>
                             <entry>firstItemNumber</entry>
                             <entry>integer</entry>
-                            <entry>
-                                Absolute number of the first item on this page
-                            </entry>
+                            <entry>Absolute number of the first item on this page</entry>
                         </row>
+
                         <row>
                             <entry>firstPageInRange</entry>
                             <entry>integer</entry>
-                            <entry>
-                                First page in the range returned by the
-                                scrolling style
-                            </entry>
+                            <entry>First page in the range returned by the scrolling style</entry>
                         </row>
+
                         <row>
                             <entry>current</entry>
                             <entry>integer</entry>
                             <entry>Current page number</entry>
                         </row>
+
                         <row>
                             <entry>currentItemCount</entry>
                             <entry>integer</entry>
                             <entry>Number of items on this page</entry>
                         </row>
+
                         <row>
                             <entry>itemCountPerPage</entry>
                             <entry>integer</entry>
                             <entry>Maximum number of items available to each page</entry>
                         </row>
+
                         <row>
                             <entry>last</entry>
                             <entry>integer</entry>
                             <entry>Last page number</entry>
                         </row>
+
                         <row>
                             <entry>lastItemNumber</entry>
                             <entry>integer</entry>
-                            <entry>
-                                Absolute number of the last item on this page
-                            </entry>
+                            <entry>Absolute number of the last item on this page</entry>
                         </row>
+
                         <row>
                             <entry>lastPageInRange</entry>
                             <entry>integer</entry>
-                            <entry>
-                                Last page in the range returned by the
-                                scrolling style
-                            </entry>
+                            <entry>Last page in the range returned by the scrolling style</entry>
                         </row>
+
                         <row>
                             <entry>next</entry>
                             <entry>integer</entry>
                             <entry>Next page number</entry>
                         </row>
+
                         <row>
                             <entry>pageCount</entry>
                             <entry>integer</entry>
                             <entry>Number of pages</entry>
                         </row>
+
                         <row>
                             <entry>pagesInRange</entry>
                             <entry>array</entry>
-                            <entry>
-                                Array of pages returned by the scrolling style
-                            </entry>
+                            <entry>Array of pages returned by the scrolling style</entry>
                         </row>
+
                         <row>
                             <entry>previous</entry>
                             <entry>integer</entry>
                             <entry>Previous page number</entry>
                         </row>
+
                         <row>
                             <entry>totalItemCount</entry>
                             <entry>integer</entry>

documentation/manual/en/module_specs/Zend_Pdf-Create.xml

@@ -2,23 +2,28 @@
 <!-- Reviewed: no -->
 <sect1 id="zend.pdf.create">
     <title>Creating and Loading PDF Documents</title>
+
     <para>
-    The <classname>Zend_Pdf</classname> class represents <acronym>PDF</acronym> documents and provides document-level
-    operations.
+        The <classname>Zend_Pdf</classname> class represents <acronym>PDF</acronym> documents and
+        provides document-level operations.
     </para>
 
     <para>
-    To create a new document, a new <classname>Zend_Pdf</classname> object should first be created.
+        To create a new document, a new <classname>Zend_Pdf</classname> object should first be
+        created.
     </para>
 
     <para>
-    <classname>Zend_Pdf</classname> class also provides two static methods to load an existing <acronym>PDF</acronym> document.
-    These are the <methodname>Zend_Pdf::load()</methodname> and <methodname>Zend_Pdf::parse()</methodname> methods.
-    Both of them return <classname>Zend_Pdf</classname> objects as a result or throw an exception if an error occurs.
+        <classname>Zend_Pdf</classname> class also provides two static methods to load an existing
+        <acronym>PDF</acronym> document. These are the <methodname>Zend_Pdf::load()</methodname> and
+        <methodname>Zend_Pdf::parse()</methodname> methods. Both of them return
+        <classname>Zend_Pdf</classname> objects as a result or throw an exception if an error
+        occurs.
     </para>
 
     <example id="zend.pdf.create.example-1">
         <title>Create new or load existing PDF document</title>
+
         <programlisting language="php"><![CDATA[
 ...
 // Create a new PDF document
@@ -34,24 +39,29 @@ $pdf3 = Zend_Pdf::parse($pdfString);
     </example>
 
     <para>
-    The <acronym>PDF</acronym> file format supports incremental document update. Thus each time a document
-    is updated, then a new revision of the document is created.
-    <classname>Zend_Pdf</classname> component supports the retrieval of a specified revision.
+        The <acronym>PDF</acronym> file format supports incremental document update. Thus each time
+        a document is updated, then a new revision of the document is created.
+        <classname>Zend_Pdf</classname> component supports the retrieval of a specified revision.
     </para>
+
     <para>
-    A revision can be specified as a second parameter to the <methodname>Zend_Pdf::load()</methodname> and
-    <methodname>Zend_Pdf::parse()</methodname> methods or requested by calling the <methodname>Zend_Pdf::rollback()</methodname> method.
+        A revision can be specified as a second parameter to the
+        <methodname>Zend_Pdf::load()</methodname> and <methodname>Zend_Pdf::parse()</methodname>
+        methods or requested by calling the <methodname>Zend_Pdf::rollback()</methodname> method.
+
         <footnote>
             <para>
-            <methodname>Zend_Pdf::rollback()</methodname> method must be invoked before any changes are applied to the document,
-            otherwise the behavior is not defined.
+                <methodname>Zend_Pdf::rollback()</methodname> method must be invoked before any
+                changes are applied to the document, otherwise the behavior is not defined.
             </para>
         </footnote>
-    call.
+
+        call.
     </para>
 
     <example id="zend.pdf.create.example-2">
         <title>Requesting Specific Revisions of a PDF Document</title>
+
         <programlisting language="php"><![CDATA[
 ...
 // Load the previous revision of the PDF document
@@ -67,7 +77,6 @@ $pdf3->rollback($revisions - 1);
 ...
 ]]></programlisting>
     </example>
-
 </sect1>
 <!--
 vim:se ts=4 sw=4 et:

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

@@ -3,67 +3,81 @@
 <sect1 id="zend.pdf.introduction">
     <!-- @todo review and revise upon completion of refactoring -->
     <title>Introduction</title>
+
     <para>
-    The <classname>Zend_Pdf</classname> component is a <acronym>PDF</acronym> (Portable Document Format) manipulation engine.
-    It can load, create, modify and save documents.
-    Thus it can help any <acronym>PHP</acronym> application dynamically create <acronym>PDF</acronym> documents by modifying existing documents or generating new ones from scratch.
+        The <classname>Zend_Pdf</classname> component is a <acronym>PDF</acronym> (Portable Document
+        Format) manipulation engine. It can load, create, modify and save documents. Thus it can
+        help any <acronym>PHP</acronym> application dynamically create <acronym>PDF</acronym>
+        documents by modifying existing documents or generating new ones from scratch.
+        <classname>Zend_Pdf</classname> offers the following features:
+
+        <itemizedlist>
+            <listitem>
+                <para>
+                    Create a new document or load existing one.
+
+                    <footnote>
+                        <para>
+                            Loading <acronym>PDF</acronym> V1.4 (Acrobat 5) documents is now
+                            supported.
+                        </para>
+                    </footnote>
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    Retrieve a specified revision of the document.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    Manipulate pages within a document. Change page order, add new pages, remove
+                    pages from a document.
+                </para>
+            </listitem>
 
-    <classname>Zend_Pdf</classname> offers the following features:
-    <itemizedlist>
-        <listitem>
-            <para>
-            Create a new document or load existing one.
-            <footnote>
+            <listitem>
                 <para>
-                Loading <acronym>PDF</acronym> V1.4 (Acrobat 5) documents is now supported.
+                    Different drawing primitives (lines, rectangles, polygons, circles, ellipses and
+                    sectors).
                 </para>
-            </footnote>
-            </para>
-        </listitem>
-        <listitem>
-            <para>
-            Retrieve a specified revision of the document.
-            </para>
-        </listitem>
-        <listitem>
-            <para>
-            Manipulate pages within a document. Change page order, add new pages, remove pages
-            from a document.
-            </para>
-        </listitem>
-        <listitem>
-            <para>
-            Different drawing primitives (lines, rectangles, polygons, circles, ellipses and sectors).
-            </para>
-        </listitem>
-        <listitem>
-            <para>
-            Text drawing using any of the 14 standard (built-in) fonts or your own custom TrueType fonts.
-            </para>
-        </listitem>
-        <listitem>
-            <para>
-            Rotations.
-            </para>
-        </listitem>
-        <listitem>
-            <para>
-            Image drawing.
-            <footnote>
+            </listitem>
+
+            <listitem>
+                <para>
+                    Text drawing using any of the 14 standard (built-in) fonts or your own custom
+                    TrueType fonts.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    Rotations.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    Image drawing.
+
+                    <footnote>
+                        <para>
+                            JPG, PNG [Up to 8bit per channel+Alpha] and TIFF images are supported.
+                        </para>
+                    </footnote>
+                </para>
+            </listitem>
+
+            <listitem>
                 <para>
-                JPG, PNG [Up to 8bit per channel+Alpha] and TIFF images are supported.
+                    Incremental <acronym>PDF</acronym> file update.
                 </para>
-            </footnote>
-            </para>
-        </listitem>
-        <listitem>
-            <para>
-            Incremental <acronym>PDF</acronym> file update.
-            </para>
-        </listitem>
-    </itemizedlist>
+            </listitem>
+        </itemizedlist>
     </para>
 </sect1>
 <!--
 vim:se ts=4 sw=4 et:
--->
+-->

documentation/manual/en/module_specs/Zend_Pdf-Save.xml

@@ -25,6 +25,7 @@
 
     <example id="zend.pdf.save.example-1">
         <title>Saving PDF Documents</title>
+
         <programlisting language="php"><![CDATA[
 ...
 // Load the PDF document
@@ -41,7 +42,6 @@ $pdfString = $pdf->render();
 ...
 ]]></programlisting>
     </example>
-
 </sect1>
 <!--
 vim:se ts=4 sw=4 et:

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

@@ -2,20 +2,23 @@
 <!-- Reviewed: no -->
 <sect1 id="zend.pdf.usage">
     <title>Zend_Pdf module usage example</title>
+
     <para>
-    This section provides an example of module usage.
+        This section provides an example of module usage.
     </para>
 
     <para>
-    This example can be found in a <filename>demos/Zend/Pdf/demo.php</filename> file.
+        This example can be found in a <filename>demos/Zend/Pdf/demo.php</filename> file.
     </para>
+
     <para>
-    There are also <filename>test.pdf</filename> file, which can be used with this demo
-    for test purposes.
+        There are also <filename>test.pdf</filename> file, which can be used with this demo
+        for test purposes.
     </para>
 
     <example id="zend.pdf.usage.example-1">
         <title>Zend_Pdf module usage demo</title>
+
         <programlisting language="php"><![CDATA[
 /**
  * @package Zend_Pdf
@@ -263,7 +266,6 @@ if (isset($argv[2])) {
 }
 ]]></programlisting>
     </example>
-
 </sect1>
 <!--
 vim:se ts=4 sw=4 et:

documentation/manual/en/module_specs/Zend_ProgressBar_Adapter_JsPush.xml

@@ -2,6 +2,7 @@
 <!-- Reviewed: no -->
 <sect3 id="zend.progressbar.adapter.jspush">
     <title>Zend_ProgressBar_Adapter_JsPush</title>
+
     <para>
         <classname>Zend_ProgressBar_Adapter_JsPush</classname> is an adapter which let's
         you update a progressbar in a browser via Javascript Push. This means
@@ -9,11 +10,13 @@
         running process, but that the process itself sends its status directly
         to the browser.
     </para>
+
     <para>
         You can set the adapter options either via the <code>set*</code> methods
         or give an array or a <classname>Zend_Config</classname> instance with options as first
         parameter to the constructor. The available options are:
     </para>
+
     <itemizedlist>
         <listitem>
             <para>
@@ -22,6 +25,7 @@
                 <classname>Zend_ProgressBar_Update</classname>.
             </para>
         </listitem>
+
         <listitem>
             <para>
                 <code>finishMethodName</code>: The javascript method which
@@ -30,6 +34,7 @@
             </para>
         </listitem>
     </itemizedlist>
+
     <para>
         The usage of this adapter is quite simple. First you create a progressbar
         in your browser, either with JavaScript or previously created with plain
@@ -40,45 +45,53 @@
         running, the adapter will call the update method on every update with
         a json object, containing the following parameters:
     </para>
+
     <itemizedlist>
         <listitem>
             <para>
                 <code>current</code>: The current absolute value
             </para>
         </listitem>
+
         <listitem>
             <para>
                 <code>max</code>: The max absolute value
             </para>
         </listitem>
+
         <listitem>
             <para>
                 <code>percent</code>: The calculated percentage
             </para>
         </listitem>
+
         <listitem>
             <para>
                 <code>timeTaken</code>: The time how long the process ran yet
             </para>
         </listitem>
+
         <listitem>
             <para>
-                <code>timeRemaining</code>: The expected time for the process to
-                finish
+                <code>timeRemaining</code>: The expected time for the process to finish
             </para>
         </listitem>
+
         <listitem>
             <para>
                 <code>text</code>: The optional status message, if given
             </para>
         </listitem>
     </itemizedlist>
+
     <example id="zend.progressbar-adapter.jspush.example">
         <title>Basic example for the client-side stuff</title>
+
         <para>
             This example illustrates a basic setup of HTML, <acronym>CSS</acronym> and JavaScript
             for the JsPush adapter
         </para>
+
         <programlisting language="html"><![CDATA[
 <div id="zend-progressbar-container">
     <div id="zend-progressbar-done"></div>
@@ -86,6 +99,7 @@
 
 <iframe src="long-running-process.php" id="long-running-process"></iframe>
 ]]></programlisting>
+
         <programlisting language="css"><![CDATA[
 #long-running-process {
     position: absolute;
@@ -111,6 +125,7 @@
     background-color: #000000;
 }
 ]]></programlisting>
+
         <programlisting language="javascript"><![CDATA[
 function Zend_ProgressBar_Update(data)
 {
@@ -124,28 +139,44 @@ function Zend_ProgressBar_Update(data)
             the <code>iframe</code> or <code>object</code> by <code>display: none;</code>,
             as some browsers like Safari 2 will not load the actual content then.
         </para>
+
         <para>
             Instead of creating your custom progressbar, you may want to use
             one of the available JavaScript libraries like Dojo, jQuery etc.
             For example, there are:
         </para>
+
         <itemizedlist>
             <listitem>
-                <para>Dojo: <ulink url="http://dojotoolkit.org/book/dojo-book-0-9/part-2-dijit/user-assistance-and-feedback/progress-bar" /></para>
+                <para>
+                    Dojo: <ulink
+                        url="http://dojotoolkit.org/book/dojo-book-0-9/part-2-dijit/user-assistance-and-feedback/progress-bar" />
+                </para>
             </listitem>
+
             <listitem>
-                <para>jQuery: <ulink url="http://t.wits.sg/2008/06/20/jquery-progress-bar-11/" /></para>
+                <para>
+                    jQuery: <ulink url="http://t.wits.sg/2008/06/20/jquery-progress-bar-11/" />
+                </para>
             </listitem>
+
             <listitem>
-                <para>MooTools: <ulink url="http://davidwalsh.name/dw-content/progress-bar.php" /></para>
+                <para>
+                    MooTools: <ulink url="http://davidwalsh.name/dw-content/progress-bar.php" />
+                </para>
             </listitem>
+
             <listitem>
-                <para>Prototype: <ulink url="http://livepipe.net/control/progressbar" /></para>
+                <para>
+                    Prototype: <ulink url="http://livepipe.net/control/progressbar" />
+                </para>
             </listitem>
         </itemizedlist>
     </example>
+
     <note>
         <title>Interval of updates</title>
+
         <para>
             You should take care of not sending too many updates, as every update
             has a min-size of 1kb. This is a requirement for the Safari browser
@@ -156,4 +187,4 @@ function Zend_ProgressBar_Update(data)
 </sect3>
 <!--
 vim:se ts=4 sw=4 et:
--->
+-->

documentation/manual/en/module_specs/Zend_Queue-Adapters.xml

@@ -358,16 +358,19 @@ $queue = new Zend_Queue('Db', $options);
                         <filename>/queue/</filename>
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
                         <filename>/topic/</filename>
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
                         <filename>/temp-queue/</filename>
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
                         <filename>/temp-topic/</filename>

documentation/manual/en/module_specs/Zend_Reflection-Reference.xml

@@ -4,10 +4,11 @@
     <title>Zend_Reflection Reference</title>
 
     <para>
-        The various classes in <classname>Zend_Reflection</classname> mimic the <acronym>API</acronym> of
-        <acronym>PHP</acronym>'s <ulink url="http://php.net/reflection">Reflection <acronym>API</acronym></ulink> -
-        with one important difference. <acronym>PHP</acronym>'s Reflection <acronym>API</acronym> does not provide
-        introspection into docblock annotation tags, nor into parameter variable
+        The various classes in <classname>Zend_Reflection</classname> mimic the
+        <acronym>API</acronym> of <acronym>PHP</acronym>'s <ulink
+            url="http://php.net/reflection">Reflection <acronym>API</acronym></ulink> - with one
+        important difference. <acronym>PHP</acronym>'s Reflection <acronym>API</acronym> does not
+        provide introspection into docblock annotation tags, nor into parameter variable
         types or return types.
     </para>
 
@@ -43,53 +44,69 @@
 
         <para>
             <classname>Zend_Reflection_Docblock</classname> is the heart of
-            <classname>Zend_Reflection</classname>'s value-add over <acronym>PHP</acronym>'s Reflection <acronym>API</acronym>.
-            It provides the following methods:
+            <classname>Zend_Reflection</classname>'s value-add over <acronym>PHP</acronym>'s
+            Reflection <acronym>API</acronym>. It provides the following methods:
         </para>
 
         <itemizedlist>
-            <listitem><para>
-                <methodname>getContents()</methodname>: returns the full contents of the
-                docblock.
-            </para></listitem>
-
-            <listitem><para>
-                <methodname>getStartLine()</methodname>: returns the starting position of
-                the docblock within the defining file.
-            </para></listitem>
-
-            <listitem><para>
-                <methodname>getEndLine()</methodname>: get last line of docblock within the
-                defining file.
-            </para></listitem>
-
-            <listitem><para>
-                <methodname>getShortDescription()</methodname>: get the short, one-line
-                description (usually the first line of the docblock).
-            </para></listitem>
-
-            <listitem><para>
-                <methodname>getLongDescription()</methodname>: get the long description from
-                the docblock.
-            </para></listitem>
-
-            <listitem><para>
-                <methodname>hasTag($name)</methodname>: determine if the docblock has the
-                given annotation tag.
-            </para></listitem>
-
-            <listitem><para>
-                <methodname>getTag($name)</methodname>: Retrieve the given annotation tag
-                reflection object, or a boolean <constant>FALSE</constant> if it's not
-                present.
-            </para></listitem>
-
-            <listitem><para>
-                <methodname>getTags($filter)</methodname>: Retrieve all tags, or all tags
-                matching the given <varname>$filter</varname> string. The tags
-                returned will be an array of
-                <classname>Zend_Reflection_Docblock_Tag</classname> objects.
-            </para></listitem>
+            <listitem>
+                <para>
+                    <methodname>getContents()</methodname>: returns the full contents of the
+                    docblock.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <methodname>getStartLine()</methodname>: returns the starting position of
+                    the docblock within the defining file.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <methodname>getEndLine()</methodname>: get last line of docblock within the
+                    defining file.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <methodname>getShortDescription()</methodname>: get the short, one-line
+                    description (usually the first line of the docblock).
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <methodname>getLongDescription()</methodname>: get the long description from
+                    the docblock.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <methodname>hasTag($name)</methodname>: determine if the docblock has the
+                    given annotation tag.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <methodname>getTag($name)</methodname>: Retrieve the given annotation tag
+                    reflection object, or a boolean <constant>FALSE</constant> if it's not
+                    present.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <methodname>getTags($filter)</methodname>: Retrieve all tags, or all tags
+                    matching the given <varname>$filter</varname> string. The tags
+                    returned will be an array of
+                    <classname>Zend_Reflection_Docblock_Tag</classname> objects.
+                </para>
+            </listitem>
         </itemizedlist>
     </sect2>
 
@@ -109,19 +126,25 @@
         </para>
 
         <itemizedlist>
-            <listitem><para>
-                <methodname>factory($tagDocblockLine)</methodname>: instantiate the
-                appropriate tag reflection class and return it.
-            </para></listitem>
-
-            <listitem><para>
-                <methodname>getName()</methodname>: return the annotation tag name.
-            </para></listitem>
-
-            <listitem><para>
-                <methodname>getDescription()</methodname>: return the annotation
-                description.
-            </para></listitem>
+            <listitem>
+                <para>
+                    <methodname>factory($tagDocblockLine)</methodname>: instantiate the
+                    appropriate tag reflection class and return it.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <methodname>getName()</methodname>: return the annotation tag name.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <methodname>getDescription()</methodname>: return the annotation
+                    description.
+                </para>
+            </listitem>
         </itemizedlist>
     </sect2>
 
@@ -137,14 +160,18 @@
         </para>
 
         <itemizedlist>
-            <listitem><para>
-                <methodname>getType()</methodname>: return the parameter variable type.
-            </para></listitem>
-
-            <listitem><para>
-                <methodname>getVariableName()</methodname>: return the parameter variable
-                name.
-            </para></listitem>
+            <listitem>
+                <para>
+                    <methodname>getType()</methodname>: return the parameter variable type.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <methodname>getVariableName()</methodname>: return the parameter variable
+                    name.
+                </para>
+            </listitem>
         </itemizedlist>
     </sect2>
 
@@ -161,9 +188,11 @@
         </para>
 
         <itemizedlist>
-            <listitem><para>
-                <methodname>getType()</methodname>: return the return type.
-            </para></listitem>
+            <listitem>
+                <para>
+                    <methodname>getType()</methodname>: return the return type.
+                </para>
+            </listitem>
         </itemizedlist>
     </sect2>
 
@@ -171,55 +200,71 @@
         <title>Zend_Reflection_File</title>
 
         <para>
-            <classname>Zend_Reflection_File</classname> provides introspection into <acronym>PHP</acronym>
-            files. With it, you can introspect the classes, functions, and bare
-            <acronym>PHP</acronym> code defined in a file. It defines the following methods:
+            <classname>Zend_Reflection_File</classname> provides introspection into
+            <acronym>PHP</acronym> files. With it, you can introspect the classes, functions, and
+            bare <acronym>PHP</acronym> code defined in a file. It defines the following methods:
         </para>
 
         <itemizedlist>
-            <listitem><para>
-                <methodname>getFileName()</methodname>: retrieve the filename of the file
-                being reflected.
-            </para></listitem>
-
-            <listitem><para>
-                <methodname>getStartLine()</methodname>: retrieve the starting line of the
-                file (always "1").
-            </para></listitem>
-
-            <listitem><para>
-                <methodname>getEndLine()</methodname> retrieve the last line / number of
-                lines in the file.
-            </para></listitem>
-
-            <listitem><para>
-                <code>getDocComment($reflectionClass =
-                    'Zend_Reflection_Docblock')</code>: retrive the file-level
-                docblock reflection object.
-            </para></listitem>
-
-            <listitem><para>
-                <code>getClasses($reflectionClass =
-                    'Zend_Reflection_Class')</code>: retrieve an array of
-                reflection objects, one for each class defined in the file.
-            </para></listitem>
-
-            <listitem><para>
-                <code>getFunctions($reflectionClass =
-                    'Zend_Reflection_Function')</code>: retrieve an array of
-                reflection objects, one for each function defined in the file.
-            </para></listitem>
-
-            <listitem><para>
-                <code>getClass($name = null, $reflectionClass =
-                    'Zend_Reflection_Class')</code>: retrieve the reflection
-                object for a single class.
-            </para></listitem>
-
-            <listitem><para>
-                <methodname>getContents()</methodname>: retrieve the full contents of the
-                file.
-            </para></listitem>
+            <listitem>
+                <para>
+                    <methodname>getFileName()</methodname>: retrieve the filename of the file
+                    being reflected.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <methodname>getStartLine()</methodname>: retrieve the starting line of the
+                    file (always "1").
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <methodname>getEndLine()</methodname> retrieve the last line / number of
+                    lines in the file.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <code>getDocComment($reflectionClass =
+                        'Zend_Reflection_Docblock')</code>: retrive the file-level
+                    docblock reflection object.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <code>getClasses($reflectionClass =
+                        'Zend_Reflection_Class')</code>: retrieve an array of
+                    reflection objects, one for each class defined in the file.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <code>getFunctions($reflectionClass =
+                        'Zend_Reflection_Function')</code>: retrieve an array of
+                    reflection objects, one for each function defined in the file.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <code>getClass($name = null, $reflectionClass =
+                        'Zend_Reflection_Class')</code>: retrieve the reflection
+                    object for a single class.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <methodname>getContents()</methodname>: retrieve the full contents of the
+                    file.
+                </para>
+            </listitem>
         </itemizedlist>
     </sect2>
 
@@ -241,40 +286,56 @@
         </para>
 
         <itemizedlist>
-            <listitem><para>
-                <methodname>getDeclaringFile($reflectionClass = 'Zend_Reflection_File')</methodname>
-            </para></listitem>
-
-            <listitem><para>
-                <methodname>getDocblock($reflectionClass = 'Zend_Reflection_Docblock')</methodname>
-            </para></listitem>
-
-            <listitem><para>
-                <methodname>getInterfaces($reflectionClass = 'Zend_Reflection_Class')</methodname>
-            </para></listitem>
-
-            <listitem><para>
-                <methodname>getMethod($reflectionClass = 'Zend_Reflection_Method')</methodname>
-            </para></listitem>
-
-            <listitem><para>
-                <methodname>getMethods($filter = -1, $reflectionClass = 'Zend_Reflection_Method')</methodname>
-            </para></listitem>
+            <listitem>
+                <para>
+                    <methodname>getDeclaringFile($reflectionClass =
+                        'Zend_Reflection_File')</methodname>
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <methodname>getDocblock($reflectionClass =
+                        'Zend_Reflection_Docblock')</methodname>
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <methodname>getInterfaces($reflectionClass =
+                        'Zend_Reflection_Class')</methodname>
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <methodname>getMethod($reflectionClass = 'Zend_Reflection_Method')</methodname>
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <methodname>getMethods($filter = -1, $reflectionClass =
+                        'Zend_Reflection_Method')</methodname>
+                </para>
+            </listitem>
 
             <listitem><para>
                 <methodname>getParentClass($reflectionClass = 'Zend_Reflection_Class')</methodname>
             </para></listitem>
 
-            <listitem><para>
-                <code>getProperty($name, $reflectionClass =
-                    'Zend_Reflection_Property')</code>
-            </para></listitem>
-
-            <listitem><para>
-                <code>getProperties($filter = -1, $reflectionClass =
-                    'Zend_Reflection_Property')</code>
-            </para></listitem>
+            <listitem>
+                <para>
+                    <code>getProperty($name, $reflectionClass = 'Zend_Reflection_Property')</code>
+                </para>
+            </listitem>
 
+            <listitem>
+                <para>
+                    <code>getProperties($filter = -1, $reflectionClass =
+                        'Zend_Reflection_Property')</code>
+                </para>
+            </listitem>
         </itemizedlist>
     </sect2>
 
@@ -289,19 +350,21 @@
         </para>
 
         <itemizedlist>
-            <listitem><para>
-                <code>getFunctions($reflectionClass =
-                    'Zend_Reflection_Function')</code>: retrieve an array of
-                reflection objects representing the functions defined by the
-                extension.
-            </para></listitem>
-
-            <listitem><para>
-                <code>getClasses($reflectionClass =
-                    'Zend_Reflection_Class')</code>: retrieve an array of
-                reflection objects representing the classes defined by the
-                extension.
-            </para></listitem>
+            <listitem>
+                <para>
+                    <code>getFunctions($reflectionClass =
+                        'Zend_Reflection_Function')</code>: retrieve an array of
+                    reflection objects representing the functions defined by the extension.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <code>getClasses($reflectionClass =
+                        'Zend_Reflection_Class')</code>: retrieve an array of
+                    reflection objects representing the classes defined by the extension.
+                </para>
+            </listitem>
         </itemizedlist>
     </sect2>
 
@@ -316,22 +379,28 @@
         </para>
 
         <itemizedlist>
-            <listitem><para>
-                <code>getDocblock($reflectionClass =
-                    'Zend_Reflection_Docblock')</code>: retrieve the function
-                docblock reflection object.
-            </para></listitem>
-
-            <listitem><para>
-                <code>getParameters($reflectionClass =
-                    'Zend_Reflection_Parameter')</code>: retrieve an array of
-                all function parameter reflection objects.
-            </para></listitem>
-
-            <listitem><para>
-                <methodname>getReturn()</methodname>: retrieve the return type reflection
-                object.
-            </para></listitem>
+            <listitem>
+                <para>
+                    <code>getDocblock($reflectionClass =
+                        'Zend_Reflection_Docblock')</code>: retrieve the function
+                    docblock reflection object.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <code>getParameters($reflectionClass =
+                        'Zend_Reflection_Parameter')</code>: retrieve an array of
+                    all function parameter reflection objects.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <methodname>getReturn()</methodname>: retrieve the return type reflection
+                    object.
+                </para>
+            </listitem>
         </itemizedlist>
     </sect2>
 
@@ -345,11 +414,13 @@
         </para>
 
         <itemizedlist>
-            <listitem><para>
-                <code>getParentClass($reflectionClass =
-                    'Zend_Reflection_Class')</code>: retrieve the parent class
-                reflection object.
-            </para></listitem>
+            <listitem>
+                <para>
+                    <code>getParentClass($reflectionClass =
+                        'Zend_Reflection_Class')</code>: retrieve the parent class
+                    reflection object.
+                </para>
+            </listitem>
         </itemizedlist>
     </sect2>
 
@@ -363,27 +434,35 @@
         </para>
 
         <itemizedlist>
-            <listitem><para>
-                <code>getDeclaringClass($reflectionClass =
-                    'Zend_Reflection_Class')</code>: get the declaring class of
-                the parameter as a reflection object (if available).
-            </para></listitem>
-
-            <listitem><para>
-                <code>getClass($reflectionClass =
-                    'Zend_Reflection_Class')</code>: get the class of
-                the parameter as a reflection object (if available).
-            </para></listitem>
-
-            <listitem><para>
-                <code>getDeclaringFunction($reflectionClass =
-                    'Zend_Reflection_Function')</code>: get the function of
-                the parameter as a reflection object (if available).
-            </para></listitem>
-
-            <listitem><para>
-                <methodname>getType()</methodname>: get the parameter type.
-            </para></listitem>
+            <listitem>
+                <para>
+                    <code>getDeclaringClass($reflectionClass =
+                        'Zend_Reflection_Class')</code>: get the declaring class of
+                    the parameter as a reflection object (if available).
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <code>getClass($reflectionClass =
+                        'Zend_Reflection_Class')</code>: get the class of
+                    the parameter as a reflection object (if available).
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <code>getDeclaringFunction($reflectionClass =
+                        'Zend_Reflection_Function')</code>: get the function of
+                    the parameter as a reflection object (if available).
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    <methodname>getType()</methodname>: get the parameter type.
+                </para>
+            </listitem>
         </itemizedlist>
     </sect2>
 
@@ -396,11 +475,13 @@
         </para>
 
         <itemizedlist>
-            <listitem><para>
-                <code>getDeclaringClass($reflectionClass =
-                    'Zend_Reflection_Class')</code>: retrieve the declaring
-                class of the property as a reflection object.
-            </para></listitem>
+            <listitem>
+                <para>
+                    <code>getDeclaringClass($reflectionClass =
+                        'Zend_Reflection_Class')</code>: retrieve the declaring
+                    class of the property as a reflection object.
+                </para>
+            </listitem>
         </itemizedlist>
     </sect2>
 </sect1>

documentation/manual/en/module_specs/Zend_Rest_Client.xml

@@ -2,8 +2,10 @@
 <!-- Reviewed: no -->
 <sect1 id="zend.rest.client">
     <title>Zend_Rest_Client</title>
+
     <sect2 id="zend.rest.client.introduction">
         <title>Introduction</title>
+
         <para>
             Using the <classname>Zend_Rest_Client</classname> is very similar to using
             <code>SoapClient</code> objects (<ulink
@@ -28,13 +30,14 @@ echo $client->sayHello('Davey', 'Day')->get(); // "Hello Davey, Good Day"
 
         <note>
             <title>Differences in calling</title>
+
             <para>
                 <classname>Zend_Rest_Client</classname> attempts to make remote methods
                 look as much like native methods as possible, the only
                 difference being that you must follow the method call with one
                 of either <methodname>get()</methodname>, <methodname>post()</methodname>,
-                <methodname>put()</methodname> or <methodname>delete()</methodname>. This call may be
-                made via method chaining or in separate method calls:
+                <methodname>put()</methodname> or <methodname>delete()</methodname>. This call may
+                be made via method chaining or in separate method calls:
             </para>
 
             <programlisting language="php"><![CDATA[
@@ -62,6 +65,7 @@ echo $client->get();
 
         <example id="zend.rest.client.return.example-1">
             <title>Response Status</title>
+
             <programlisting language="php"><![CDATA[
 $result = $client->sayHello('Davey', 'Day')->get();
 
@@ -105,6 +109,7 @@ echo $result->firstname() .' '. $result->lastname();
 
         <example id="zend.rest.client.return.example-3">
             <title>Example Technorati Response</title>
+
             <programlisting language="xml"><![CDATA[
 <?xml version="1.0" encoding="utf-8"?>
 <!-- generator="Technorati API version 1.0 /bloginfo" -->
@@ -215,7 +220,6 @@ $client->arg('value1')->arg2('value2')->get();
         </warning>
     </sect2>
 </sect1>
-
 <!--
 vim:se ts=4 sw=4 et:
 -->

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

@@ -7,26 +7,33 @@
         <title>Starting from 1.6, handling index format transformations</title>
 
         <para>
-            <classname>Zend_Search_Lucene</classname> component works with Java Lucene 1.4-1.9, 2.1 and 2.3 index formats.
+            <classname>Zend_Search_Lucene</classname> component works with Java Lucene 1.4-1.9, 2.1
+            and 2.3 index formats.
         </para>
 
         <para>
-            Current index format may be requested using <code>$index->getFormatVersion()</code> call.
-            It returns one of the following values:
+            Current index format may be requested using <code>$index->getFormatVersion()</code>
+            call. It returns one of the following values:
+
             <itemizedlist>
                 <listitem>
                     <para>
-                        <constant>Zend_Search_Lucene::FORMAT_PRE_2_1</constant> for Java Lucene 1.4-1.9 index format.
+                        <constant>Zend_Search_Lucene::FORMAT_PRE_2_1</constant> for Java Lucene
+                        1.4-1.9 index format.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <constant>Zend_Search_Lucene::FORMAT_2_1</constant> for Java Lucene 2.1 index format (also used for Lucene 2.2).
+                        <constant>Zend_Search_Lucene::FORMAT_2_1</constant> for Java Lucene 2.1
+                        index format (also used for Lucene 2.2).
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <constant>Zend_Search_Lucene::FORMAT_2_3</constant> for Java Lucene 2.3 index format.
+                        <constant>Zend_Search_Lucene::FORMAT_2_3</constant> for Java Lucene 2.3
+                        index format.
                     </para>
                 </listitem>
             </itemizedlist>
@@ -34,29 +41,34 @@
 
         <para>
             Index modifications are performed <emphasis>only</emphasis> if any index update is done.
-            That happens if a new document is added to an index or index optimization is started manually
-            by <code>$index->optimize()</code> call.
+            That happens if a new document is added to an index or index optimization is started
+            manually by <code>$index->optimize()</code> call.
         </para>
 
         <para>
-            In a such case <classname>Zend_Search_Lucene</classname> may convert index to the higher format version.
-            That <emphasis>always</emphasis> happens for the indices in <constant>Zend_Search_Lucene::FORMAT_PRE_2_1</constant> format,
-            which are automatically converted to 2.1 format.
+            In a such case <classname>Zend_Search_Lucene</classname> may convert index to the higher
+            format version. That <emphasis>always</emphasis> happens for the indices in
+            <constant>Zend_Search_Lucene::FORMAT_PRE_2_1</constant> format, which are automatically
+            converted to 2.1 format.
         </para>
 
         <para>
-            You may manage conversion process and assign target index format by <code>$index->setFormatVersion()</code> which takes
-            <constant>Zend_Search_Lucene::FORMAT_2_1</constant> or <constant>Zend_Search_Lucene::FORMAT_2_3</constant> constant as a parameter:
+            You may manage conversion process and assign target index format by
+            <code>$index->setFormatVersion()</code> which takes
+            <constant>Zend_Search_Lucene::FORMAT_2_1</constant> or
+            <constant>Zend_Search_Lucene::FORMAT_2_3</constant> constant as a parameter:
+
             <itemizedlist>
                 <listitem>
                     <para>
-                        <constant>Zend_Search_Lucene::FORMAT_2_1</constant> actually does nothing since pre-2.1 indices are automatically converted
-                        to 2.1 format.
+                        <constant>Zend_Search_Lucene::FORMAT_2_1</constant> actually does nothing
+                        since pre-2.1 indices are automatically converted to 2.1 format.
                     </para>
                 </listitem>
                 <listitem>
                     <para>
-                        <constant>Zend_Search_Lucene::FORMAT_2_3</constant> forces conversion to the 2.3 format.
+                        <constant>Zend_Search_Lucene::FORMAT_2_3</constant> forces conversion to the
+                        2.3 format.
                     </para>
                 </listitem>
             </itemizedlist>
@@ -68,33 +80,39 @@
 
         <note>
             <title>Important!</title>
+
             <para>
-                Once index is converted to upper version it can't be converted back. So make a backup of your index when you plan
-                migration to upper version, but want to have possibility to go back.
+                Once index is converted to upper version it can't be converted back. So make a
+                backup of your index when you plan migration to upper version, but want to have
+                possibility to go back.
             </para>
         </note>
-
     </sect2>
 
     <sect2 id="zend.search.lucene.advanced.static">
         <title>Using the index as static property</title>
 
         <para>
-            The <classname>Zend_Search_Lucene</classname> object uses the destructor method to commit changes and clean up resources.
+            The <classname>Zend_Search_Lucene</classname> object uses the destructor method to
+            commit changes and clean up resources.
         </para>
 
         <para>
-            It stores added documents in memory and dumps new index segment to disk depending on <code>MaxBufferedDocs</code> parameter.
+            It stores added documents in memory and dumps new index segment to disk depending on
+            <code>MaxBufferedDocs</code> parameter.
         </para>
 
         <para>
-            If <code>MaxBufferedDocs</code> limit is not reached then there are some "unsaved" documents which are saved as a new segment in the object's destructor method.
-            The index auto-optimization procedure is invoked if necessary depending on the values of the <code>MaxBufferedDocs</code>, <code>MaxMergeDocs</code> and
-            <code>MergeFactor</code> parameters.
+            If <code>MaxBufferedDocs</code> limit is not reached then there are some "unsaved"
+            documents which are saved as a new segment in the object's destructor method. The index
+            auto-optimization procedure is invoked if necessary depending on the values of the
+            <code>MaxBufferedDocs</code>, <code>MaxMergeDocs</code> and <code>MergeFactor</code>
+            parameters.
         </para>
 
         <para>
-            Static object properties (see below) are destroyed <emphasis>after</emphasis> the last line of the executed script.
+            Static object properties (see below) are destroyed <emphasis>after</emphasis> the last
+            line of the executed script.
 
             <programlisting language="php"><![CDATA[
 class Searcher {
@@ -110,22 +128,31 @@ Searcher::initIndex();
         </para>
 
         <para>
-            All the same, the destructor for static properties is correctly invoked at this point in the program's execution.
+            All the same, the destructor for static properties is correctly invoked at this point in
+            the program's execution.
         </para>
 
         <para>
-            One potential problem is exception handling. Exceptions thrown by destructors of static objects don't have context, because the destructor is executed after the script has already completed.
+            One potential problem is exception handling. Exceptions thrown by destructors of static
+            objects don't have context, because the destructor is executed after the script has
+            already completed.
         </para>
 
         <para>
-            You might see a "Fatal error: Exception thrown without a stack frame in Unknown on line 0" error message instead of exception description in such cases.
+            You might see a "Fatal error: Exception thrown without a stack frame in Unknown on line
+            0" error message instead of exception description in such cases.
         </para>
 
         <para>
-            <classname>Zend_Search_Lucene</classname> provides a workaround to this problem with the <methodname>commit()</methodname> method. It saves all unsaved changes and frees memory used for storing new segments.
-            You are free to use the commit operation any time- or even several times- during script execution. You can still use the <classname>Zend_Search_Lucene</classname> object for searching,
-            adding or deleting document after the commit operation. But the <methodname>commit()</methodname> call guarantees that if there are no document added or deleted after the call to <methodname>commit()</methodname>, then
-            the <classname>Zend_Search_Lucene</classname> destructor has nothing to do and will not throw exception:
+            <classname>Zend_Search_Lucene</classname> provides a workaround to this problem with the
+            <methodname>commit()</methodname> method. It saves all unsaved changes and frees memory
+            used for storing new segments. You are free to use the commit operation any time- or
+            even several times- during script execution. You can still use the
+            <classname>Zend_Search_Lucene</classname> object for searching, adding or deleting
+            document after the commit operation. But the <methodname>commit()</methodname> call
+            guarantees that if there are no document added or deleted after the call to
+            <methodname>commit()</methodname>, then the <classname>Zend_Search_Lucene</classname>
+            destructor has nothing to do and will not throw exception:
 
             <programlisting language="php"><![CDATA[
 class Searcher {

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

@@ -11,14 +11,17 @@
         </para>
 
         <para>
-            Nevertheless it's a good idea not to use '<emphasis>id</emphasis>' and '<emphasis>score</emphasis>' names
-            to avoid ambiguity in <code>QueryHit</code> properties names.
+            Nevertheless it's a good idea not to use '<emphasis>id</emphasis>' and
+            '<emphasis>score</emphasis>' names to avoid ambiguity in <code>QueryHit</code>
+            properties names.
         </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 <methodname>getDocument()</methodname> method to access them:
+            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
+            <methodname>getDocument()</methodname> method to access them:
 
             <programlisting language="php"><![CDATA[
 $hits = $index->find($query);
@@ -53,7 +56,8 @@ foreach ($hits as $hit) {
         <title>Indexing performance</title>
 
         <para>
-            Indexing performance is a compromise between used resources, indexing time and index quality.
+            Indexing performance is a compromise between used resources, indexing time and index
+            quality.
         </para>
 
         <para>
@@ -61,17 +65,19 @@ foreach ($hits as $hit) {
         </para>
 
         <para>
-            Each index segment is entirely independent portion of data. So indexes containing more segments need
-            more memory and time for searching.
+            Each index segment is entirely independent portion of data. So indexes containing more
+            segments need more memory and time for searching.
         </para>
 
         <para>
-            Index optimization is a process of merging several segments into a new one. A fully optimized index contains
-            only one segment.
+            Index optimization is a process of merging several segments into a new one. A fully
+            optimized index contains only one segment.
         </para>
 
         <para>
-            Full index optimization may be performed with the <methodname>optimize()</methodname> method:
+            Full index optimization may be performed with the <methodname>optimize()</methodname>
+            method:
+
             <programlisting language="php"><![CDATA[
 $index = Zend_Search_Lucene::open($indexPath);
 
@@ -80,124 +86,187 @@ $index->optimize();
         </para>
 
         <para>
-            Index optimization works with data streams and doesn't take a lot of memory but does require processor resources and time.
+            Index optimization works with data streams and doesn't take a lot of memory but does
+            require processor resources and time.
         </para>
 
         <para>
-            Lucene index segments are not updatable by their nature (the update operation requires the segment file
-            to be completely rewritten). So adding new document(s) to an index always generates a new segment.
-            This, in turn, decreases index quality.
+            Lucene index segments are not updatable by their nature (the update operation requires
+            the segment file to be completely rewritten). So adding new document(s) to an index
+            always generates a new segment. This, in turn, decreases index quality.
         </para>
 
         <para>
-            An index auto-optimization process is performed after each segment generation and consists of merging partial segments.
+            An index auto-optimization process is performed after each segment generation and
+            consists of merging partial segments.
         </para>
 
         <para>
-            There are three options to control the behavior of auto-optimization
-            (see <link linkend="zend.search.lucene.index-creation.optimization">Index optimization</link> section):
+            There are three options to control the behavior of auto-optimization (see <link
+                linkend="zend.search.lucene.index-creation.optimization">Index optimization</link>
+            section):
+
             <itemizedlist>
                 <listitem>
-                    <para><emphasis>MaxBufferedDocs</emphasis> is the number of documents that can be buffered in memory before a new segment is generated
-                          and written to the hard drive.</para>
+                    <para>
+                        <emphasis>MaxBufferedDocs</emphasis> is the number of documents that can be
+                        buffered in memory before a new segment is generated and written to the hard
+                        drive.
+                    </para>
                 </listitem>
+
                 <listitem>
-                    <para><emphasis>MaxMergeDocs</emphasis> is the maximum number of documents merged by auto-optimization process
-                          into a new segment.</para>
+                    <para>
+                        <emphasis>MaxMergeDocs</emphasis> is the maximum number of documents merged
+                        by auto-optimization process into a new segment.
+                    </para>
                 </listitem>
+
                 <listitem>
-                    <para><emphasis>MergeFactor</emphasis> determines how often auto-optimization is performed.</para>
+                    <para>
+                        <emphasis>MergeFactor</emphasis> determines how often auto-optimization is
+                        performed.
+                    </para>
                 </listitem>
             </itemizedlist>
+
             <note>
                 <para>
-                    All these options are <classname>Zend_Search_Lucene</classname> object properties- not index properties. They affect only current
-                    <classname>Zend_Search_Lucene</classname> object behavior and may vary for different scripts.
+                    All these options are <classname>Zend_Search_Lucene</classname> object
+                    properties- not index properties. They affect only current
+                    <classname>Zend_Search_Lucene</classname> object behavior and may vary for
+                    different scripts.
                 </para>
             </note>
         </para>
 
         <para>
-            <emphasis>MaxBufferedDocs</emphasis> doesn't have any effect if you index only one document per script execution. On the other hand, it's very important
-            for batch indexing. Greater values increase indexing performance, but also require more memory.
+            <emphasis>MaxBufferedDocs</emphasis> doesn't have any effect if you index only one
+            document per script execution. On the other hand, it's very important for batch
+            indexing. Greater values increase indexing performance, but also require more memory.
         </para>
 
         <para>
-            There is simply no way to calculate the best value for the <emphasis>MaxBufferedDocs</emphasis> parameter because it depends on average document size, the
-            analyzer in use and allowed memory.
+            There is simply no way to calculate the best value for the
+            <emphasis>MaxBufferedDocs</emphasis> parameter because it depends on average document
+            size, the analyzer in use and allowed memory.
         </para>
 
         <para>
-            A good way to find the right value is to perform several tests with the largest document you expect to be added to the index
-            <footnote><para><methodname>memory_get_usage()</methodname> and <methodname>memory_get_peak_usage()</methodname> may be used to control
-            memory usage.</para></footnote>. It's a best practice not to use more than a half of the allowed memory.
+            A good way to find the right value is to perform several tests with the largest document
+            you expect to be added to the index
+
+            <footnote>
+                <para>
+                    <methodname>memory_get_usage()</methodname> and
+                    <methodname>memory_get_peak_usage()</methodname> may be used to control memory
+                    usage.
+                </para>
+            </footnote>
+
+            . It's a best practice not to use more than a half of the allowed memory.
         </para>
 
         <para>
-            <emphasis>MaxMergeDocs</emphasis> limits the segment size (in terms of documents). It therefore also limits auto-optimization time by guaranteeing
-            that the <methodname>addDocument()</methodname> method is not executed more than a certain number of times. This is very important for interactive applications.
+            <emphasis>MaxMergeDocs</emphasis> limits the segment size (in terms of documents). It
+            therefore also limits auto-optimization time by guaranteeing that the
+            <methodname>addDocument()</methodname> method is not executed more than a certain number
+            of times. This is very important for interactive applications.
         </para>
 
         <para>
-            Lowering the <emphasis>MaxMergeDocs</emphasis> parameter also may improve batch indexing performance. Index auto-optimization is an iterative process
-            and is performed from bottom up. Small segments are merged into larger segment, which are in turn merged into even larger segments and
-            so on. Full index optimization is achieved when only one large segment file remains.
+            Lowering the <emphasis>MaxMergeDocs</emphasis> parameter also may improve batch indexing
+            performance. Index auto-optimization is an iterative process and is performed from
+            bottom up. Small segments are merged into larger segment, which are in turn merged into
+            even larger segments and so on. Full index optimization is achieved when only one large
+            segment file remains.
         </para>
 
         <para>
             Small segments generally decrease index quality. Many small segments may also trigger
-            the "Too many open files" error determined by OS limitations <footnote><para><classname>Zend_Search_Lucene</classname> keeps each segment file opened
-            to improve search performance.</para></footnote>.
+            the "Too many open files" error determined by OS limitations
+
+            <footnote>
+                <para>
+                    <classname>Zend_Search_Lucene</classname> keeps each segment file opened to
+                    improve search performance.
+                </para>
+            </footnote>.
         </para>
 
         <para>
-            in general, background index optimization should be performed for interactive indexing mode and <emphasis>MaxMergeDocs</emphasis> shouldn't be
-            too low for batch indexing.
+            in general, background index optimization should be performed for interactive indexing
+            mode and <emphasis>MaxMergeDocs</emphasis> shouldn't be too low for batch indexing.
         </para>
 
         <para>
-            <emphasis>MergeFactor</emphasis> affects auto-optimization frequency. Lower values increase the quality of unoptimized indexes. Larger values increase
-            indexing performance, but also increase the number of merged segments. This again may trigger the "Too many open files" error.
+            <emphasis>MergeFactor</emphasis> affects auto-optimization frequency. Lower values
+            increase the quality of unoptimized indexes. Larger values increase indexing
+            performance, but also increase the number of merged segments. This again may trigger the
+            "Too many open files" error.
         </para>
 
         <para>
             <emphasis>MergeFactor</emphasis> groups index segments by their size:
+
             <orderedlist>
-                <listitem><para>Not greater than <emphasis>MaxBufferedDocs</emphasis>.</para></listitem>
-                <listitem><para>Greater than <emphasis>MaxBufferedDocs</emphasis>, but not greater than
-                                <emphasis>MaxBufferedDocs</emphasis>*<emphasis>MergeFactor</emphasis>.</para></listitem>
-                <listitem><para>Greater than <emphasis>MaxBufferedDocs</emphasis>*<emphasis>MergeFactor</emphasis>, but not greater than
-                <emphasis>MaxBufferedDocs</emphasis>*<emphasis>MergeFactor</emphasis>*<emphasis>MergeFactor</emphasis>.</para></listitem>
+                <listitem>
+                    <para>Not greater than <emphasis>MaxBufferedDocs</emphasis>.</para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        Greater than <emphasis>MaxBufferedDocs</emphasis>, but not greater than
+                        <emphasis>MaxBufferedDocs</emphasis>*<emphasis>MergeFactor</emphasis>.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        Greater than
+                        <emphasis>MaxBufferedDocs</emphasis>*<emphasis>MergeFactor</emphasis>, but
+                        not greater than
+                        <emphasis>MaxBufferedDocs</emphasis>*<emphasis>MergeFactor</emphasis>*<emphasis>MergeFactor</emphasis>.
+                    </para>
+                </listitem>
+
                 <listitem><para>...</para></listitem>
             </orderedlist>
         </para>
 
         <para>
-            <classname>Zend_Search_Lucene</classname> checks during each <methodname>addDocument()</methodname> call to see if merging any segments may move the newly created segment
-            into the next group. If yes, then merging is performed.
+            <classname>Zend_Search_Lucene</classname> checks during each
+            <methodname>addDocument()</methodname> call to see if merging any segments may move the
+            newly created segment into the next group. If yes, then merging is performed.
         </para>
 
         <para>
-            So an index with N groups may contain <emphasis>MaxBufferedDocs</emphasis> + (N-1)*<emphasis>MergeFactor</emphasis> segments and contains at least
-            <emphasis>MaxBufferedDocs</emphasis>*<emphasis>MergeFactor</emphasis><superscript>(N-1)</superscript> documents.
+            So an index with N groups may contain <emphasis>MaxBufferedDocs</emphasis> +
+            (N-1)*<emphasis>MergeFactor</emphasis> segments and contains at least
+            <emphasis>MaxBufferedDocs</emphasis>*<emphasis>MergeFactor</emphasis><superscript>(N-1)</superscript>
+            documents.
         </para>
 
         <para>
             This gives good approximation for the number of segments in the index:
         </para>
         <para>
-            <emphasis>NumberOfSegments</emphasis> &lt;= <emphasis>MaxBufferedDocs</emphasis> + <emphasis>MergeFactor</emphasis>*log
-            <subscript><emphasis>MergeFactor</emphasis></subscript> (<emphasis>NumberOfDocuments</emphasis>/<emphasis>MaxBufferedDocs</emphasis>)
+            <emphasis>NumberOfSegments</emphasis> &lt;= <emphasis>MaxBufferedDocs</emphasis> +
+            <emphasis>MergeFactor</emphasis>*log
+            <subscript><emphasis>MergeFactor</emphasis></subscript>
+            (<emphasis>NumberOfDocuments</emphasis>/<emphasis>MaxBufferedDocs</emphasis>)
         </para>
 
         <para>
-            <emphasis>MaxBufferedDocs</emphasis> is determined by allowed memory. This allows for the appropriate merge factor to get a reasonable
-            number of segments.
+            <emphasis>MaxBufferedDocs</emphasis> is determined by allowed memory. This allows for
+            the appropriate merge factor to get a reasonable number of segments.
         </para>
 
         <para>
-            Tuning the <emphasis>MergeFactor</emphasis> parameter is more effective for batch indexing performance than <emphasis>MaxMergeDocs</emphasis>. But it's also more course-grained.
-            So use the estimation above for tuning <emphasis>MergeFactor</emphasis>, then play with <emphasis>MaxMergeDocs</emphasis> to get best batch indexing performance.
+            Tuning the <emphasis>MergeFactor</emphasis> parameter is more effective for batch
+            indexing performance than <emphasis>MaxMergeDocs</emphasis>. But it's also more
+            course-grained. So use the estimation above for tuning <emphasis>MergeFactor</emphasis>,
+            then play with <emphasis>MaxMergeDocs</emphasis> to get best batch indexing performance.
         </para>
     </sect2>
 
@@ -205,7 +274,8 @@ $index->optimize();
         <title>Index during Shut Down</title>
 
         <para>
-            The <classname>Zend_Search_Lucene</classname> instance performs some work at exit time if any documents were added to the index but not written to a new segment.
+            The <classname>Zend_Search_Lucene</classname> instance performs some work at exit time
+            if any documents were added to the index but not written to a new segment.
         </para>
 
         <para>
@@ -213,13 +283,21 @@ $index->optimize();
         </para>
 
         <para>
-            The index object is automatically closed when it, and all returned QueryHit objects, go out of scope.
+            The index object is automatically closed when it, and all returned QueryHit objects, go
+            out of scope.
         </para>
 
         <para>
-            If index object is stored in global variable than it's closed only at the end of script execution<footnote><para>This also
-            may occur if the index or QueryHit instances are referred to in some cyclical data structures, because <acronym>PHP</acronym> garbage collects objects
-            with cyclic references only at the end of script execution.</para></footnote>.
+            If index object is stored in global variable than it's closed only at the end of script
+            execution
+
+            <footnote>
+                <para>
+                    This also may occur if the index or QueryHit instances are referred to in some
+                    cyclical data structures, because <acronym>PHP</acronym> garbage collects
+                    objects with cyclic references only at the end of script execution.
+                </para>
+            </footnote>.
         </para>
 
         <para>
@@ -227,7 +305,8 @@ $index->optimize();
         </para>
 
         <para>
-            It doesn't prevent normal index shutdown process, but may prevent accurate error diagnostic if any error occurs during shutdown.
+            It doesn't prevent normal index shutdown process, but may prevent accurate error
+            diagnostic if any error occurs during shutdown.
         </para>
 
         <para>
@@ -236,6 +315,7 @@ $index->optimize();
 
         <para>
             The first is to force going out of scope:
+
             <programlisting language="php"><![CDATA[
 $index = Zend_Search_Lucene::open($indexPath);
 
@@ -247,13 +327,16 @@ unset($index);
 
         <para>
             And the second is to perform a commit operation before the end of script execution:
+
             <programlisting language="php"><![CDATA[
 $index = Zend_Search_Lucene::open($indexPath);
 
 $index->commit();
 ]]></programlisting>
-            This possibility is also described in the "<link linkend="zend.search.lucene.advanced.static">Advanced. Using index as static property</link>"
-            section.
+
+            This possibility is also described in the "<link
+                linkend="zend.search.lucene.advanced.static">Advanced. Using index as static
+                property</link>" section.
         </para>
     </sect2>
 
@@ -261,15 +344,18 @@ $index->commit();
         <title>Retrieving documents by unique id</title>
 
         <para>
-            It's a common practice to store some unique document id in the index. Examples include url, path, or database id.
+            It's a common practice to store some unique document id in the index. Examples include
+            url, path, or database id.
         </para>
 
         <para>
-            <classname>Zend_Search_Lucene</classname> provides a <methodname>termDocs()</methodname> method for retrieving documents containing specified terms.
+            <classname>Zend_Search_Lucene</classname> provides a <methodname>termDocs()</methodname>
+            method for retrieving documents containing specified terms.
         </para>
 
         <para>
             This is more efficient than using the <methodname>find()</methodname> method:
+
             <programlisting language="php"><![CDATA[
 // Retrieving documents with find() method using a query string
 $query = $idFieldName . ':' . $docId;
@@ -314,7 +400,8 @@ foreach ($docIds as $id) {
         </para>
 
         <para>
-            It uses memory to cache some information and optimize searching and indexing performance.
+            It uses memory to cache some information and optimize searching and indexing
+            performance.
         </para>
 
         <para>
@@ -322,30 +409,44 @@ foreach ($docIds as $id) {
         </para>
 
         <para>
-            The terms dictionary index is loaded during the search. It's actually each 128<superscript>th</superscript>
-            <footnote><para>The Lucene file format allows you to configure this number, but <classname>Zend_Search_Lucene</classname> doesn't expose this
-            in its <acronym>API</acronym>. Nevertheless you still have the ability to configure this value if the index is prepared with another
-            Lucene implementation.</para></footnote> term of the full dictionary.
+            The terms dictionary index is loaded during the search. It's actually each
+            128<superscript>th</superscript>
+
+            <footnote>
+                <para>
+                    The Lucene file format allows you to configure this number, but
+                    <classname>Zend_Search_Lucene</classname> doesn't expose this in its
+                    <acronym>API</acronym>. Nevertheless you still have the ability to configure
+                    this value if the index is prepared with another Lucene implementation.
+                </para>
+            </footnote>
+
+            term of the full dictionary.
         </para>
 
         <para>
-            Thus memory usage is increased if you have a high number of unique terms. This may happen if you use untokenized phrases as a field values
-            or index a large volume of non-text information.
+            Thus memory usage is increased if you have a high number of unique terms. This may
+            happen if you use untokenized phrases as a field values or index a large volume of
+            non-text information.
         </para>
 
         <para>
-            An unoptimized index consists of several segments. It also increases memory usage. Segments are independent, so each segment contains
-            its own terms dictionary and terms dictionary index. If an index consists of <emphasis>N</emphasis> segments it may increase memory
-            usage by <emphasis>N</emphasis> times in worst case. Perform index optimization to merge all segments into one to avoid such memory consumption.
+            An unoptimized index consists of several segments. It also increases memory usage.
+            Segments are independent, so each segment contains its own terms dictionary and terms
+            dictionary index. If an index consists of <emphasis>N</emphasis> segments it may
+            increase memory usage by <emphasis>N</emphasis> times in worst case. Perform index
+            optimization to merge all segments into one to avoid such memory consumption.
         </para>
 
         <para>
-            Indexing uses the same memory as searching plus memory for buffering documents. The amount of memory used may be managed with
-            <emphasis>MaxBufferedDocs</emphasis> parameter.
+            Indexing uses the same memory as searching plus memory for buffering documents. The
+            amount of memory used may be managed with <emphasis>MaxBufferedDocs</emphasis>
+            parameter.
         </para>
 
         <para>
-            Index optimization (full or partial) uses stream-style data processing and doesn't require a lot of memory.
+            Index optimization (full or partial) uses stream-style data processing and doesn't
+            require a lot of memory.
         </para>
     </sect2>
 
@@ -353,11 +454,13 @@ foreach ($docIds as $id) {
         <title>Encoding</title>
 
         <para>
-            <classname>Zend_Search_Lucene</classname> works with UTF-8 strings internally. So all strings returned by <classname>Zend_Search_Lucene</classname> are UTF-8 encoded.
+            <classname>Zend_Search_Lucene</classname> works with UTF-8 strings internally. So all
+            strings returned by <classname>Zend_Search_Lucene</classname> are UTF-8 encoded.
         </para>
 
         <para>
-            You shouldn't be concerned with encoding if you work with pure <acronym>ASCII</acronym> data, but you should be careful if this is not the case.
+            You shouldn't be concerned with encoding if you work with pure <acronym>ASCII</acronym>
+            data, but you should be careful if this is not the case.
         </para>
 
         <para>
@@ -365,11 +468,13 @@ foreach ($docIds as $id) {
         </para>
 
         <para>
-            <classname>Zend_Search_Lucene</classname> offers a wide range of encoding possibilities for indexed documents and parsed queries.
+            <classname>Zend_Search_Lucene</classname> offers a wide range of encoding possibilities
+            for indexed documents and parsed queries.
         </para>
 
         <para>
             Encoding may be explicitly specified as an optional parameter of field creation methods:
+
             <programlisting language="php"><![CDATA[
 $doc = new Zend_Search_Lucene_Document();
 $doc->addField(Zend_Search_Lucene_Field::Text('title',
@@ -379,12 +484,14 @@ $doc->addField(Zend_Search_Lucene_Field::UnStored('contents',
                                                   $contents,
                                                   'utf-8'));
 ]]></programlisting>
+
             This is the best way to avoid ambiguity in the encoding used.
         </para>
 
         <para>
-            If optional encoding parameter is omitted, then the current locale is used. The current locale may contain character encoding data
-            in addition to the language specification:
+            If optional encoding parameter is omitted, then the current locale is used. The current
+            locale may contain character encoding data in addition to the language specification:
+
             <programlisting language="php"><![CDATA[
 setlocale(LC_ALL, 'fr_FR');
 ...
@@ -406,7 +513,9 @@ setlocale(LC_ALL, 'ru_RU.UTF-8');
         </para>
 
         <para>
-            Encoding may be passed as an optional parameter, if the query is parsed explicitly before search:
+            Encoding may be passed as an optional parameter, if the query is parsed explicitly
+            before search:
+
             <programlisting language="php"><![CDATA[
 $query =
     Zend_Search_Lucene_Search_QueryParser::parse($queryStr, 'iso-8859-5');
@@ -416,18 +525,23 @@ $hits = $index->find($query);
         </para>
 
         <para>
-            The default encoding may also be specified with <methodname>setDefaultEncoding()</methodname> method:
+            The default encoding may also be specified with
+            <methodname>setDefaultEncoding()</methodname> method:
+
             <programlisting language="php"><![CDATA[
 Zend_Search_Lucene_Search_QueryParser::setDefaultEncoding('iso-8859-1');
 $hits = $index->find($queryStr);
 ...
 ]]></programlisting>
+
             The empty string implies 'current locale'.
         </para>
 
         <para>
-            If the correct encoding is specified it can be correctly processed by analyzer. The actual behavior depends on which analyzer is used.
-            See the <link linkend="zend.search.lucene.charset">Character Set</link> documentation section for details.
+            If the correct encoding is specified it can be correctly processed by analyzer. The
+            actual behavior depends on which analyzer is used. See the <link
+                linkend="zend.search.lucene.charset">Character Set</link> documentation section for
+            details.
         </para>
     </sect2>
 
@@ -435,30 +549,35 @@ $hits = $index->find($queryStr);
         <title>Index maintenance</title>
 
         <para>
-            It should be clear that <classname>Zend_Search_Lucene</classname> as well as any other Lucene implementation does not comprise a "database".
+            It should be clear that <classname>Zend_Search_Lucene</classname> as well as any other
+            Lucene implementation does not comprise a "database".
         </para>
 
         <para>
-            Indexes should not be used for data storage. They do not provide partial backup/restore functionality, journaling, logging, transactions
-            and many other features associated with database management systems.
+            Indexes should not be used for data storage. They do not provide partial backup/restore
+            functionality, journaling, logging, transactions and many other features associated with
+            database management systems.
         </para>
 
         <para>
-            Nevertheless, <classname>Zend_Search_Lucene</classname> attempts to keep indexes in a consistent state at all times.
+            Nevertheless, <classname>Zend_Search_Lucene</classname> attempts to keep indexes in a
+            consistent state at all times.
         </para>
 
         <para>
-            Index backup and restoration should be performed by copying the contents of the index folder.
+            Index backup and restoration should be performed by copying the contents of the index
+            folder.
         </para>
 
         <para>
-            If index corruption occurs for any reason, the corrupted index should be restored or completely rebuilt.
+            If index corruption occurs for any reason, the corrupted index should be restored or
+            completely rebuilt.
         </para>
 
         <para>
-            So it's a good idea to backup large indexes and store changelogs to perform manual restoration and roll-forward operations
-            if necessary. This practice dramatically reduces index restoration time.
+            So it's a good idea to backup large indexes and store changelogs to perform manual
+            restoration and roll-forward operations if necessary. This practice dramatically reduces
+            index restoration time.
         </para>
-
     </sect2>
 </sect1>

documentation/manual/en/module_specs/Zend_Search_Lucene-Charset.xml

@@ -7,9 +7,11 @@
         <title>UTF-8 and single-byte character set support</title>
 
         <para>
-            <classname>Zend_Search_Lucene</classname> works with the UTF-8 charset internally. Index files store
-            unicode data in Java's "modified UTF-8 encoding". <classname>Zend_Search_Lucene</classname> core
-            completely supports this encoding with one exception.
+            <classname>Zend_Search_Lucene</classname> works with the UTF-8 charset internally. Index
+            files store unicode data in Java's "modified UTF-8 encoding".
+            <classname>Zend_Search_Lucene</classname> core completely supports this encoding with
+            one exception.
+
             <footnote>
                <para>
                    <classname>Zend_Search_Lucene</classname> supports only Basic Multilingual Plane
@@ -17,6 +19,7 @@
                    "supplementary characters" (characters whose code points are
                    greater than 0xFFFF)
                </para>
+
                <para>
                    Java 2 represents these characters as a pair of char (16-bit)
                    values, the first from the high-surrogates range (0xD800-0xDBFF),
@@ -29,21 +32,25 @@
         </para>
 
         <para>
-            Actual input data encoding may be specified through <classname>Zend_Search_Lucene</classname> <acronym>API</acronym>. Data will
-            be automatically converted into UTF-8 encoding.
+            Actual input data encoding may be specified through
+            <classname>Zend_Search_Lucene</classname> <acronym>API</acronym>. Data will be
+            automatically converted into UTF-8 encoding.
         </para>
     </sect2>
 
     <sect2 id="zend.search.lucene.charset.default_analyzer">
         <title>Default text analyzer</title>
+
         <para>
             However, the default text analyzer (which is also used within query parser) uses
             ctype_alpha() for tokenizing text and queries.
         </para>
 
         <para>
-            ctype_alpha() is not UTF-8 compatible, so the analyzer converts text to 'ASCII//TRANSLIT' encoding before
-            indexing. The same processing is transparently performed during query parsing.
+            ctype_alpha() is not UTF-8 compatible, so the analyzer converts text to
+            'ASCII//TRANSLIT' encoding before indexing. The same processing is transparently
+            performed during query parsing.
+
             <footnote>
                <para>
                    Conversion to 'ASCII//TRANSLIT' may depend on current locale and OS.
@@ -54,8 +61,8 @@
         <note>
             <title/>
             <para>
-                Default analyzer doesn't treats numbers as parts of terms. Use corresponding 'Num' analyzer if you don't want words
-                to be broken by numbers.
+                Default analyzer doesn't treats numbers as parts of terms. Use corresponding 'Num'
+                analyzer if you don't want words to be broken by numbers.
             </para>
         </note>
     </sect2>
@@ -64,8 +71,10 @@
         <title>UTF-8 compatible text analyzers</title>
 
         <para>
-            <classname>Zend_Search_Lucene</classname> also contains a set of UTF-8 compatible analyzers: <classname>Zend_Search_Lucene_Analysis_Analyzer_Common_Utf8</classname>,
-            <classname>Zend_Search_Lucene_Analysis_Analyzer_Common_Utf8Num</classname>, <classname>Zend_Search_Lucene_Analysis_Analyzer_Common_Utf8_CaseInsensitive</classname>,
+            <classname>Zend_Search_Lucene</classname> also contains a set of UTF-8 compatible
+            analyzers: <classname>Zend_Search_Lucene_Analysis_Analyzer_Common_Utf8</classname>,
+            <classname>Zend_Search_Lucene_Analysis_Analyzer_Common_Utf8Num</classname>,
+            <classname>Zend_Search_Lucene_Analysis_Analyzer_Common_Utf8_CaseInsensitive</classname>,
             <classname>Zend_Search_Lucene_Analysis_Analyzer_Common_Utf8Num_CaseInsensitive</classname>.
         </para>
 
@@ -81,19 +90,23 @@ Zend_Search_Lucene_Analysis_Analyzer::setDefault(
         <warning>
             <title/>
             <para>
-                UTF-8 compatible analyzers were improved in Zend Framework 1.5. Early versions of analyzers assumed
-                all non-ascii characters are letters. New analyzers implementation has more accurate behavior.
+                UTF-8 compatible analyzers were improved in Zend Framework 1.5. Early versions of
+                analyzers assumed all non-ascii characters are letters. New analyzers implementation
+                has more accurate behavior.
             </para>
+
             <para>
-                This may need you to re-build index to have data and search queries tokenized in the same way, otherwise search engine
-                may return wrong result sets.
+                This may need you to re-build index to have data and search queries tokenized in the
+                same way, otherwise search engine may return wrong result sets.
             </para>
         </warning>
 
         <para>
-            All of these analyzers need PCRE (Perl-compatible regular expressions) library to be compiled with UTF-8 support turned on.
-            PCRE UTF-8 support is turned on for the PCRE library sources bundled with <acronym>PHP</acronym> source code distribution, but if shared library is used
-            instead of bundled with <acronym>PHP</acronym> sources, then UTF-8 support state may depend on you operating system.
+            All of these analyzers need PCRE (Perl-compatible regular expressions) library to be
+            compiled with UTF-8 support turned on. PCRE UTF-8 support is turned on for the PCRE
+            library sources bundled with <acronym>PHP</acronym> source code distribution, but if
+            shared library is used instead of bundled with <acronym>PHP</acronym> sources, then
+            UTF-8 support state may depend on you operating system.
         </para>
 
         <para>
@@ -109,12 +122,15 @@ if (@preg_match('/\pL/u', 'a') == 1) {
         </para>
 
         <para>
-            Case insensitive versions of UTF-8 compatible analyzers also need <ulink url="http://www.php.net/manual/en/ref.mbstring.php">mbstring</ulink> extension to be enabled.
+            Case insensitive versions of UTF-8 compatible analyzers also need <ulink
+                url="http://www.php.net/manual/en/ref.mbstring.php">mbstring</ulink> extension to
+            be enabled.
         </para>
 
         <para>
-            If you don't want mbstring extension to be turned on, but need case insensitive search, you may use the following approach: normalize source data before indexing
-            and query string before searching by converting them to lowercase:
+            If you don't want mbstring extension to be turned on, but need case insensitive search,
+            you may use the following approach: normalize source data before indexing and query
+            string before searching by converting them to lowercase:
 
             <programlisting language="php"><![CDATA[
 // Indexing

documentation/manual/en/module_specs/Zend_Search_Lucene-Extending.xml

@@ -5,24 +5,25 @@
 
     <sect2 id="zend.search.lucene.extending.analysis">
         <title>Text Analysis</title>
+
         <para>
-            The <classname>Zend_Search_Lucene_Analysis_Analyzer</classname> class is used by the indexer to tokenize document
-            text fields.
+            The <classname>Zend_Search_Lucene_Analysis_Analyzer</classname> class is used by the
+            indexer to tokenize document text fields.
         </para>
 
         <para>
-            The <methodname>Zend_Search_Lucene_Analysis_Analyzer::getDefault()</methodname> and <code>
-            Zend_Search_Lucene_Analysis_Analyzer::setDefault()</code> methods are used
+            The <methodname>Zend_Search_Lucene_Analysis_Analyzer::getDefault()</methodname> and
+            <code>Zend_Search_Lucene_Analysis_Analyzer::setDefault()</code> methods are used
             to get and set the default analyzer.
         </para>
 
         <para>
             You can assign your own text analyzer or choose it from the set of predefined analyzers:
             <classname>Zend_Search_Lucene_Analysis_Analyzer_Common_Text</classname> and
-            <classname>Zend_Search_Lucene_Analysis_Analyzer_Common_Text_CaseInsensitive</classname> (default).
-            Both of them interpret tokens as sequences of letters.
-            <classname>Zend_Search_Lucene_Analysis_Analyzer_Common_Text_CaseInsensitive</classname> converts all tokens
-            to lower case.
+            <classname>Zend_Search_Lucene_Analysis_Analyzer_Common_Text_CaseInsensitive</classname>
+            (default). Both of them interpret tokens as sequences of letters.
+            <classname>Zend_Search_Lucene_Analysis_Analyzer_Common_Text_CaseInsensitive</classname>
+            converts all tokens to lower case.
         </para>
 
         <para>
@@ -37,15 +38,17 @@ $index->addDocument($doc);
 ]]></programlisting>
 
         <para>
-            The <classname>Zend_Search_Lucene_Analysis_Analyzer_Common</classname> class is designed to be an ancestor of all user
-            defined analyzers. User should only define the <methodname>reset()</methodname> and <methodname>nextToken()</methodname> methods,
-            which takes its string from the $_input member and returns tokens one by one
-            (a <constant>NULL</constant> value indicates the end of the stream).
+            The <classname>Zend_Search_Lucene_Analysis_Analyzer_Common</classname> class is designed
+            to be an ancestor of all user defined analyzers. User should only define the
+            <methodname>reset()</methodname> and <methodname>nextToken()</methodname> methods, which
+            takes its string from the $_input member and returns tokens one by one (a
+            <constant>NULL</constant> value indicates the end of the stream).
         </para>
 
         <para>
-            The <methodname>nextToken()</methodname> method should call the <methodname>normalize()</methodname> method on each
-            token. This will allow you to use token filters with your analyzer.
+            The <methodname>nextToken()</methodname> method should call the
+            <methodname>normalize()</methodname> method on each token. This will allow you to use
+            token filters with your analyzer.
         </para>
 
         <para>
@@ -53,6 +56,7 @@ $index->addDocument($doc);
 
             <example id="zend.search.lucene.extending.analysis.example-1">
                 <title>Custom text Analyzer</title>
+
                 <programlisting language="php"><![CDATA[
 /**
  * Here is a custom text analyser, which treats words with digits as
@@ -131,34 +135,39 @@ Zend_Search_Lucene_Analysis_Analyzer::setDefault(
 
     <sect2 id="zend.search.lucene.extending.filters">
         <title>Tokens Filtering</title>
+
         <para>
-            The <classname>Zend_Search_Lucene_Analysis_Analyzer_Common</classname> analyzer also offers a token filtering
-            mechanism.
+            The <classname>Zend_Search_Lucene_Analysis_Analyzer_Common</classname> analyzer also
+            offers a token filtering mechanism.
         </para>
 
         <para>
-            The <classname>Zend_Search_Lucene_Analysis_TokenFilter</classname> class provides an abstract interface for such filters.
-            Your own filters should extend this class either directly or indirectly.
+            The <classname>Zend_Search_Lucene_Analysis_TokenFilter</classname> class provides an
+            abstract interface for such filters. Your own filters should extend this class either
+            directly or indirectly.
         </para>
 
         <para>
-            Any custom filter must implement the <methodname>normalize()</methodname> method which may transform input token or signal that
-            the current token should be skipped.
+            Any custom filter must implement the <methodname>normalize()</methodname> method which
+            may transform input token or signal that the current token should be skipped.
         </para>
 
         <para>
             There are three filters already defined in the analysis subpackage:
+
             <itemizedlist>
                 <listitem>
                     <para>
                         <classname>Zend_Search_Lucene_Analysis_TokenFilter_LowerCase</classname>
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
                         <classname>Zend_Search_Lucene_Analysis_TokenFilter_ShortWords</classname>
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
                         <classname>Zend_Search_Lucene_Analysis_TokenFilter_StopWords</classname>
@@ -169,13 +178,14 @@ Zend_Search_Lucene_Analysis_Analyzer::setDefault(
 
         <para>
             The <code>LowerCase</code> filter is already used for
-            <classname>Zend_Search_Lucene_Analysis_Analyzer_Common_Text_CaseInsensitive</classname> analyzer
-            by default.
+            <classname>Zend_Search_Lucene_Analysis_Analyzer_Common_Text_CaseInsensitive</classname>
+            analyzer by default.
         </para>
 
         <para>
-            The <code>ShortWords</code> and <code>StopWords</code> filters may be used with pre-defined or custom
-            analyzers like this:
+            The <code>ShortWords</code> and <code>StopWords</code> filters may be used with
+            pre-defined or custom analyzers like this:
+
             <programlisting language="php"><![CDATA[
 $stopWords = array('a', 'an', 'at', 'the', 'and', 'or', 'is', 'am');
 $stopWordsFilter =
@@ -199,8 +209,9 @@ Zend_Search_Lucene_Analysis_Analyzer::setDefault($analyzer);
         </para>
 
         <para>
-            The <classname>Zend_Search_Lucene_Analysis_TokenFilter_StopWords</classname> constructor takes an array of stop-words
-            as an input. But stop-words may be also loaded from a file:
+            The <classname>Zend_Search_Lucene_Analysis_TokenFilter_StopWords</classname> constructor
+            takes an array of stop-words as an input. But stop-words may be also loaded from a file:
+
             <programlisting language="php"><![CDATA[
 $stopWordsFilter = new Zend_Search_Lucene_Analysis_TokenFilter_StopWords();
 $stopWordsFilter->loadFromFile($my_stopwords_file);
@@ -211,34 +222,39 @@ $analyzer->addFilter($stopWordsFilter);
 
 Zend_Search_Lucene_Analysis_Analyzer::setDefault($analyzer);
 ]]></programlisting>
-            This file should be a common text file with one word in each line. The '#' character marks a line as a comment.
+
+            This file should be a common text file with one word in each line. The '#' character
+            marks a line as a comment.
         </para>
 
         <para>
-            The <classname>Zend_Search_Lucene_Analysis_TokenFilter_ShortWords</classname> constructor has one optional argument.
-            This is the word length limit, set by default to 2.
+            The <classname>Zend_Search_Lucene_Analysis_TokenFilter_ShortWords</classname>
+            constructor has one optional argument. This is the word length limit, set by default to
+            2.
         </para>
-
     </sect2>
 
     <sect2 id="zend.search.lucene.extending.scoring">
         <title>Scoring Algorithms</title>
+
         <para>
             The score of a document <literal>d</literal> for a query <literal>q</literal>
             is defined as follows:
         </para>
 
         <para>
-            <code>score(q,d) = sum( tf(t in d) * idf(t) * getBoost(t.field in d) * lengthNorm(t.field in d) ) *
-            coord(q,d) * queryNorm(q)</code>
+            <code>score(q,d) = sum( tf(t in d) * idf(t) * getBoost(t.field in d) *
+                lengthNorm(t.field in d) ) * coord(q,d) * queryNorm(q)</code>
         </para>
 
         <para>
-            tf(t in d) - <methodname>Zend_Search_Lucene_Search_Similarity::tf($freq)</methodname> - a score factor based on the frequency of a term or phrase in a document.
+            tf(t in d) - <methodname>Zend_Search_Lucene_Search_Similarity::tf($freq)</methodname> -
+            a score factor based on the frequency of a term or phrase in a document.
         </para>
 
         <para>
-            idf(t) - <methodname>Zend_Search_Lucene_Search_Similarity::idf($input, $reader)</methodname> - a score factor for a simple term with the specified index.
+            idf(t) - <methodname>Zend_Search_Lucene_Search_Similarity::idf($input,
+                $reader)</methodname> - a score factor for a simple term with the specified index.
         </para>
 
         <para>
@@ -251,14 +267,17 @@ Zend_Search_Lucene_Analysis_Analyzer::setDefault($analyzer);
             These values, together with field boosts, are stored in an index and multiplied
             into scores for hits on each field by the search code.
         </para>
+
         <para>
-            Matches in longer fields are less precise, so implementations of this method
-            usually return smaller values when numTokens is large, and larger values when numTokens is small.
+            Matches in longer fields are less precise, so implementations of this method usually
+            return smaller values when numTokens is large, and larger values when numTokens is
+            small.
         </para>
 
         <para>
-            coord(q,d) - <methodname>Zend_Search_Lucene_Search_Similarity::coord($overlap, $maxOverlap)</methodname> - a
-            score factor based on the fraction of all query terms that a document contains.
+            coord(q,d) - <methodname>Zend_Search_Lucene_Search_Similarity::coord($overlap,
+                $maxOverlap)</methodname> - a score factor based on the fraction of all query terms
+            that a document contains.
         </para>
 
         <para>
@@ -280,9 +299,11 @@ Zend_Search_Lucene_Analysis_Analyzer::setDefault($analyzer);
         </para>
 
         <para>
-            The scoring algorithm can be customized by defining your own Similarity class. To do this
-            extend the <classname>Zend_Search_Lucene_Search_Similarity</classname> class as defined below, then use
-            the <classname>Zend_Search_Lucene_Search_Similarity::setDefault($similarity);</classname> method to set it as default.
+            The scoring algorithm can be customized by defining your own Similarity class. To do
+            this extend the <classname>Zend_Search_Lucene_Search_Similarity</classname> class as
+            defined below, then use the
+            <classname>Zend_Search_Lucene_Search_Similarity::setDefault($similarity);</classname>
+            method to set it as default.
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -323,35 +344,38 @@ Zend_Search_Lucene_Search_Similarity::setDefault($mySimilarity);
 
     <sect2 id="zend.search.lucene.extending.storage">
         <title>Storage Containers</title>
+
         <para>
-        The abstract class <classname>Zend_Search_Lucene_Storage_Directory</classname> defines directory functionality.
+            The abstract class <classname>Zend_Search_Lucene_Storage_Directory</classname> defines
+            directory functionality.
         </para>
 
         <para>
-        The <classname>Zend_Search_Lucene</classname> constructor uses either a string or a
-        <classname>Zend_Search_Lucene_Storage_Directory</classname> object
-        as an input.
+            The <classname>Zend_Search_Lucene</classname> constructor uses either a string or a
+            <classname>Zend_Search_Lucene_Storage_Directory</classname> object as an input.
         </para>
 
         <para>
-        The <classname>Zend_Search_Lucene_Storage_Directory_Filesystem</classname> class implements directory
-        functionality for a file system.
+            The <classname>Zend_Search_Lucene_Storage_Directory_Filesystem</classname> class
+            implements directory functionality for a file system.
         </para>
 
         <para>
-        If a string is used as an input for the <classname>Zend_Search_Lucene</classname> constructor, then the index
-        reader (<classname>Zend_Search_Lucene</classname> object) treats it as a file system path and instantiates
-        the <classname>Zend_Search_Lucene_Storage_Directory_Filesystem</classname> object.
+            If a string is used as an input for the <classname>Zend_Search_Lucene</classname>
+            constructor, then the index reader (<classname>Zend_Search_Lucene</classname> object)
+            treats it as a file system path and instantiates the
+            <classname>Zend_Search_Lucene_Storage_Directory_Filesystem</classname> object.
         </para>
 
         <para>
-        You can define your own directory implementation by extending the
-        <classname>Zend_Search_Lucene_Storage_Directory</classname> class.
+            You can define your own directory implementation by extending the
+            <classname>Zend_Search_Lucene_Storage_Directory</classname> class.
         </para>
 
         <para>
-        <classname>Zend_Search_Lucene_Storage_Directory</classname> methods:
+            <classname>Zend_Search_Lucene_Storage_Directory</classname> methods:
         </para>
+
         <programlisting language="php"><![CDATA[
 abstract class Zend_Search_Lucene_Storage_Directory {
 /**
@@ -431,20 +455,26 @@ abstract function getFileObject($filename);
 ]]></programlisting>
 
         <para>
-        The <methodname>getFileObject($filename)</methodname> method of a <classname>Zend_Search_Lucene_Storage_Directory</classname>
-        instance returns a <classname>Zend_Search_Lucene_Storage_File</classname> object.
+            The <methodname>getFileObject($filename)</methodname> method of a
+            <classname>Zend_Search_Lucene_Storage_Directory</classname> instance returns a
+            <classname>Zend_Search_Lucene_Storage_File</classname> object.
         </para>
+
         <para>
-        The <classname>Zend_Search_Lucene_Storage_File</classname> abstract class implements file abstraction and index
-        file reading primitives.
+            The <classname>Zend_Search_Lucene_Storage_File</classname> abstract class implements
+            file abstraction and index file reading primitives.
         </para>
+
         <para>
-        You must also extend <classname>Zend_Search_Lucene_Storage_File</classname> for your directory implementation.
+            You must also extend <classname>Zend_Search_Lucene_Storage_File</classname> for your
+            directory implementation.
         </para>
+
         <para>
-        Only two methods of <classname>Zend_Search_Lucene_Storage_File</classname> must be overridden in your
-        implementation:
+            Only two methods of <classname>Zend_Search_Lucene_Storage_File</classname> must be
+            overridden in your implementation:
         </para>
+
         <programlisting language="php"><![CDATA[
 class MyFile extends Zend_Search_Lucene_Storage_File {
     /**
@@ -478,10 +508,8 @@ class MyFile extends Zend_Search_Lucene_Storage_File {
     }
 }
 ]]></programlisting>
-
     </sect2>
 </sect1>
-
 <!--
 vim:se ts=4 sw=4 et:
 -->

documentation/manual/en/module_specs/Zend_Search_Lucene-IndexCreation.xml

@@ -7,8 +7,10 @@
         <title>Creating a New Index</title>
 
         <para>
-            Index creation and updating capabilities are implemented within the <classname>Zend_Search_Lucene</classname> component, as well as the Java Lucene project.
-            You can use either of these options to create indexes that <classname>Zend_Search_Lucene</classname> can search.
+            Index creation and updating capabilities are implemented within the
+            <classname>Zend_Search_Lucene</classname> component, as well as the Java Lucene project.
+            You can use either of these options to create indexes that
+            <classname>Zend_Search_Lucene</classname> can search.
         </para>
 
         <para>
@@ -70,8 +72,8 @@ $index->addDocument($doc);
         </para>
 
         <para>
-            <methodname>Zend_Search_Lucene::delete()</methodname> method operates with an internal index document id. It can be retrieved
-            from a query hit by 'id' property:
+            <methodname>Zend_Search_Lucene::delete()</methodname> method operates with an internal
+            index document id. It can be retrieved from a query hit by 'id' property:
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -87,17 +89,20 @@ foreach ($hits as $hit) {
         <title>Retrieving Index Size</title>
 
         <para>
-            There are two methods to retrieve the size of an index in <classname>Zend_Search_Lucene</classname>.
+            There are two methods to retrieve the size of an index in
+            <classname>Zend_Search_Lucene</classname>.
         </para>
 
         <para>
-             <methodname>Zend_Search_Lucene::maxDoc()</methodname> returns one greater than the largest possible document number.
-             It's actually the overall number of the documents in the index including deleted documents,
-             so it has a synonym: <methodname>Zend_Search_Lucene::count()</methodname>.
+             <methodname>Zend_Search_Lucene::maxDoc()</methodname> returns one greater than the
+             largest possible document number. It's actually the overall number of the documents in
+             the index including deleted documents, so it has a synonym:
+             <methodname>Zend_Search_Lucene::count()</methodname>.
         </para>
 
         <para>
-             <methodname>Zend_Search_Lucene::numDocs()</methodname> returns the total number of non-deleted documents.
+             <methodname>Zend_Search_Lucene::numDocs()</methodname> returns the total number of
+             non-deleted documents.
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -106,7 +111,8 @@ $documents = $index->numDocs();
 ]]></programlisting>
 
         <para>
-            <methodname>Zend_Search_Lucene::isDeleted($id)</methodname> method may be used to check if a document is deleted.
+            <methodname>Zend_Search_Lucene::isDeleted($id)</methodname> method may be used to check
+            if a document is deleted.
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -118,8 +124,8 @@ for ($count = 0; $count < $index->maxDoc(); $count++) {
 ]]></programlisting>
 
         <para>
-            Index optimization removes deleted documents and squeezes documents' IDs in to a smaller range.
-            A document's internal id may therefore change during index optimization.
+            Index optimization removes deleted documents and squeezes documents' IDs in to a smaller
+            range. A document's internal id may therefore change during index optimization.
         </para>
     </sect2>
 
@@ -127,27 +133,38 @@ for ($count = 0; $count < $index->maxDoc(); $count++) {
         <title>Index optimization</title>
 
         <para>
-            A Lucene index consists of many segments. Each segment is a completely independent set of data.
+            A Lucene index consists of many segments. Each segment is a completely independent set
+            of data.
         </para>
+
         <para>
-            Lucene index segment files can't be updated by design. A segment update needs full segment
-            reorganization. See Lucene index file formats for details
-            (<ulink url="http://lucene.apache.org/java/2_3_0/fileformats.html">http://lucene.apache.org/java/2_3_0/fileformats.html</ulink>)
+            Lucene index segment files can't be updated by design. A segment update needs full
+            segment reorganization. See Lucene index file formats for details (<ulink
+                url="http://lucene.apache.org/java/2_3_0/fileformats.html">http://lucene.apache.org/java/2_3_0/fileformats.html</ulink>)
+
             <footnote>
-                <para>The currently supported Lucene index file format is version 2.3 (starting from Zend Framework 1.6).</para>
+                <para>
+                    The currently supported Lucene index file format is version 2.3 (starting from
+                    Zend Framework 1.6).
+                </para>
             </footnote>.
+
             New documents are added to the index by creating new segment.
         </para>
+
         <para>
-            Increasing number of segments reduces quality of the index, but index optimization restores it.
-            Optimization essentially merges several segments into a new one. This process also doesn't update segments.
-            It generates one new large segment and updates segment list ('segments' file).
+            Increasing number of segments reduces quality of the index, but index optimization
+            restores it. Optimization essentially merges several segments into a new one. This
+            process also doesn't update segments. It generates one new large segment and updates
+            segment list ('segments' file).
         </para>
 
         <para>
-            Full index optimization can be trigger by calling the <methodname>Zend_Search_Lucene::optimize()</methodname> method. It merges all
-            index segments into one new segment:
+            Full index optimization can be trigger by calling the
+            <methodname>Zend_Search_Lucene::optimize()</methodname> method. It merges all index
+            segments into one new segment:
         </para>
+
         <programlisting language="php"><![CDATA[
 // Open existing index
 $index = Zend_Search_Lucene::open('/data/my-index');
@@ -159,21 +176,27 @@ $index->optimize();
         <para>
             Automatic index optimization is performed to keep indexes in a consistent state.
         </para>
+
         <para>
-            Automatic optimization is an iterative process managed by several index options. It merges very small segments
-            into larger ones, then merges these larger segments into even larger segments and so on.
+            Automatic optimization is an iterative process managed by several index options. It
+            merges very small segments into larger ones, then merges these larger segments into even
+            larger segments and so on.
         </para>
 
         <sect3 id="zend.search.lucene.index-creation.optimization.maxbuffereddocs">
             <title>MaxBufferedDocs auto-optimization option</title>
+
             <para>
-                <emphasis>MaxBufferedDocs</emphasis> is a minimal number of documents required before
-                the buffered in-memory documents are written into a new segment.
+                <emphasis>MaxBufferedDocs</emphasis> is a minimal number of documents required
+                before the buffered in-memory documents are written into a new segment.
             </para>
+
             <para>
-                <emphasis>MaxBufferedDocs</emphasis> can be retrieved or set by <code>$index->getMaxBufferedDocs()</code> or
+                <emphasis>MaxBufferedDocs</emphasis> can be retrieved or set by
+                <code>$index->getMaxBufferedDocs()</code> or
                 <code>$index->setMaxBufferedDocs($maxBufferedDocs)</code> calls.
             </para>
+
             <para>
                 Default value is 10.
             </para>
@@ -181,16 +204,20 @@ $index->optimize();
 
         <sect3 id="zend.search.lucene.index-creation.optimization.maxmergedocs">
             <title>MaxMergeDocs auto-optimization option</title>
+
             <para>
-                <emphasis>MaxMergeDocs</emphasis> is a largest number of documents ever merged by addDocument().
-                Small values (e.g., less than 10.000) are best for interactive indexing, as this limits the length
-                of pauses while indexing to a few seconds. Larger values are best for batched indexing and speedier
-                searches.
+                <emphasis>MaxMergeDocs</emphasis> is a largest number of documents ever merged by
+                addDocument(). Small values (e.g., less than 10.000) are best for interactive
+                indexing, as this limits the length of pauses while indexing to a few seconds.
+                Larger values are best for batched indexing and speedier searches.
             </para>
+
             <para>
-                <emphasis>MaxMergeDocs</emphasis> can be retrieved or set by <code>$index->getMaxMergeDocs()</code> or
+                <emphasis>MaxMergeDocs</emphasis> can be retrieved or set by
+                <code>$index->getMaxMergeDocs()</code> or
                 <code>$index->setMaxMergeDocs($maxMergeDocs)</code> calls.
             </para>
+
             <para>
                 Default value is PHP_INT_MAX.
             </para>
@@ -198,36 +225,57 @@ $index->optimize();
 
         <sect3 id="zend.search.lucene.index-creation.optimization.mergefactor">
             <title>MergeFactor auto-optimization option</title>
+
             <para>
-                <emphasis>MergeFactor</emphasis> determines how often segment indices are merged by addDocument().
-                With smaller values, less <acronym>RAM</acronym> is used while indexing, and searches on unoptimized indices are faster,
-                but indexing speed is slower. With larger values, more <acronym>RAM</acronym> is used during indexing, and while searches
-                on unoptimized indices are slower, indexing is faster. Thus larger values (&gt; 10) are best for batch
-                index creation, and smaller values (&lt; 10) for indices that are interactively maintained.
+                <emphasis>MergeFactor</emphasis> determines how often segment indices are merged by
+                addDocument(). With smaller values, less <acronym>RAM</acronym> is used while
+                indexing, and searches on unoptimized indices are faster, but indexing speed is
+                slower. With larger values, more <acronym>RAM</acronym> is used during indexing, and
+                while searches on unoptimized indices are slower, indexing is faster. Thus larger
+                values (&gt; 10) are best for batch index creation, and smaller values (&lt; 10) for
+                indices that are interactively maintained.
             </para>
+
             <para>
-                <emphasis>MergeFactor</emphasis> is a good estimation for average number of segments merged by one auto-optimization pass.
-                Too large values produce large number of segments while they are not merged into new one. It may be a cause of
-                "failed to open stream: Too many open files" error message. This limitation is system dependent.
+                <emphasis>MergeFactor</emphasis> is a good estimation for average number of segments
+                merged by one auto-optimization pass. Too large values produce large number of
+                segments while they are not merged into new one. It may be a cause of "failed to
+                open stream: Too many open files" error message. This limitation is system
+                dependent.
             </para>
+
             <para>
-                <emphasis>MergeFactor</emphasis> can be retrieved or set by <code>$index->getMergeFactor()</code> or
+                <emphasis>MergeFactor</emphasis> can be retrieved or set by
+                <code>$index->getMergeFactor()</code> or
                 <code>$index->setMergeFactor($mergeFactor)</code> calls.
             </para>
+
             <para>
                 Default value is 10.
             </para>
+
             <para>
-                Lucene Java and Luke (Lucene Index Toolbox - <ulink url="http://www.getopt.org/luke/">http://www.getopt.org/luke/</ulink>)
-                can also be used to optimize an index. Latest Luke release (v0.8) is based on Lucene v2.3 and compatible with
-                current implementation of <classname>Zend_Search_Lucene</classname> component (Zend Framework 1.6). Earlier versions of <classname>Zend_Search_Lucene</classname> implementations
-                need another versions of Java Lucene tools to be compatible:
+                Lucene Java and Luke (Lucene Index Toolbox - <ulink
+                    url="http://www.getopt.org/luke/">http://www.getopt.org/luke/</ulink>) can also
+                be used to optimize an index. Latest Luke release (v0.8) is based on Lucene v2.3 and
+                compatible with current implementation of <classname>Zend_Search_Lucene</classname>
+                component (Zend Framework 1.6). Earlier versions of
+                <classname>Zend_Search_Lucene</classname> implementations need another versions of
+                Java Lucene tools to be compatible:
+
                 <itemizedlist>
                     <listitem>
-                        <para>Zend Framework 1.5 - Java Lucene 2.1 (Luke tool v0.7.1 - <ulink url="http://www.getopt.org/luke/luke-0.7.1/"/>)</para>
+                        <para>
+                            Zend Framework 1.5 - Java Lucene 2.1 (Luke tool v0.7.1 - <ulink
+                                url="http://www.getopt.org/luke/luke-0.7.1/"/>)
+                        </para>
                     </listitem>
+
                     <listitem>
-                        <para>Zend Framework 1.0 - Java Lucene 1.4 - 2.1 (Luke tool v0.6 - <ulink url="http://www.getopt.org/luke/luke-0.6/"/>)</para>
+                        <para>
+                            Zend Framework 1.0 - Java Lucene 1.4 - 2.1 (Luke tool v0.6 - <ulink
+                                url="http://www.getopt.org/luke/luke-0.6/"/>)
+                        </para>
                     </listitem>
                 </itemizedlist>
             </para>
@@ -242,7 +290,9 @@ $index->optimize();
         </para>
 
         <para>
-            It's possible to override this with the <methodname>Zend_Search_Lucene_Storage_Directory_Filesystem::setDefaultFilePermissions()</methodname> method:
+            It's possible to override this with the
+            <methodname>Zend_Search_Lucene_Storage_Directory_Filesystem::setDefaultFilePermissions()</methodname>
+            method:
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -260,6 +310,7 @@ Zend_Search_Lucene_Storage_Directory_Filesystem::setDefaultFilePermissions(0660)
 
         <sect3 id="zend.search.lucene.index-creation.limitations.index-size">
             <title>Index size</title>
+
             <para>
                 Index size is limited by 2GB for 32-bit platforms.
             </para>
@@ -271,13 +322,17 @@ Zend_Search_Lucene_Storage_Directory_Filesystem::setDefaultFilePermissions(0660)
 
         <sect3 id="zend.search.lucene.index-creation.limitations.filesystems">
             <title>Supported Filesystems</title>
+
             <para>
-                <classname>Zend_Search_Lucene</classname> uses <methodname>flock()</methodname> to provide concurrent searching, index updating and optimization.
+                <classname>Zend_Search_Lucene</classname> uses <methodname>flock()</methodname> to
+                provide concurrent searching, index updating and optimization.
             </para>
 
             <para>
-                According to the <acronym>PHP</acronym> <ulink url="http://www.php.net/manual/en/function.flock.php">documentation</ulink>,
-                "<methodname>flock()</methodname> will not work on NFS and many other networked file systems".
+                According to the <acronym>PHP</acronym> <ulink
+                    url="http://www.php.net/manual/en/function.flock.php">documentation</ulink>,
+                "<methodname>flock()</methodname> will not work on NFS and many other networked file
+                systems".
             </para>
 
             <para>
@@ -286,7 +341,6 @@ Zend_Search_Lucene_Storage_Directory_Filesystem::setDefaultFilePermissions(0660)
         </sect3>
     </sect2>
 </sect1>
-
 <!--
 vim:se ts=4 sw=4 et:
 -->

documentation/manual/en/module_specs/Zend_Search_Lucene-JavaLucene.xml

@@ -5,15 +5,21 @@
 
     <sect2 id="zend.search.lucene.index-creation.file-formats">
         <title>File Formats</title>
+
         <para>
-          <classname>Zend_Search_Lucene</classname> index file formats are binary compatible with Java Lucene
-          version 1.4 and greater.
+            <classname>Zend_Search_Lucene</classname> index file formats are binary compatible with
+            Java Lucene version 1.4 and greater.
         </para>
 
         <para>
-          A detailed description of this format is available here:
-          <ulink url="http://lucene.apache.org/java/2_3_0/fileformats.html"/>
-          <footnote><para>The currently supported Lucene index file format version is 2.3 (starting from Zend Framework 1.6).</para></footnote>.
+            A detailed description of this format is available here:
+            <ulink url="http://lucene.apache.org/java/2_3_0/fileformats.html"/>
+            <footnote>
+                <para>
+                    The currently supported Lucene index file format version is 2.3 (starting from
+                    Zend Framework 1.6).
+                </para>
+            </footnote>.
         </para>
     </sect2>
 
@@ -21,25 +27,27 @@
         <title>Index Directory</title>
 
         <para>
-        After index creation, the index directory will contain several files:
+            After index creation, the index directory will contain several files:
         </para>
 
         <itemizedlist>
             <listitem>
                 <para>
-                The <filename>segments</filename> file is a list of index segments.
+                    The <filename>segments</filename> file is a list of index segments.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
-                The <filename>*.cfs</filename> files contain index segments.
-                Note! An optimized index always has only one segment.
+                    The <filename>*.cfs</filename> files contain index segments.
+                    Note! An optimized index always has only one segment.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
-                The <filename>deletable</filename> file is a list of files that are no longer used
-                by the index, but which could not be deleted.
+                    The <filename>deletable</filename> file is a list of files that are no longer
+                    used by the index, but which could not be deleted.
                 </para>
             </listitem>
         </itemizedlist>
@@ -47,6 +55,7 @@
 
     <sect2 id="zend.search.lucene.java-lucene.source-code">
         <title>Java Source Code</title>
+
         <para>
             The Java program listing below provides an example of how to index a file
             using Java Lucene:
@@ -83,7 +92,6 @@ indexWriter.addDocument(doc);
 ]]></programlisting>
     </sect2>
 </sect1>
-
 <!--
 vim:se ts=4 sw=4 et:
 -->

documentation/manual/en/module_specs/Zend_Search_Lucene-Searching.xml

@@ -9,7 +9,8 @@
         <para>
             There are two ways to search the index. The first method uses
             query parser to construct a query from a string. The second is
-            to programmatically create your own queries through the <classname>Zend_Search_Lucene</classname> <acronym>API</acronym>.
+            to programmatically create your own queries through the
+            <classname>Zend_Search_Lucene</classname> <acronym>API</acronym>.
         </para>
 
         <para>
@@ -20,11 +21,13 @@
                 <listitem>
                     <para>
                         If you are programmatically creating a query string and then parsing
-                        it with the query parser then you should consider building
-                        your queries directly with the query <acronym>API</acronym>. Generally speaking, the query
-                        parser is designed for human-entered text, not for program-generated text.
+                        it with the query parser then you should consider building your queries
+                        directly with the query <acronym>API</acronym>. Generally speaking, the
+                        query parser is designed for human-entered text, not for program-generated
+                        text.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
                         Untokenized fields are best added directly to queries and not through
@@ -36,24 +39,26 @@
                         keywords, etc., should be added with the query <acronym>API</acronym>.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
                         In a query form, fields that are general text should use the query parser.
                         All others, such as date ranges, keywords, etc., are better added directly
-                        through the query <acronym>API</acronym>. A field with a limited set of values that can be
-                        specified with a pull-down menu should not be added to a query string
-                        that is subsequently parsed but instead should be added as a TermQuery clause.
+                        through the query <acronym>API</acronym>. A field with a limited set of
+                        values that can be specified with a pull-down menu should not be added to a
+                        query string that is subsequently parsed but instead should be added as a
+                        TermQuery clause.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        Boolean queries allow the programmer to logically combine two or more queries into new one.
-                        Thus it's the best way to add additional criteria to a search defined by
-                        a query string.
+                        Boolean queries allow the programmer to logically combine two or more
+                        queries into new one. Thus it's the best way to add additional criteria to a
+                        search defined by a query string.
                     </para>
                 </listitem>
             </orderedlist>
-
         </para>
 
         <para>
@@ -65,38 +70,46 @@ $index = Zend_Search_Lucene::open('/data/my_index');
 
 $index->find($query);
 ]]></programlisting>
+
         <para>
-            The <methodname>Zend_Search_Lucene::find()</methodname> method determines the input type automatically and
-            uses the query parser to construct an appropriate <classname>Zend_Search_Lucene_Search_Query</classname> object
-            from an input of type string.
+            The <methodname>Zend_Search_Lucene::find()</methodname> method determines the input type
+            automatically and uses the query parser to construct an appropriate
+            <classname>Zend_Search_Lucene_Search_Query</classname> object from an input of type
+            string.
         </para>
 
         <para>
-            It is important to note that the query parser uses the standard analyzer to tokenize separate parts of query string.
-            Thus all transformations which are applied to indexed text are also applied to query strings.
+            It is important to note that the query parser uses the standard analyzer to tokenize
+            separate parts of query string. Thus all transformations which are applied to indexed
+            text are also applied to query strings.
         </para>
+
         <para>
-            The standard analyzer may transform the query string to lower case for case-insensitivity, remove stop-words, and stem among other transformations.
+            The standard analyzer may transform the query string to lower case for
+            case-insensitivity, remove stop-words, and stem among other transformations.
         </para>
+
         <para>
-            The <acronym>API</acronym> method doesn't transform or filter input terms in any way. It's therefore more suitable for
-            computer generated or untokenized fields.
+            The <acronym>API</acronym> method doesn't transform or filter input terms in any way.
+            It's therefore more suitable for computer generated or untokenized fields.
         </para>
 
         <sect3 id="zend.search.lucene.searching.query_building.parsing">
             <title>Query Parsing</title>
+
             <para>
-                <methodname>Zend_Search_Lucene_Search_QueryParser::parse()</methodname> method may be used to parse query strings
-                into query objects.
+                <methodname>Zend_Search_Lucene_Search_QueryParser::parse()</methodname> method may
+                be used to parse query strings into query objects.
             </para>
 
             <para>
-                This query object may be used in query construction <acronym>API</acronym> methods to combine user entered queries with
-                programmatically generated queries.
+                This query object may be used in query construction <acronym>API</acronym> methods
+                to combine user entered queries with programmatically generated queries.
             </para>
 
             <para>
-                Actually, in some cases it's the only way to search for values within untokenized fields:
+                Actually, in some cases it's the only way to search for values within untokenized
+                fields:
 
                 <programlisting language="php"><![CDATA[
 $userQuery = Zend_Search_Lucene_Search_QueryParser::parse($queryStr);
@@ -115,9 +128,10 @@ $hits = $index->find($query);
             </para>
 
             <para>
-                <methodname>Zend_Search_Lucene_Search_QueryParser::parse()</methodname> method also takes an optional encoding parameter,
-                which can specify query string encoding:
-            <programlisting language="php"><![CDATA[
+                <methodname>Zend_Search_Lucene_Search_QueryParser::parse()</methodname> method also
+                takes an optional encoding parameter, which can specify query string encoding:
+
+                <programlisting language="php"><![CDATA[
 $userQuery = Zend_Search_Lucene_Search_QueryParser::parse($queryStr,
                                                           'iso-8859-5');
 ]]></programlisting>
@@ -129,7 +143,9 @@ $userQuery = Zend_Search_Lucene_Search_QueryParser::parse($queryStr,
 
             <para>
                 It's also possible to specify the default query string encoding with
-                <methodname>Zend_Search_Lucene_Search_QueryParser::setDefaultEncoding()</methodname> method:
+                <methodname>Zend_Search_Lucene_Search_QueryParser::setDefaultEncoding()</methodname>
+                method:
+
                 <programlisting language="php"><![CDATA[
 Zend_Search_Lucene_Search_QueryParser::setDefaultEncoding('iso-8859-5');
 ...
@@ -138,25 +154,31 @@ $userQuery = Zend_Search_Lucene_Search_QueryParser::parse($queryStr);
             </para>
 
             <para>
-                <methodname>Zend_Search_Lucene_Search_QueryParser::getDefaultEncoding()</methodname> returns the current default query
-                string encoding (the empty string means "current locale").
+                <methodname>Zend_Search_Lucene_Search_QueryParser::getDefaultEncoding()</methodname>
+                returns the current default query string encoding (the empty string means "current
+                locale").
             </para>
         </sect3>
     </sect2>
 
     <sect2 id="zend.search.lucene.searching.results">
         <title>Search Results</title>
+
         <para>
-            The search result is an array of <classname>Zend_Search_Lucene_Search_QueryHit</classname> objects. Each of these has
-            two properties: <code>$hit->id</code> is a document number within
-            the index and <code>$hit->score</code> is a score of the hit in
-            a search result. The results are ordered by score (descending from highest score).
+            The search result is an array of
+            <classname>Zend_Search_Lucene_Search_QueryHit</classname> objects. Each of these has two
+            properties: <code>$hit->id</code> is a document number within the index and
+            <code>$hit->score</code> is a score of the hit in a search result. The results are
+            ordered by score (descending from highest score).
         </para>
 
         <para>
-            The <classname>Zend_Search_Lucene_Search_QueryHit</classname> object also exposes each field of the <classname>Zend_Search_Lucene_Document</classname> found in the search
-            as a property of the hit. In the following example, a hit is returned with two fields from the corresponding document: title and author.
+            The <classname>Zend_Search_Lucene_Search_QueryHit</classname> object also exposes each
+            field of the <classname>Zend_Search_Lucene_Document</classname> found in the search as a
+            property of the hit. In the following example, a hit is returned with two fields from
+            the corresponding document: title and author.
         </para>
+
         <programlisting language="php"><![CDATA[
 $index = Zend_Search_Lucene::open('/data/my_index');
 
@@ -174,13 +196,13 @@ foreach ($hits as $hit) {
         </para>
 
         <para>
-            Optionally, the original <classname>Zend_Search_Lucene_Document</classname> object can be returned from the
-            <classname>Zend_Search_Lucene_Search_QueryHit</classname>.
-
-            You can retrieve stored parts of the document by using the <methodname>getDocument()</methodname>
-            method of the index object and then get them by
+            Optionally, the original <classname>Zend_Search_Lucene_Document</classname> object can
+            be returned from the <classname>Zend_Search_Lucene_Search_QueryHit</classname>.
+            You can retrieve stored parts of the document by using the
+            <methodname>getDocument()</methodname> method of the index object and then get them by
             <methodname>getFieldValue()</methodname> method:
         </para>
+
         <programlisting language="php"><![CDATA[
 $index = Zend_Search_Lucene::open('/data/my_index');
 
@@ -200,16 +222,17 @@ foreach ($hits as $hit) {
     echo $document->title;
 }
 ]]></programlisting>
+
         <para>
-        The fields available from the <classname>Zend_Search_Lucene_Document</classname> object are determined at
-        the time of indexing. The document fields are either indexed, or
-        index and stored, in the document by the indexing application
-        (e.g. LuceneIndexCreation.jar).
+            The fields available from the <classname>Zend_Search_Lucene_Document</classname> object
+            are determined at the time of indexing. The document fields are either indexed, or
+            index and stored, in the document by the indexing application
+            (e.g. LuceneIndexCreation.jar).
         </para>
 
         <para>
-        Note that the document identity ('path' in our example) is also stored
-        in the index and must be retrieved from it.
+            Note that the document identity ('path' in our example) is also stored
+            in the index and must be retrieved from it.
         </para>
     </sect2>
 
@@ -217,22 +240,27 @@ foreach ($hits as $hit) {
         <title>Limiting the Result Set</title>
 
         <para>
-            The most computationally expensive part of searching is score calculation. It may take several seconds for large result sets (tens of thousands of hits).
+            The most computationally expensive part of searching is score calculation. It may take
+            several seconds for large result sets (tens of thousands of hits).
         </para>
 
         <para>
-            <classname>Zend_Search_Lucene</classname> gives the possibility to limit result set size with <methodname>getResultSetLimit()</methodname> and
+            <classname>Zend_Search_Lucene</classname> gives the possibility to limit result set size
+            with <methodname>getResultSetLimit()</methodname> and
             <methodname>setResultSetLimit()</methodname> methods:
+
             <programlisting language="php"><![CDATA[
 $currentResultSetLimit = Zend_Search_Lucene::getResultSetLimit();
 
 Zend_Search_Lucene::setResultSetLimit($newLimit);
 ]]></programlisting>
+
             The default value of 0 means 'no limit'.
         </para>
 
         <para>
             It doesn't give the 'best N' results, but only the 'first N'
+
             <footnote>
                 <para>
                     Returned hits are still ordered by score or by the specified order, if given.
@@ -243,10 +271,12 @@ Zend_Search_Lucene::setResultSetLimit($newLimit);
 
     <sect2 id="zend.search.lucene.searching.results-scoring">
         <title>Results Scoring</title>
+
         <para>
-            <classname>Zend_Search_Lucene</classname> uses the same scoring algorithms as Java Lucene.
-            All hits in the search result are ordered by score by default. Hits with greater score come first, and
-            documents having higher scores should match the query more precisely than documents having lower scores.
+            <classname>Zend_Search_Lucene</classname> uses the same scoring algorithms as Java
+            Lucene. All hits in the search result are ordered by score by default. Hits with greater
+            score come first, and documents having higher scores should match the query more
+            precisely than documents having lower scores.
         </para>
 
         <para>
@@ -257,6 +287,7 @@ Zend_Search_Lucene::setResultSetLimit($newLimit);
         <para>
             A hit's score can be retrieved by accessing the <code>score</code> property of the hit:
         </para>
+
         <programlisting language="php"><![CDATA[
 $hits = $index->find($query);
 
@@ -267,21 +298,25 @@ foreach ($hits as $hit) {
 ]]></programlisting>
 
         <para>
-            The <classname>Zend_Search_Lucene_Search_Similarity</classname> class is used to calculate the score for each hit.
-            See <link linkend="zend.search.lucene.extending.scoring">Extensibility. Scoring Algorithms</link> section for details.
+            The <classname>Zend_Search_Lucene_Search_Similarity</classname> class is used to
+            calculate the score for each hit. See <link
+                linkend="zend.search.lucene.extending.scoring">Extensibility. Scoring
+                Algorithms</link> section for details.
         </para>
-
     </sect2>
 
     <sect2 id="zend.search.lucene.searching.sorting">
         <title>Search Result Sorting</title>
+
         <para>
-            By default, the search results are ordered by score. The programmer can change this behavior by setting a sort field (or a list of fields), sort type
-            and sort order parameters.
+            By default, the search results are ordered by score. The programmer can change this
+            behavior by setting a sort field (or a list of fields), sort type and sort order
+            parameters.
         </para>
 
         <para>
             <code>$index->find()</code> call may take several optional parameters:
+
             <programlisting language="php"><![CDATA[
 $index->find($query [, $sortField [, $sortType [, $sortOrder]]]
                     [, $sortField2 [, $sortType [, $sortOrder]]]
@@ -290,7 +325,8 @@ $index->find($query [, $sortField [, $sortType [, $sortOrder]]]
         </para>
 
         <para>
-             A name of stored field by which to sort result should be passed as the <varname>$sortField</varname> parameter.
+             A name of stored field by which to sort result should be passed as the
+             <varname>$sortField</varname> parameter.
         </para>
 
         <para>
@@ -308,6 +344,7 @@ $index->find($query [, $sortField [, $sortType [, $sortOrder]]]
 
         <para>
             Examples:
+
             <programlisting language="php"><![CDATA[
 $index->find($query, 'quantity', SORT_NUMERIC, SORT_DESC);
 ]]></programlisting>
@@ -320,20 +357,24 @@ $index->find($query, 'name', SORT_STRING, 'quantity', SORT_NUMERIC, SORT_DESC);
         </para>
 
         <para>
-            Please use caution when using a non-default search order;
-            the query needs to retrieve documents completely from an index, which may dramatically reduce search performance.
+            Please use caution when using a non-default search order; the query needs to retrieve
+            documents completely from an index, which may dramatically reduce search performance.
         </para>
     </sect2>
 
     <sect2 id="zend.search.lucene.searching.highlighting">
         <title>Search Results Highlighting</title>
+
         <para>
-            <classname>Zend_Search_Lucene</classname> provides two options for search results highlighting.
+            <classname>Zend_Search_Lucene</classname> provides two options for search results
+            highlighting.
         </para>
+
         <para>
             The first one is utilizing <classname>Zend_Search_Lucene_Document_Html</classname> class
-            (see <link linkend="zend.search.lucene.index-creation.html-documents">HTML documents section</link> for details)
-            using the following methods:
+            (see <link linkend="zend.search.lucene.index-creation.html-documents">HTML documents
+                section</link> for details) using the following methods:
+
             <programlisting language="php"><![CDATA[
 /**
  * Highlight text with specified color
@@ -344,6 +385,7 @@ $index->find($query, 'name', SORT_STRING, 'quantity', SORT_NUMERIC, SORT_DESC);
  */
 public function highlight($words, $colour = '#66ffff');
 ]]></programlisting>
+
             <programlisting language="php"><![CDATA[
 /**
  * Highlight text using specified View helper or callback function.
@@ -361,63 +403,87 @@ public function highlight($words, $colour = '#66ffff');
 public function highlightExtended($words, $callback, $params = array())
 ]]></programlisting>
         </para>
+
         <para>
-            To customize highlighting behavior use <methodname>highlightExtended()</methodname> method with specified callback, which takes
-            one or more parameters<footnote><para>The first is an HTML fragment for highlighting and others are callback behavior
-            dependent. Returned value is a highlighted HTML fragment.</para></footnote>, or extend
-            <classname>Zend_Search_Lucene_Document_Html</classname> class and redefine <methodname>applyColour($stringToHighlight, $colour)</methodname>
-            method used as a default highlighting callback.
+            To customize highlighting behavior use <methodname>highlightExtended()</methodname>
+            method with specified callback, which takes one or more parameters
+
             <footnote>
                 <para>
-                    In both cases returned HTML is automatically transformed into valid <acronym>XHTML</acronym>.
+                    The first is an HTML fragment for highlighting and others are callback behavior
+                    dependent. Returned value is a highlighted HTML fragment.
+                </para>
+            </footnote>
+            , or extend <classname>Zend_Search_Lucene_Document_Html</classname> class and redefine
+            <methodname>applyColour($stringToHighlight, $colour)</methodname> method used as a
+            default highlighting callback.
+
+            <footnote>
+                <para>
+                    In both cases returned HTML is automatically transformed into valid
+                    <acronym>XHTML</acronym>.
                 </para>
             </footnote>
         </para>
+
         <para>
-            <link linkend="zend.view.helpers">View helpers</link> also can be used as callbacks in context of view script:
+            <link linkend="zend.view.helpers">View helpers</link> also can be used as callbacks in
+            context of view script:
+
             <programlisting language="php"><![CDATA[
 $doc->highlightExtended('word1 word2 word3...', array($this, 'myViewHelper'));
 ]]></programlisting>
         </para>
+
         <para>
-            The result of highlighting operation is retrieved by <code>Zend_Search_Lucene_Document_Html->getHTML()</code> method.
+            The result of highlighting operation is retrieved by
+            <code>Zend_Search_Lucene_Document_Html->getHTML()</code> method.
         </para>
 
         <note>
             <para>
-                Highlighting is performed in terms of current analyzer. So all forms of the word(s) recognized by analyzer
-                are highlighted.
+                Highlighting is performed in terms of current analyzer. So all forms of the word(s)
+                recognized by analyzer are highlighted.
             </para>
+
             <para>
-                E.g. if current analyzer is case insensitive and we request to highlight 'text' word, then 'text', 'Text', 'TEXT'
-                and other case combinations will be highlighted.
+                E.g. if current analyzer is case insensitive and we request to highlight 'text'
+                word, then 'text', 'Text', 'TEXT' and other case combinations will be highlighted.
             </para>
+
             <para>
-                In the same way, if current analyzer supports stemming and we request to highlight 'indexed', then 'index',
-                'indexing', 'indices' and other word forms will be highlighted.
+                In the same way, if current analyzer supports stemming and we request to highlight
+                'indexed', then 'index', 'indexing', 'indices' and other word forms will be
+                highlighted.
             </para>
+
             <para>
-                On the other hand, if word is skipped by current analyzer (e.g. if short words filter is applied to the analyzer),
-                then nothing will be highlighted.
+                On the other hand, if word is skipped by current analyzer (e.g. if short words
+                filter is applied to the analyzer), then nothing will be highlighted.
             </para>
         </note>
 
         <para>
             The second option is to use
-            <code>Zend_Search_Lucene_Search_Query->highlightMatches(string $inputHTML[, $defaultEncoding = 'UTF-8'[, Zend_Search_Lucene_Search_Highlighter_Interface $highlighter]])</code>
-            method:
+            <code>Zend_Search_Lucene_Search_Query->highlightMatches(string $inputHTML[,
+                $defaultEncoding = 'UTF-8'[,
+                Zend_Search_Lucene_Search_Highlighter_Interface $highlighter]])</code> method:
+
             <programlisting language="php"><![CDATA[
 $query = Zend_Search_Lucene_Search_QueryParser::parse($queryStr);
 $highlightedHTML = $query->highlightMatches($sourceHTML);
 ]]></programlisting>
         </para>
+
         <para>
-            Optional second parameter is a default HTML document encoding. It's used if encoding is not specified using
-            Content-type HTTP-EQUIV meta tag.
+            Optional second parameter is a default HTML document encoding. It's used if encoding is
+            not specified using Content-type HTTP-EQUIV meta tag.
         </para>
+
         <para>
             Optional third parameter is a highlighter object which has to implement
             <classname>Zend_Search_Lucene_Search_Highlighter_Interface</classname> interface:
+
             <programlisting language="php"><![CDATA[
 interface Zend_Search_Lucene_Search_Highlighter_Interface
 {
@@ -444,25 +510,33 @@ interface Zend_Search_Lucene_Search_Highlighter_Interface
     public function highlight($words);
 }
 ]]></programlisting>
-            Where <classname>Zend_Search_Lucene_Document_Html</classname> object is an object constructed from the source HTML
-            provided to the <classname>Zend_Search_Lucene_Search_Query->highlightMatches()</classname> method.
+
+            Where <classname>Zend_Search_Lucene_Document_Html</classname> object is an object
+            constructed from the source HTML provided to the
+            <classname>Zend_Search_Lucene_Search_Query->highlightMatches()</classname> method.
         </para>
+
         <para>
-            If <varname>$highlighter</varname> parameter is omitted, then <classname>Zend_Search_Lucene_Search_Highlighter_Default</classname>
-            object is instantiated and used.
+            If <varname>$highlighter</varname> parameter is omitted, then
+            <classname>Zend_Search_Lucene_Search_Highlighter_Default</classname> object is
+            instantiated and used.
         </para>
+
         <para>
-            Highlighter <methodname>highlight()</methodname> method is invoked once per subquery, so it has an ability to differentiate
-            highlighting for them.
+            Highlighter <methodname>highlight()</methodname> method is invoked once per subquery, so
+            it has an ability to differentiate highlighting for them.
         </para>
+
         <para>
-            Actually, default highlighter does this walking through predefined color table. So you can implement
-            your own highlighter or just extend the default and redefine color table.
+            Actually, default highlighter does this walking through predefined color table. So you
+            can implement your own highlighter or just extend the default and redefine color table.
         </para>
+
         <para>
-            <code>Zend_Search_Lucene_Search_Query->htmlFragmentHighlightMatches()</code> has similar behavior. The only difference
-            is that it takes as an input and returns HTML fragment without &lt;>HTML>, &lt;HEAD>, &lt;BODY> tags.
-            Nevertheless, fragment is automatically transformed to valid <acronym>XHTML</acronym>.
+            <code>Zend_Search_Lucene_Search_Query->htmlFragmentHighlightMatches()</code> has similar
+            behavior. The only difference is that it takes as an input and returns HTML fragment
+            without &lt;>HTML>, &lt;HEAD>, &lt;BODY> tags. Nevertheless, fragment is automatically
+            transformed to valid <acronym>XHTML</acronym>.
         </para>
     </sect2>
 </sect1>

documentation/manual/en/module_specs/Zend_Service_Amazon_Ec2-Securitygroups.xml

@@ -9,13 +9,16 @@
          be delivered to your instance. All other ingress traffic will be
          discarded.
     </para>
+
     <para>
         You can modify rules for a group at any time. The new rules are
         automatically enforced for all running instances and instances
         launched in the future.
     </para>
+
     <note>
         <title>Maximum Security Groups</title>
+
         <para>You can create up to 100 security groups.</para>
     </note>
 
@@ -24,6 +27,7 @@
 
         <example id="zend.service.amazon.ec2.securitygroups.maintenance.create">
             <title>Create a new Security Group</title>
+
             <para>
                 <code>create</code> a new security group. Every instance is
                 launched in a security group. If no security group is specified
@@ -47,15 +51,18 @@ $return = $ec2_sg->create('mygroup', 'my group description');
 
         <example id="zend.service.amazon.ec2.securitygroups.maintenance.describe">
             <title>Describe a Security Group</title>
+
             <para>
                 <code>describe</code> returns information about security groups that
                 you own.
             </para>
+
             <para>
                 If you specify security group names, information about those security
                 groups is returned. Otherwise, information for all security groups is
                 returned. If you specify a group that does not exist, a fault is returned.
             </para>
+
             <para>
                 <code>describe</code> will return an array containing information
                 about security groups which includes the ownerId, groupName,
@@ -72,6 +79,7 @@ $return = $ec2_sg->describe('mygroup');
 
         <example id="zend.service.amazon.ec2.securitygroups.maintenance.delete">
             <title>Delete a Security Group</title>
+
             <para>
                 <code>delete</code> will remove the security group. If you attempt to
                 delete a security group that contains instances, a fault is returned.
@@ -99,10 +107,12 @@ $return = $ec2_sg->delete('mygroup');
 
         <example id="zend.service.amazon.ec2.securitygroups.authorize.ip">
             <title>Authorizing by IP</title>
+
             <para>
                 <code>authorizeIp</code> Adds permissions to a security group based on
                 an IP address, protocol type and port range.
             </para>
+
             <para>
                 Permissions are specified by the IP protocol (TCP, UDP or ICMP), the
                 source of the request (by IP range or an Amazon EC2 user-group pair),
@@ -110,6 +120,7 @@ $return = $ec2_sg->delete('mygroup');
                 ICMP codes and types (for ICMP). When authorizing ICMP, -1 can be used
                 as a wildcard in the type and code fields.
             </para>
+
             <para>
                 Permission changes are propagated to instances within the security group
                 as quickly as possible. However, depending on the number of instances, a
@@ -134,9 +145,11 @@ $return = $ec2_sg->authorizeIp('mygroup',
 
         <example id="zend.service.amazon.ec2.securitygroups.authorize.group">
             <title>Authorize By Group</title>
+
             <para>
                 <code>authorizeGroup</code> Adds permissions to a security group.
             </para>
+
             <para>
                 Permission changes are propagated to instances within the security group
                 as quickly as possible. However, depending on the number of instances, a
@@ -161,11 +174,13 @@ $return = $ec2_sg->authorizeGroup('mygroup', 'securityGroupName', 'ownerId');
 
         <example id="zend.service.amazon.ec2.securitygroups.revoke.ip">
             <title>Revoke by IP</title>
+
             <para>
                 <code>revokeIp</code> Revokes permissions to a security group based on
                 an IP address, protocol type and port range. The permissions used to revoke
                 must be specified using the same values used to grant the permissions.
             </para>
+
             <para>
                 Permissions are specified by the IP protocol (TCP, UDP or ICMP), the
                 source of the request (by IP range or an Amazon EC2 user-group pair),
@@ -173,6 +188,7 @@ $return = $ec2_sg->authorizeGroup('mygroup', 'securityGroupName', 'ownerId');
                 ICMP codes and types (for ICMP). When authorizing ICMP, -1 can be used
                 as a wildcard in the type and code fields.
             </para>
+
             <para>
                 Permission changes are propagated to instances within the security group
                 as quickly as possible. However, depending on the number of instances, a
@@ -197,11 +213,13 @@ $return = $ec2_sg->revokeIp('mygroup',
 
         <example id="zend.service.amazon.ec2.securitygroups.revoke.group">
             <title>Revoke By Group</title>
+
             <para>
                 <code>revokeGroup</code> Adds permissions to a security group. The permissions
                 to revoke must be specified using the same values used to grant the
                 permissions.
             </para>
+
             <para>
                 Permission changes are propagated to instances within the security group
                 as quickly as possible. However, depending on the number of instances, a

documentation/manual/en/module_specs/Zend_Service_Delicious.xml

@@ -2,16 +2,21 @@
 <!-- Reviewed: no -->
 <sect1 id="zend.service.delicious">
     <title>Zend_Service_Delicious</title>
+
     <sect2 id="zend.service.delicious.introduction">
         <title>Introduction</title>
+
         <para>
             <classname>Zend_Service_Delicious</classname> is simple <acronym>API</acronym> for using
-            <ulink url="http://del.icio.us">del.icio.us</ulink>
-            <acronym>XML</acronym> and <acronym>JSON</acronym> web services. This component gives you read-write access to posts at del.icio.us
-            if you provide credentials. It also allows read-only access to public data of all users.
+            <ulink url="http://del.icio.us">del.icio.us</ulink> <acronym>XML</acronym> and
+            <acronym>JSON</acronym> web services. This component gives you read-write access to
+            posts at del.icio.us if you provide credentials. It also allows read-only access to
+            public data of all users.
         </para>
+
         <example id="zend.service.delicious.introduction.getAllPosts">
             <title>Get all posts</title>
+
             <programlisting language="php"><![CDATA[
 $delicious = new Zend_Service_Delicious('username', 'password');
 $posts = $delicious->getAllPosts();
@@ -24,14 +29,17 @@ foreach ($posts as $post) {
 ]]></programlisting>
         </example>
     </sect2>
+
     <sect2 id="zend.service.delicious.retrieving_posts">
         <title>Retrieving posts</title>
+
         <para>
-            <classname>Zend_Service_Delicious</classname> provides three methods for retrieving posts: <methodname>getPosts()</methodname>,
-            <methodname>getRecentPosts()</methodname> and <methodname>getAllPosts()</methodname>. All of these
-            methods return an instance of <classname>Zend_Service_Delicious_PostList</classname>, which
-            holds all retrieved posts.
+            <classname>Zend_Service_Delicious</classname> provides three methods for retrieving
+            posts: <methodname>getPosts()</methodname>, <methodname>getRecentPosts()</methodname>
+            and <methodname>getAllPosts()</methodname>. All of these methods return an instance of
+            <classname>Zend_Service_Delicious_PostList</classname>, which holds all retrieved posts.
         </para>
+
         <programlisting language="php"><![CDATA[
 /**
  * Get posts matching the arguments. If no date or url is given,
@@ -63,18 +71,25 @@ public function getRecentPosts($tag = null, $count = 15);
 public function getAllPosts($tag = null);
 ]]></programlisting>
     </sect2>
+
     <sect2 id="zend.service.delicious.postlist">
         <title>Zend_Service_Delicious_PostList</title>
+
         <para>
-            Instances of this class are returned by the <methodname>getPosts()</methodname>, <methodname>getAllPosts()</methodname>,
-            <methodname>getRecentPosts()</methodname>, and <methodname>getUserPosts()</methodname> methods of <classname>Zend_Service_Delicious</classname>.
+            Instances of this class are returned by the <methodname>getPosts()</methodname>,
+            <methodname>getAllPosts()</methodname>, <methodname>getRecentPosts()</methodname>, and
+            <methodname>getUserPosts()</methodname> methods of
+            <classname>Zend_Service_Delicious</classname>.
         </para>
+
         <para>
-            For easier data access this class implements the <code>Countable</code>, <code>Iterator</code>, and
-            <code>ArrayAccess</code> interfaces.
+            For easier data access this class implements the <code>Countable</code>,
+            <code>Iterator</code>, and <code>ArrayAccess</code> interfaces.
         </para>
+
         <example id="zend.service.delicious.postlist.accessing_post_lists">
             <title>Accessing post lists</title>
+
             <programlisting language="php"><![CDATA[
 $delicious = new Zend_Service_Delicious('username', 'password');
 $posts = $delicious->getAllPosts();
@@ -93,22 +108,31 @@ foreach ($posts as $post) {
 echo $posts[0]->getTitle();
 ]]></programlisting>
         </example>
+
         <note>
             <para>
-                The <methodname>ArrayAccess::offsetSet()</methodname> and <methodname>ArrayAccess::offsetUnset()</methodname> methods
-                throw exceptions in this implementation. Thus, code like <code>unset($posts[0]);</code> and
-                <code>$posts[0] = 'A';</code> will throw exceptions because these properties are read-only.
+                The <methodname>ArrayAccess::offsetSet()</methodname> and
+                <methodname>ArrayAccess::offsetUnset()</methodname> methods throw exceptions in this
+                implementation. Thus, code like <code>unset($posts[0]);</code> and
+                <code>$posts[0] = 'A';</code> will throw exceptions because these properties are
+                read-only.
             </para>
         </note>
+
         <para>
-            Post list objects have two built-in filtering capabilities. Post lists may be filtered by tags and by <acronym>URL</acronym>.
+            Post list objects have two built-in filtering capabilities. Post lists may be filtered
+            by tags and by <acronym>URL</acronym>.
         </para>
+
         <example id="zend.service.delicious.postlist.example.withTags">
             <title>Filtering a Post List with Specific Tags</title>
+
             <para>
-                Posts may be filtered by specific tags using <methodname>withTags()</methodname>. As a convenience,
-                <methodname>withTag()</methodname> is also provided for when only a single tag needs to be specified.
+                Posts may be filtered by specific tags using <methodname>withTags()</methodname>. As
+                a convenience, <methodname>withTag()</methodname> is also provided for when only a
+                single tag needs to be specified.
             </para>
+
             <programlisting language="php"><![CDATA[
 $delicious = new Zend_Service_Delicious('username', 'password');
 $posts = $delicious->getAllPosts();
@@ -120,12 +144,15 @@ foreach ($posts->withTags(array('php', 'zend')) as $post) {
 }
 ]]></programlisting>
         </example>
+
         <example id="zend.service.delicious.postlist.example.byUrl">
             <title>Filtering a Post List by URL</title>
+
             <para>
-                Posts may be filtered by <acronym>URL</acronym> matching a specified regular expression using the <methodname>withUrl()</methodname>
-                method:
+                Posts may be filtered by <acronym>URL</acronym> matching a specified regular
+                expression using the <methodname>withUrl()</methodname> method:
             </para>
+
             <programlisting language="php"><![CDATA[
 $delicious = new Zend_Service_Delicious('username', 'password');
 $posts = $delicious->getAllPosts();
@@ -138,10 +165,13 @@ foreach ($posts->withUrl('/help/') as $post) {
 ]]></programlisting>
         </example>
     </sect2>
+
     <sect2 id="zend.service.delicious.editing_posts">
         <title>Editing posts</title>
+
         <example id="zend.service.delicious.editing_posts.post_editing">
             <title>Post editing</title>
+
             <programlisting language="php"><![CDATA[
 $delicious = new Zend_Service_Delicious('username', 'password');
 $posts = $delicious->getPosts();
@@ -152,11 +182,15 @@ $posts[0]->setTitle('New title');
 $posts[0]->save();
 ]]></programlisting>
         </example>
+
         <example id="zend.service.delicious.editing_posts.method_call_chaining">
             <title>Method call chaining</title>
+
             <para>
-               Every setter method returns the post object so that you can chain method calls using a fluent interface.
+               Every setter method returns the post object so that you can chain method calls using
+               a fluent interface.
             </para>
+
             <programlisting language="php"><![CDATA[
 $delicious = new Zend_Service_Delicious('username', 'password');
 $posts = $delicious->getPosts();
@@ -167,14 +201,18 @@ $posts[0]->setTitle('New title')
 ]]></programlisting>
         </example>
     </sect2>
+
     <sect2 id="zend.service.delicious.deleting_posts">
         <title>Deleting posts</title>
+
         <para>
-            There are two ways to delete a post, by specifying the post <acronym>URL</acronym> or by calling the <methodname>delete()</methodname>
-            method upon a post object.
+            There are two ways to delete a post, by specifying the post <acronym>URL</acronym> or by
+            calling the <methodname>delete()</methodname> method upon a post object.
         </para>
+
         <example id="zend.service.delicious.deleting_posts.deleting_posts">
             <title>Deleting posts</title>
+
             <programlisting language="php"><![CDATA[
 $delicious = new Zend_Service_Delicious('username', 'password');
 
@@ -190,15 +228,20 @@ $delicious->deletePost($posts[0]->getUrl());
 ]]></programlisting>
         </example>
     </sect2>
+
     <sect2 id="zend.service.delicious.adding_posts">
         <title>Adding new posts</title>
+
         <para>
-            To add a post you first need to call the <methodname>createNewPost()</methodname> method, which returns a
-            <classname>Zend_Service_Delicious_Post</classname> object. When you edit the post, you need to save it
-            to the del.icio.us database by calling the <methodname>save()</methodname> method.
+            To add a post you first need to call the <methodname>createNewPost()</methodname>
+            method, which returns a <classname>Zend_Service_Delicious_Post</classname> object. When
+            you edit the post, you need to save it to the del.icio.us database by calling the
+            <methodname>save()</methodname> method.
         </para>
+
         <example id="zend.service.delicious.adding_posts.adding_a_post">
             <title>Adding a post</title>
+
             <programlisting language="php"><![CDATA[
 $delicious = new Zend_Service_Delicious('username', 'password');
 
@@ -215,10 +258,13 @@ $newPost->save();
 ]]></programlisting>
         </example>
     </sect2>
+
     <sect2 id="zend.service.delicious.tags">
         <title>Tags</title>
+
         <example id="zend.service.delicious.tags.tags">
             <title>Tags</title>
+
             <programlisting language="php"><![CDATA[
 $delicious = new Zend_Service_Delicious('username', 'password');
 
@@ -230,10 +276,13 @@ $delicious->renameTag('ZF', 'zendFramework');
 ]]></programlisting>
         </example>
     </sect2>
+
     <sect2 id="zend.service.delicious.bundles">
         <title>Bundles</title>
+
         <example id="zend.service.delicious.bundles.example">
             <title>Bundles</title>
+
             <programlisting language="php"><![CDATA[
 $delicious = new Zend_Service_Delicious('username', 'password');
 
@@ -248,13 +297,18 @@ $delicious->addBundle('newBundle', array('tag1', 'tag2'));
 ]]></programlisting>
         </example>
     </sect2>
+
     <sect2 id="zend.service.delicious.public_data">
         <title>Public data</title>
+
         <para>
-            The del.icio.us web <acronym>API</acronym> allows access to the public data of all users.
+            The del.icio.us web <acronym>API</acronym> allows access to the public data of all
+            users.
         </para>
+
         <table id="zend.service.delicious.public_data.functions_for_retrieving_public_data">
             <title>Methods for retrieving public data</title>
+
             <tgroup cols="3">
                 <thead>
                     <row>
@@ -263,22 +317,26 @@ $delicious->addBundle('newBundle', array('tag1', 'tag2'));
                         <entry>Return type</entry>
                     </row>
                 </thead>
+
                 <tbody>
                     <row>
                         <entry><methodname>getUserFans()</methodname></entry>
                         <entry>Retrieves fans of a user</entry>
                         <entry>Array</entry>
                     </row>
+
                     <row>
                         <entry><methodname>getUserNetwork()</methodname></entry>
                         <entry>Retrieves network of a user</entry>
                         <entry>Array</entry>
                     </row>
+
                     <row>
                         <entry><methodname>getUserPosts()</methodname></entry>
                         <entry>Retrieves posts of a user</entry>
                         <entry>Zend_Service_Delicious_PostList</entry>
                     </row>
+
                     <row>
                         <entry><methodname>getUserTags()</methodname></entry>
                         <entry>Retrieves tags of a user</entry>
@@ -287,14 +345,17 @@ $delicious->addBundle('newBundle', array('tag1', 'tag2'));
                 </tbody>
             </tgroup>
         </table>
+
         <note>
             <para>
-                When using only these methods, a username and password combination is not required when constructing
-                a new <classname>Zend_Service_Delicious</classname> object.
+                When using only these methods, a username and password combination is not required
+                when constructing a new <classname>Zend_Service_Delicious</classname> object.
             </para>
         </note>
+
         <example id="zend.service.delicious.public_data.retrieving_public_data">
             <title>Retrieving public data</title>
+
             <programlisting language="php"><![CDATA[
 // username and password are not required
 $delicious = new Zend_Service_Delicious();
@@ -309,16 +370,21 @@ print_r($delicious->getUserNetwork('someUser'));
 print_r($delicious->getUserTags('someUser'));
 ]]></programlisting>
         </example>
+
         <sect3 id="zend.service.delicious.public_data.posts">
             <title>Public posts</title>
+
             <para>
-                When retrieving public posts with the <methodname>getUserPosts()</methodname> method, a
-                <classname>Zend_Service_Delicious_PostList</classname> object is returned, and it contains
-                <classname>Zend_Service_Delicious_SimplePost</classname> objects, which contain basic information
-                about the posts, including <acronym>URL</acronym>, title, notes, and tags.
+                When retrieving public posts with the <methodname>getUserPosts()</methodname>
+                method, a <classname>Zend_Service_Delicious_PostList</classname> object is returned,
+                and it contains <classname>Zend_Service_Delicious_SimplePost</classname> objects,
+                which contain basic information about the posts, including <acronym>URL</acronym>,
+                title, notes, and tags.
             </para>
+
             <table id="zend.service.delicious.public_data.posts.SimplePost_methods">
                 <title>Methods of the Zend_Service_Delicious_SimplePost class</title>
+
                 <tgroup cols="3">
                     <thead>
                         <row>
@@ -327,22 +393,26 @@ print_r($delicious->getUserTags('someUser'));
                             <entry>Return type</entry>
                         </row>
                     </thead>
+
                     <tbody>
                         <row>
                             <entry><methodname>getNotes()</methodname></entry>
                             <entry>Returns notes of a post</entry>
                             <entry>String</entry>
                         </row>
+
                         <row>
                             <entry><methodname>getTags()</methodname></entry>
                             <entry>Returns tags of a post</entry>
                             <entry>Array</entry>
                         </row>
+
                         <row>
                             <entry><methodname>getTitle()</methodname></entry>
                             <entry>Returns title of a post</entry>
                             <entry>String</entry>
                         </row>
+
                         <row>
                             <entry><methodname>getUrl()</methodname></entry>
                             <entry>Returns <acronym>URL</acronym> of a post</entry>
@@ -353,38 +423,50 @@ print_r($delicious->getUserTags('someUser'));
             </table>
         </sect3>
     </sect2>
+
     <sect2 id="zend.service.delicious.httpclient">
         <title>HTTP client</title>
+
         <para>
-            <classname>Zend_Service_Delicious</classname> uses <classname>Zend_Rest_Client</classname> for making <acronym>HTTP</acronym> requests
-            to the del.icio.us web service. To change which <acronym>HTTP</acronym> client <classname>Zend_Service_Delicious</classname>
-            uses, you need to change the <acronym>HTTP</acronym> client of <classname>Zend_Rest_Client</classname>.
+            <classname>Zend_Service_Delicious</classname> uses
+            <classname>Zend_Rest_Client</classname> for making <acronym>HTTP</acronym> requests to
+            the del.icio.us web service. To change which <acronym>HTTP</acronym> client
+            <classname>Zend_Service_Delicious</classname> uses, you need to change the
+            <acronym>HTTP</acronym> client of <classname>Zend_Rest_Client</classname>.
         </para>
+
         <example id="zend.service.delicious.httpclient.changing">
             <title>Changing the HTTP client of Zend_Rest_Client</title>
+
             <programlisting language="php"><![CDATA[
 $myHttpClient = new My_Http_Client();
 Zend_Rest_Client::setHttpClient($myHttpClient);
 ]]></programlisting>
         </example>
+
         <para>
-            When you are making more than one request with <classname>Zend_Service_Delicious</classname> to speed your
-            requests, it's better to configure your <acronym>HTTP</acronym> client to keep connections alive.
+            When you are making more than one request with
+            <classname>Zend_Service_Delicious</classname> to speed your requests, it's better to
+            configure your <acronym>HTTP</acronym> client to keep connections alive.
         </para>
+
         <example id="zend.service.delicious.httpclient.keepalive">
             <title>Configuring your HTTP client to keep connections alive</title>
+
             <programlisting language="php"><![CDATA[
 Zend_Rest_Client::getHttpClient()->setConfig(array(
         'keepalive' => true
 ));
 ]]></programlisting>
         </example>
+
         <note>
             <para>
-                When a <classname>Zend_Service_Delicious</classname> object is constructed, the <acronym>SSL</acronym> transport
-                of <classname>Zend_Rest_Client</classname> is set to <code>'ssl'</code> rather than the default of
-                <code>'ssl2'</code>. This is because del.icio.us has some problems with <code>'ssl2'</code>, such
-                as requests taking a long time to complete (around 2 seconds).
+                When a <classname>Zend_Service_Delicious</classname> object is constructed, the
+                <acronym>SSL</acronym> transport of <classname>Zend_Rest_Client</classname> is set
+                to <code>'ssl'</code> rather than the default of <code>'ssl2'</code>. This is
+                because del.icio.us has some problems with <code>'ssl2'</code>, such as requests
+                taking a long time to complete (around 2 seconds).
             </para>
         </note>
     </sect2>

documentation/manual/en/module_specs/Zend_Service_DeveloperGarden.xml

@@ -22,7 +22,8 @@
         <itemizedlist>
             <listitem>
                 <para>
-                    <link linkend="zend.service.developergarden.baseuserservice">BaseUserService</link>:
+                    <link
+                        linkend="zend.service.developergarden.baseuserservice">BaseUserService</link>:
                     Class to manage API quota and user accounting details.
                 </para>
             </listitem>
@@ -38,7 +39,8 @@
             <listitem>
                 <para>
                     <link linkend="zend.service.developergarden.localsearch">LocalSearch</link>:
-                    Allows you to search with options nearby or around a given geo coordinate or city.
+                    Allows you to search with options nearby or around a given geo coordinate or
+                    city.
                 </para>
             </listitem>
 
@@ -65,7 +67,8 @@
 
             <listitem>
                 <para>
-                    <link linkend="zend.service.developergarden.conferencecall">ConferenceCall</link>:
+                    <link
+                        linkend="zend.service.developergarden.conferencecall">ConferenceCall</link>:
                     You can configure a whole conference room with participants for an adhoc
                     conference or you can also schedule your conference.
                 </para>
@@ -267,7 +270,8 @@ echo 'Quota Level: ', $result->getQuotaLevel(), '<br />';
                 environment.
             </para>
 
-            <example id="zend.service.developergarden.baseuserservice.changequotainformation.example">
+            <example
+                id="zend.service.developergarden.baseuserservice.changequotainformation.example">
                 <title>Change quota information example</title>
 
                 <programlisting language="php"><![CDATA[
@@ -662,8 +666,8 @@ $service->tearDownCall($sessionId);
 
             <listitem>
                 <para>
-                    <methodname>commitConference()</methodname> saves the conference, and, if no date
-                    is configured, immediately starts the conference
+                    <methodname>commitConference()</methodname> saves the conference, and, if no
+                    date is configured, immediately starts the conference
                 </para>
             </listitem>
 
@@ -750,7 +754,8 @@ $service->tearDownCall($sessionId);
 
             <listitem>
                 <para>
-                    <methodname>removeConferenceTemplate()</methodname> removes a conference template
+                    <methodname>removeConferenceTemplate()</methodname> removes a conference
+                    template
                 </para>
             </listitem>