Browse Source

[MANUAL] English:

- structural fixes (no translations needed)

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

+ 1 - 1
documentation/manual/en/module_specs/Zend_Navigation-Containers.xml

@@ -810,4 +810,4 @@ array(2) {
 ]]></programlisting>
         </example>
     </sect2>
-</sect1>
+</sect1>

+ 41 - 25
documentation/manual/en/module_specs/Zend_OpenId-Provider.xml

@@ -2,6 +2,7 @@
 <!-- Reviewed: no -->
 <sect1 id="zend.openid.provider">
     <title>Zend_OpenId_Provider</title>
+
     <para>
         <classname>Zend_OpenId_Provider</classname> can be used to implement OpenID
         servers. This chapter provides examples that demonstrate how to
@@ -11,7 +12,8 @@
     </para>
 
     <sect2 id="zend.openid.provider.start">
-        <title>Quick Start</title>
+        <title>Quick start</title>
+
         <para>
             The following example includes code for creating a user account
             using <classname>Zend_OpenId_Provider::register</classname>. The link element with
@@ -28,6 +30,7 @@
 
         <example id="zend.openid.provider.example-1">
             <title>The Identity</title>
+
             <programlisting language="php"><![CDATA[
 <?php
 // Set up test identity
@@ -52,20 +55,23 @@ if (!$server->hasUser(TEST_ID)) {
             from OpenID-enabled sites (for association and authentication). Both of
             them are handled by the same method:
             <classname>Zend_OpenId_Provider::handle</classname>. The two arguments to the
-            <classname>Zend_OpenId_Provider</classname> constructor are <acronym>URL</acronym>s of login and trust pages, which
-            ask for input from the end user.
+            <classname>Zend_OpenId_Provider</classname> constructor are <acronym>URL</acronym>s of
+            login and trust pages, which ask for input from the end user.
         </para>
 
         <para>
             On success, the method <classname>Zend_OpenId_Provider::handle</classname>
             returns a string that should be passed back to the OpenID-enabled site. On
             failure, it returns <constant>FALSE</constant>. This example will return an
-            <acronym>HTTP</acronym> 403 response if <classname>Zend_OpenId_Provider::handle</classname> fails. You will get this response if you open this script with a
-            web browser, because it sends a non-OpenID conforming request.
+            <acronym>HTTP</acronym> 403 response if
+            <classname>Zend_OpenId_Provider::handle</classname> fails. You will get this response if
+            you open this script with a web browser, because it sends a non-OpenID conforming
+            request.
         </para>
 
         <example id="zend.openid.provider.example-2">
             <title>Simple Identity Provider</title>
+
             <programlisting language="php"><![CDATA[
 $server = new Zend_OpenId_Provider("example-8-login.php",
                                    "example-8-trust.php");
@@ -85,12 +91,12 @@ if (is_string($ret)) {
                 especially for the following interactive scripts- to prevent password
                 disclosure.
             </para>
-       </note>
+        </note>
 
         <para>
             The following script implements a login screen for an identity
-            server using <classname>Zend_OpenId_Provider</classname> and redirects to this page when a
-            required user has not yet logged in. On this page, a user will enter his password
+            server using <classname>Zend_OpenId_Provider</classname> and redirects to this page when
+            a required user has not yet logged in. On this page, a user will enter his password
             to login.
         </para>
 
@@ -118,6 +124,7 @@ if (is_string($ret)) {
 
         <example id="zend.openid.provider.example-3">
             <title>Simple Login Screen</title>
+
             <programlisting language="php"><![CDATA[
 <?php
 $server = new Zend_OpenId_Provider();
@@ -183,6 +190,7 @@ if ($_SERVER['REQUEST_METHOD'] == 'POST' &&
 
         <example id="zend.openid.provider.example-4">
             <title>Simple Trust Screen</title>
+
             <programlisting language="php"><![CDATA[
 <?php
 $server = new Zend_OpenId_Provider();
@@ -239,6 +247,7 @@ is your identity URL.
 
     <sect2 id="zend.openid.provider.all">
         <title>Combined Provide Scripts</title>
+
         <para>
             It is possible to combine all provider functionality in one script. In
             this case login and trust <acronym>URL</acronym>s are omitted, and
@@ -250,13 +259,14 @@ is your identity URL.
             <para>
                 The following example is not complete. It doesn't provide GUI code for
                 the user, instead performing an automatic login and trust relationship instead.
-                This is done just to simplify the example; a production server should include some code
-                from previous examples.
+                This is done just to simplify the example; a production server should include some
+                code from previous examples.
             </para>
         </note>
 
         <example id="zend.openid.provider.example-5">
             <title>Everything Together</title>
+
             <programlisting language="php"><![CDATA[
 $server = new Zend_OpenId_Provider();
 
@@ -289,24 +299,26 @@ if ($_SERVER['REQUEST_METHOD'] == 'GET' &&
         <para>
             If you compare this example with previous examples split in to
             separate pages, you will see only the one
-            difference besides the dispatch code: <methodname>unset($_GET['openid_action'])</methodname>. This
-            call to <code>unset</code> is necessary to route the next request to main
-            handler.
+            difference besides the dispatch code:
+            <methodname>unset($_GET['openid_action'])</methodname>. This call to <code>unset</code>
+            is necessary to route the next request to main handler.
         </para>
     </sect2>
 
     <sect2 id="zend.openid.provider.sreg">
         <title>Simple Registration Extension</title>
+
         <para>
-            Again, the code before the &lt;html&gt; tag is just a trick to demonstrate functionality. It creates a new user
-            account and associates it with a profile (nickname and password). Such
-            tricks aren't needed in deployed providers where end users register on OpenID
-            servers and fill in their profiles. Implementing this GUI is out of scope for
+            Again, the code before the &lt;html&gt; tag is just a trick to demonstrate
+            functionality. It creates a new user account and associates it with a profile (nickname
+            and password). Such tricks aren't needed in deployed providers where end users register
+            on OpenID servers and fill in their profiles. Implementing this GUI is out of scope for
             this manual.
         </para>
 
         <example id="zend.openid.provider.example-6">
             <title>Identity with Profile</title>
+
             <programlisting language="php"><![CDATA[
 <?php
 define("TEST_SERVER", Zend_OpenId::absoluteURL("example-10.php"));
@@ -344,13 +356,13 @@ if (!$server->hasUser(TEST_ID)) {
         </para>
 
         <para>
-            This script is a variation of the script in the "Everything Together" example. It uses the
-            same automatic login mechanism, but doesn't contain any code for a trust
+            This script is a variation of the script in the "Everything Together" example. It uses
+            the same automatic login mechanism, but doesn't contain any code for a trust
             page. The user already trusts the example scripts forever. This trust was
-            established by calling the <methodname>Zend_OpenId_Provider::allowSite()</methodname> method in the identity
-            script. The same method associates the profile with the trusted <acronym>URL</acronym>. This
-            profile will be returned automatically for a request from the trusted
-            <acronym>URL</acronym>.
+            established by calling the <methodname>Zend_OpenId_Provider::allowSite()</methodname>
+            method in the identity script. The same method associates the profile with the trusted
+            <acronym>URL</acronym>. This profile will be returned automatically for a request from
+            the trusted <acronym>URL</acronym>.
         </para>
 
         <para>
@@ -361,6 +373,7 @@ if (!$server->hasUser(TEST_ID)) {
 
         <example id="zend.openid.provider.example-7">
             <title>Provider with SREG</title>
+
             <programlisting language="php"><![CDATA[
 $server = new Zend_OpenId_Provider();
 $sreg = new Zend_OpenId_Extension_Sreg();
@@ -393,6 +406,7 @@ if ($_SERVER['REQUEST_METHOD'] == 'GET' &&
 
     <sect2 id="zend.openid.provider.else">
         <title>Anything Else?</title>
+
         <para>
             Building OpenID providers is much less common than building
             OpenID-enabled sites, so this manual doesn't cover all
@@ -411,6 +425,7 @@ if ($_SERVER['REQUEST_METHOD'] == 'GET' &&
                     users to register and manage their trusted sites and profiles
                 </para>
             </listitem>
+
             <listitem>
                 <para>
                     An abstract storage layer to store information about users,
@@ -420,6 +435,7 @@ if ($_SERVER['REQUEST_METHOD'] == 'GET' &&
                     file storage by default, but may used with another backend.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
                     An abstract user-association layer that may associate
@@ -429,8 +445,8 @@ if ($_SERVER['REQUEST_METHOD'] == 'GET' &&
         </itemizedlist>
 
         <para>
-            The <classname>Zend_OpenId_Provider</classname> class doesn't attempt to cover all possible
-            features that can be implemented by OpenID servers, e.g. digital
+            The <classname>Zend_OpenId_Provider</classname> class doesn't attempt to cover all
+            possible features that can be implemented by OpenID servers, e.g. digital
             certificates, but it can be extended easily using
             <classname>Zend_OpenId_Extension</classname>s or by standard object-oriented extension.
         </para>

+ 10 - 9
documentation/manual/en/module_specs/Zend_Paginator-Configuration.xml

@@ -18,22 +18,24 @@
                     <entry>Description</entry>
                 </row>
             </thead>
+
             <tbody>
                 <row>
                     <entry>setCurrentPageNumber</entry>
-                    <entry>
-                        Sets the current page number (default 1).
-                    </entry>
+                    <entry>Sets the current page number (default 1).</entry>
                 </row>
+
                 <row>
                     <entry>setItemCountPerPage</entry>
+
                     <entry>
-                        Sets the maximum number of items to display on a page
-                        (default 10).
+                        Sets the maximum number of items to display on a page (default 10).
                     </entry>
                 </row>
+
                 <row>
                     <entry>setPageRange</entry>
+
                     <entry>
                         Sets the number of items to display in the pagination
                         control (default 10). Note: Most of the time this
@@ -42,11 +44,10 @@
                         starting value (e.g., Elastic).
                     </entry>
                 </row>
+
                 <row>
                     <entry>setView</entry>
-                    <entry>
-                        Sets the view instance, for rendering convenience.
-                    </entry>
+                    <entry>Sets the view instance, for rendering convenience.</entry>
                 </row>
             </tbody>
         </tgroup>
@@ -54,4 +55,4 @@
 </sect1>
 <!--
 vim:se ts=4 sw=4 et:
--->
+-->

+ 22 - 17
documentation/manual/en/module_specs/Zend_Pdf-InteractiveFeatures.xml

@@ -2,6 +2,7 @@
 <!-- Reviewed: no -->
 <sect1 id="zend.pdf.interactive-features">
     <title>Interactive Features</title>
+
     <sect2 id="zend.pdf.pages.interactive-features.destinations">
         <title>Destinations</title>
 
@@ -72,15 +73,13 @@
 
                     <listitem>
                         <para>
-                            <varname>$left</varname> is a left edge of the displayed page
-                            (float).
+                            <varname>$left</varname> is a left edge of the displayed page (float).
                         </para>
                     </listitem>
 
                     <listitem>
                         <para>
-                            <varname>$top</varname> is a top edge of the displayed page
-                            (float).
+                            <varname>$top</varname> is a top edge of the displayed page (float).
                         </para>
                     </listitem>
 
@@ -302,15 +301,13 @@
 
                     <listitem>
                         <para>
-                            <varname>$right</varname> is a right edge of the displayed page
-                            (float).
+                            <varname>$right</varname> is a right edge of the displayed page (float).
                         </para>
                     </listitem>
 
                     <listitem>
                         <para>
-                            <varname>$top</varname> is a top edge of the displayed page
-                            (float).
+                            <varname>$top</varname> is a top edge of the displayed page (float).
                         </para>
                     </listitem>
                 </itemizedlist>
@@ -634,6 +631,7 @@ $pdf->resolveDestination(Zend_Pdf_Destination_Named::create('Page3'));
                 The following action types are recognized while loading <acronym>PDF</acronym>
                 document:
             </para>
+
             <itemizedlist>
                 <listitem>
                     <para>
@@ -897,6 +895,7 @@ printf("Actions in a tree: %d\n", $actionsCount++);
 
     <sect2 id="zend.pdf.pages.interactive-features.outlines">
         <title>Document Outline (bookmarks)</title>
+
         <para>
             A PDF document may optionally display a document outline on the screen, allowing
             the user to navigate interactively from one part of the document to another.
@@ -915,6 +914,7 @@ printf("Actions in a tree: %d\n", $actionsCount++);
             <classname>Zend_Pdf</classname> class provides public property
             <varname>$outlines</varname> which is an array of
             <classname>Zend_Pdf_Outline</classname> objects.
+
             <programlisting language="php"><![CDATA[
 $pdf = Zend_Pdf::load($path);
 
@@ -1042,7 +1042,8 @@ $pdf->save($path, true);
         <itemizedlist>
             <listitem>
                 <para>
-                    <methodname>Zend_Pdf_Outline::create(string $title[, Zend_Pdf_Target|string $target])</methodname>
+                    <methodname>Zend_Pdf_Outline::create(string $title[, Zend_Pdf_Target|string
+                        $target])</methodname>
                 </para>
             </listitem>
 
@@ -1063,6 +1064,7 @@ $pdf->save($path, true);
         <para>
             <classname>Zend_Pdf_Outline</classname> class implements RecursiveArray interface,
             so child outlines may be recursively iterated using RecursiveIteratorIterator:
+
             <programlisting language="php"><![CDATA[
 $pdf = Zend_Pdf::load($path);
 
@@ -1120,8 +1122,8 @@ $pdf->save($path, true);
 
         <para>
             Annotation may be attached to a page using
-            <methodname>Zend_Pdf_Page::attachAnnotation(Zend_Pdf_Annotation $annotation)</methodname>
-            method.
+            <methodname>Zend_Pdf_Page::attachAnnotation(Zend_Pdf_Annotation
+                $annotation)</methodname> method.
         </para>
 
         <para>
@@ -1131,21 +1133,24 @@ $pdf->save($path, true);
         <itemizedlist>
             <listitem>
                 <para>
-                    <methodname>Zend_Pdf_Annotation_Link::create($x1, $y1, $x2, $y2, $target)</methodname>
-                    where <varname>$target</varname> is an action object or a destination or
-                    string (which may be used in place of named destination object).
+                    <methodname>Zend_Pdf_Annotation_Link::create($x1, $y1, $x2, $y2,
+                        $target)</methodname> where <varname>$target</varname> is an action object
+                    or a destination or string (which may be used in place of named destination
+                    object).
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <methodname>Zend_Pdf_Annotation_Text::create($x1, $y1, $x2, $y2, $text)</methodname>
+                    <methodname>Zend_Pdf_Annotation_Text::create($x1, $y1, $x2, $y2,
+                        $text)</methodname>
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <methodname>Zend_Pdf_Annotation_FileAttachment::create($x1, $y1, $x2, $y2, $fileSpecification)</methodname>
+                    <methodname>Zend_Pdf_Annotation_FileAttachment::create($x1, $y1, $x2, $y2,
+                        $fileSpecification)</methodname>
                 </para>
             </listitem>
         </itemizedlist>
@@ -1236,4 +1241,4 @@ $pdf->save($path, true);
 </sect1>
 <!--
 vim:se ts=4 sw=4 et:
--->
+-->

+ 37 - 29
documentation/manual/en/module_specs/Zend_Pdf-Pages.xml

@@ -2,58 +2,62 @@
 <!-- Reviewed: no -->
 <sect1 id="zend.pdf.pages">
     <title>Working with Pages</title>
+
     <sect2 id="zend.pdf.pages.creation">
         <title>Page Creation</title>
+
         <para>
-            The pages in a <acronym>PDF</acronym> document are represented as <classname>Zend_Pdf_Page</classname> instances in <classname>Zend_Pdf</classname>.
+            The pages in a <acronym>PDF</acronym> document are represented as
+            <classname>Zend_Pdf_Page</classname> instances in <classname>Zend_Pdf</classname>.
         </para>
 
         <para>
-            <acronym>PDF</acronym> pages either are loaded from an existing <acronym>PDF</acronym> or created using the <classname>Zend_Pdf</classname> <acronym>API</acronym>.
+            <acronym>PDF</acronym> pages either are loaded from an existing <acronym>PDF</acronym>
+            or created using the <classname>Zend_Pdf</classname> <acronym>API</acronym>.
         </para>
 
         <para>
-            New pages can be created by instantiating new <classname>Zend_Pdf_Page</classname> objects directly or by calling
-            the <methodname>Zend_Pdf::newPage()</methodname> method, which returns a <classname>Zend_Pdf_Page</classname> object.
+            New pages can be created by instantiating new <classname>Zend_Pdf_Page</classname>
+            objects directly or by calling the <methodname>Zend_Pdf::newPage()</methodname> method,
+            which returns a <classname>Zend_Pdf_Page</classname> object.
             <methodname>Zend_Pdf::newPage()</methodname> creates a page that is already attached to
-            a document. Unattached pages can't be used with multiple <acronym>PDF</acronym> documents,
-            but they are somewhat more performant.
+            a document. Unattached pages can't be used with multiple <acronym>PDF</acronym>
+            documents, but they are somewhat more performant.
+
             <footnote>
                 <para>
-                It's a limitation of current Zend Framework version. It will be eliminated in future versions.
-                But unattached pages will always give better (more optimal) result for sharing pages between documents.
+                    It's a limitation of current Zend Framework version. It will be eliminated in
+                    future versions. But unattached pages will always give better (more optimal)
+                    result for sharing pages between documents.
                 </para>
             </footnote>
         </para>
 
         <para>
-        The <methodname>Zend_Pdf::newPage()</methodname> method and the <classname>Zend_Pdf_Page</classname> constructor take the same
-        parameters specifying page size. They can take either the size of page ($x, $y) in points (1/72 inch)
-        or a predefined constant representing a page type:
+            The <methodname>Zend_Pdf::newPage()</methodname> method and the
+            <classname>Zend_Pdf_Page</classname> constructor take the same parameters specifying
+            page size. They can take either the size of page ($x, $y) in points (1/72 inch) or a
+            predefined constant representing a page type:
+
             <itemizedlist>
-                <listitem>
-                    <para>Zend_Pdf_Page::SIZE_A4</para>
-                </listitem>
-                <listitem>
-                    <para>Zend_Pdf_Page::SIZE_A4_LANDSCAPE</para>
-                </listitem>
-                <listitem>
-                    <para>Zend_Pdf_Page::SIZE_LETTER</para>
-                </listitem>
-                <listitem>
-                    <para>Zend_Pdf_Page::SIZE_LETTER_LANDSCAPE</para>
-                </listitem>
+                <listitem><para>Zend_Pdf_Page::SIZE_A4</para></listitem>
+                <listitem><para>Zend_Pdf_Page::SIZE_A4_LANDSCAPE</para></listitem>
+                <listitem><para>Zend_Pdf_Page::SIZE_LETTER</para></listitem>
+                <listitem><para>Zend_Pdf_Page::SIZE_LETTER_LANDSCAPE</para></listitem>
             </itemizedlist>
         </para>
 
         <para>
-            Document pages are stored in the <varname>$pages</varname> public attribute of the <classname>Zend_Pdf</classname> class.
-            The attribute holds an array of <classname>Zend_Pdf_Page</classname> objects and completely defines the instances and order of pages.
-            This array can be manipulated like any other <acronym>PHP</acronym> array:
+            Document pages are stored in the <varname>$pages</varname> public attribute of the
+            <classname>Zend_Pdf</classname> class. The attribute holds an array of
+            <classname>Zend_Pdf_Page</classname> objects and completely defines the instances and
+            order of pages. This array can be manipulated like any other <acronym>PHP</acronym>
+            array:
         </para>
 
         <example id="zend.pdf.pages.example-1">
             <title>PDF document pages management</title>
+
             <programlisting language="php"><![CDATA[
 ...
 // Reverse page order
@@ -74,12 +78,15 @@ unset($pdf->pages[$id]);
 
     <sect2 id="zend.pdf.pages.cloning">
         <title>Page cloning</title>
+
         <para>
-            Existing <acronym>PDF</acronym> page can be cloned by creating new <classname>Zend_Pdf_Page</classname> object with existing page as a parameter:
+            Existing <acronym>PDF</acronym> page can be cloned by creating new
+            <classname>Zend_Pdf_Page</classname> object with existing page as a parameter:
         </para>
 
         <example id="zend.pdf.pages.example-2">
             <title>Cloning existing page</title>
+
             <programlisting language="php"><![CDATA[
 ...
 // Store template page in a separate variable
@@ -108,8 +115,9 @@ unset($pdf->pages[$templatePageIndex]);
 
         <caution>
             <para>
-                Important! Cloned page shares some <acronym>PDF</acronym> resources with a template page, so it can be used only within the same document
-                as a template page. Modified document can be saved as new one.
+                Important! Cloned page shares some <acronym>PDF</acronym> resources with a template
+                page, so it can be used only within the same document as a template page. Modified
+                document can be saved as new one.
             </para>
         </caution>
     </sect2>

+ 74 - 39
documentation/manual/en/module_specs/Zend_Pdf-Properties.xml

@@ -3,15 +3,18 @@
 <sect1 id="zend.pdf.info">
     <!-- @todo review and revise upon completion of refactoring -->
     <title>Document Info and Metadata</title>
+
     <para>
-        A <acronym>PDF</acronym> document may include general information such as the document's title,
-        author, and creation and modification dates.
+        A <acronym>PDF</acronym> document may include general information such as the document's
+        title, author, and creation and modification dates.
     </para>
+
     <para>
         Historically this information is stored using special Info structure. This structure
-        is available for read and writing as an associative array using <code>properties</code> public property
-        of <classname>Zend_Pdf</classname> objects:
-            <programlisting language="php"><![CDATA[
+        is available for read and writing as an associative array using <code>properties</code>
+        public property of <classname>Zend_Pdf</classname> objects:
+
+        <programlisting language="php"><![CDATA[
 $pdf = Zend_Pdf::load($pdfPath);
 
 echo $pdf->properties['Title'] . "\n";
@@ -20,8 +23,8 @@ echo $pdf->properties['Author'] . "\n";
 $pdf->properties['Title'] = 'New Title.';
 $pdf->save($pdfPath);
 ]]></programlisting>
-
     </para>
+
     <para>
         The following keys are defined by <acronym>PDF</acronym> v1.4 (Acrobat 5) standard:
 
@@ -31,110 +34,139 @@ $pdf->save($pdfPath);
                     <emphasis>Title</emphasis> - string, optional, the document's title.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
-                    <emphasis>Author</emphasis> - string, optional, the name of the person who created the document.
+                    <emphasis>Author</emphasis> - string, optional, the name of the person who
+                    created the document.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
                     <emphasis>Subject</emphasis> - string, optional, the subject of the document.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
-                    <emphasis>Keywords</emphasis> - string, optional, keywords associated with the document.
+                    <emphasis>Keywords</emphasis> - string, optional, keywords associated with the
+                    document.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
-                    <emphasis>Creator</emphasis> - string, optional, if the document was converted to <acronym>PDF</acronym> from another format,
-                    the name of the application (for example, Adobe FrameMaker®) that created the original document from which
-                    it was converted.
+                    <emphasis>Creator</emphasis> - string, optional, if the document was converted
+                    to <acronym>PDF</acronym> from another format, the name of the application (for
+                    example, Adobe FrameMaker®) that created the original document from which it was
+                    converted.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
-                    <emphasis>Producer</emphasis> - string, optional, if the document was converted to <acronym>PDF</acronym> from another format, the
-                    name of the application (for example, Acrobat Distiller) that converted it to <acronym>PDF</acronym>..
+                    <emphasis>Producer</emphasis> - string, optional, if the document was converted
+                    to <acronym>PDF</acronym> from another format, the name of the application (for
+                    example, Acrobat Distiller) that converted it to <acronym>PDF</acronym>..
                 </para>
             </listitem>
+
             <listitem>
                 <para>
-                    <emphasis>CreationDate</emphasis> - string, optional, the date and time the document was created, in the following form:
-                    "D:YYYYMMDDHHmmSSOHH'mm'", where:
+                    <emphasis>CreationDate</emphasis> - string, optional, the date and time the
+                    document was created, in the following form: "D:YYYYMMDDHHmmSSOHH'mm'", where:
+
                     <itemizedlist>
                         <listitem>
                             <para>
                                 <emphasis>YYYY</emphasis> is the year.
                             </para>
                         </listitem>
+
                         <listitem>
                             <para>
                                 <emphasis>MM</emphasis> is the month.
                             </para>
                         </listitem>
+
                         <listitem>
                             <para>
                                 <emphasis>DD</emphasis> is the day (01–31).
                             </para>
                         </listitem>
+
                         <listitem>
                             <para>
                                 <emphasis>HH</emphasis> is the hour (00–23).
                             </para>
                         </listitem>
+
                         <listitem>
                             <para>
                                 <emphasis>mm</emphasis>is the minute (00–59).
                             </para>
                         </listitem>
+
                         <listitem>
                             <para>
                                 <emphasis>SS</emphasis> is the second (00–59).
                             </para>
                         </listitem>
+
                         <listitem>
                             <para>
-                                <emphasis>O</emphasis> is the relationship of local time to Universal Time (UT),
-                                denoted by one of the characters +, −, or Z (see below).
+                                <emphasis>O</emphasis> is the relationship of local time to
+                                Universal Time (UT), denoted by one of the characters +, −, or Z
+                                (see below).
                             </para>
                         </listitem>
+
                         <listitem>
                             <para>
-                                <emphasis>HH</emphasis> followed by ' is the absolute value of the offset from UT in hours (00–23).
+                                <emphasis>HH</emphasis> followed by ' is the absolute value of the
+                                offset from UT in hours (00–23).
                             </para>
                         </listitem>
+
                         <listitem>
                             <para>
-                                <emphasis>mm</emphasis> followed by ' is the absolute value of the offset from UT in minutes (00–59).
+                                <emphasis>mm</emphasis> followed by ' is the absolute value of the
+                                offset from UT in minutes (00–59).
                             </para>
                         </listitem>
                     </itemizedlist>
-                    The apostrophe character (') after HH and mm is part of the syntax. All fields after
-                    the year are optional. (The prefix D:, although also optional, is strongly recommended.)
-                    The default values for MM and DD are both 01; all other numerical
-                    fields default to zero values. A plus sign (+) as the value of the O field signifies that
-                    local time is later than UT, a minus sign (−) that local time is earlier than UT, and
-                    the letter Z that local time is equal to UT. If no UT information is specified, the
-                    relationship of the specified time to UT is considered to be unknown. Whether or
-                    not the time zone is known, the rest of the date should be specified in local time.
+
+                    The apostrophe character (') after HH and mm is part of the syntax. All fields
+                    after the year are optional. (The prefix D:, although also optional, is strongly
+                    recommended.) The default values for MM and DD are both 01; all other numerical
+                    fields default to zero values. A plus sign (+) as the value of the O field
+                    signifies that local time is later than UT, a minus sign (−) that local time is
+                    earlier than UT, and the letter Z that local time is equal to UT. If no UT
+                    information is specified, the relationship of the specified time to UT is
+                    considered to be unknown. Whether or not the time zone is known, the rest of the
+                    date should be specified in local time.
                 </para>
+
                 <para>
-                    For example, December 23, 1998, at 7:52 PM, U.S. Pacific Standard Time, is represented
-                    by the string "D:199812231952−08'00'".
+                    For example, December 23, 1998, at 7:52 PM, U.S. Pacific Standard Time, is
+                    represented by the string "D:199812231952−08'00'".
                 </para>
             </listitem>
+
             <listitem>
                 <para>
-                    <emphasis>ModDate</emphasis> - string, optional, the date and time the document was most recently
-                    modified, in the same form as <emphasis>CreationDate</emphasis>.
+                    <emphasis>ModDate</emphasis> - string, optional, the date and time the document
+                    was most recently modified, in the same form as
+                    <emphasis>CreationDate</emphasis>.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
-                    <emphasis>Trapped</emphasis> - boolean, optional, indicates whether the document has
-                    been modified to include trapping information.
+                    <emphasis>Trapped</emphasis> - boolean, optional, indicates whether the document
+                    has been modified to include trapping information.
+
                     <itemizedlist>
                         <listitem>
                             <para>
@@ -165,14 +197,17 @@ $pdf->save($pdfPath);
     </para>
 
     <para>
-        Since <acronym>PDF</acronym> v 1.6 metadata can be stored in the special <acronym>XML</acronym> document attached to the <acronym>PDF</acronym>
-        (XMP - <ulink url="http://www.adobe.com/products/xmp/">Extensible Metadata Platform</ulink>).
+        Since <acronym>PDF</acronym> v 1.6 metadata can be stored in the special
+        <acronym>XML</acronym> document attached to the <acronym>PDF</acronym> (XMP - <ulink
+            url="http://www.adobe.com/products/xmp/">Extensible Metadata Platform</ulink>).
     </para>
 
     <para>
-        This XML document can be retrieved and attached to the PDF with <methodname>Zend_Pdf::getMetadata()</methodname> and
+        This XML document can be retrieved and attached to the PDF with
+        <methodname>Zend_Pdf::getMetadata()</methodname> and
         <methodname>Zend_Pdf::setMetadata($metadata)</methodname> methods:
-            <programlisting language="php"><![CDATA[
+
+        <programlisting language="php"><![CDATA[
 $pdf = Zend_Pdf::load($pdfPath);
 $metadata = $pdf->getMetadata();
 $metadataDOM = new DOMDocument();
@@ -195,8 +230,8 @@ $pdf->save($pdfPath);
     </para>
 
     <para>
-        Common document properties are duplicated in the Info structure and Metadata document (if presented).
-        It's user application responsibility now to keep them synchronized.
+        Common document properties are duplicated in the Info structure and Metadata document (if
+        presented). It's user application responsibility now to keep them synchronized.
     </para>
 </sect1>
 <!--

+ 4 - 1
documentation/manual/en/module_specs/Zend_ProgressBar_Adapter_JsPull.xml

@@ -2,6 +2,7 @@
 <!-- Reviewed: no -->
 <sect3 id="zend.progressbar.adapter.jspull">
     <title>Zend_ProgressBar_Adapter_JsPull</title>
+
     <para>
         <classname>Zend_ProgressBar_Adapter_JsPull</classname> is the opposite of jsPush,
         as it requires to pull for new updates, instead of pushing updates out
@@ -14,11 +15,13 @@
         <methodname>update()</methodname> is called or <constant>TRUE</constant>, when
         <methodname>finish()</methodname> is called.
     </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>
@@ -30,4 +33,4 @@
 </sect3>
 <!--
 vim:se ts=4 sw=4 et:
--->
+-->

+ 201 - 114
documentation/manual/en/module_specs/Zend_Search_Lucene-Overview.xml

@@ -5,71 +5,90 @@
 
     <sect2 id="zend.search.lucene.introduction">
         <title>Introduction</title>
-        <para><classname>Zend_Search_Lucene</classname> is a general purpose text search engine written entirely in <acronym>PHP</acronym> 5.
-            Since it stores its index on the filesystem and does not require a database
-            server, it can add search capabilities to almost any <acronym>PHP</acronym>-driven website.
+
+        <para>
+            <classname>Zend_Search_Lucene</classname> is a general purpose text search engine
+            written entirely in <acronym>PHP</acronym> 5. Since it stores its index on the
+            filesystem and does not require a database server, it can add search capabilities to
+            almost any <acronym>PHP</acronym>-driven website.
             <classname>Zend_Search_Lucene</classname> supports the following features:
+
             <itemizedlist>
                 <listitem>
                     <para>Ranked searching - best results returned first</para>
                 </listitem>
+
                 <listitem>
                     <para>
                        Many powerful query types: phrase queries, boolean queries, wildcard queries,
                        proximity queries, range queries and many others.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>Search by specific field (e.g., title, author, contents)</para>
                 </listitem>
             </itemizedlist>
 
-            <classname>Zend_Search_Lucene</classname> was derived from the Apache Lucene project. The currently (starting from ZF 1.6) supported Lucene index format
-            versions are 1.4 - 2.3. For more information on Lucene, visit <ulink url="http://lucene.apache.org/java/docs/"/>.
+            <classname>Zend_Search_Lucene</classname> was derived from the Apache Lucene project.
+            The currently (starting from ZF 1.6) supported Lucene index format versions are 1.4 -
+            2.3. For more information on Lucene, visit <ulink
+                url="http://lucene.apache.org/java/docs/"/>.
         </para>
+
         <note>
             <title/>
+
             <para>
-                Previous <classname>Zend_Search_Lucene</classname> implementations support the Lucene 1.4 (1.9) - 2.1 index formats.
+                Previous <classname>Zend_Search_Lucene</classname> implementations support the
+                Lucene 1.4 (1.9) - 2.1 index formats.
             </para>
+
             <para>
-                Starting from Zend Framework 1.5 any index created using pre-2.1 index format is automatically upgraded to Lucene 2.1 format
-                after the <classname>Zend_Search_Lucene</classname> update and will not be compatible with <classname>Zend_Search_Lucene</classname> implementations included into Zend Framework 1.0.x.
+                Starting from Zend Framework 1.5 any index created using pre-2.1 index format is
+                automatically upgraded to Lucene 2.1 format after the
+                <classname>Zend_Search_Lucene</classname> update and will not be compatible with
+                <classname>Zend_Search_Lucene</classname> implementations included into Zend
+                Framework 1.0.x.
             </para>
         </note>
     </sect2>
 
     <sect2 id="zend.search.lucene.index-creation.documents-and-fields">
         <title>Document and Field Objects</title>
-            <para>
-                <classname>Zend_Search_Lucene</classname> operates with documents as atomic objects for indexing. A document is
-                divided into named fields, and fields have content that can be searched.
-            </para>
 
-            <para>
-                A document is represented by the <classname>Zend_Search_Lucene_Document</classname> class, and this objects of this class contain
-                instances of <classname>Zend_Search_Lucene_Field</classname> that represent the fields on the document.
-            </para>
+        <para>
+            <classname>Zend_Search_Lucene</classname> operates with documents as atomic objects for
+            indexing. A document is divided into named fields, and fields have content that can be
+            searched.
+        </para>
 
-            <para>
-                It is important to note that any information can be added to the index.
-                Application-specific information or metadata can be stored in the document
-                fields, and later retrieved with the document during search.
-            </para>
+        <para>
+            A document is represented by the <classname>Zend_Search_Lucene_Document</classname>
+            class, and this objects of this class contain instances of
+            <classname>Zend_Search_Lucene_Field</classname> that represent the fields on the
+            document.
+        </para>
 
-            <para>
-                It is the responsibility of your application to control the indexer.
-                This means that data can be indexed from any source
-                that is accessible by your application. For example, this could be the
-                filesystem, a database, an HTML form, etc.
-            </para>
+        <para>
+            It is important to note that any information can be added to the index.
+            Application-specific information or metadata can be stored in the document
+            fields, and later retrieved with the document during search.
+        </para>
 
-            <para>
-                <classname>Zend_Search_Lucene_Field</classname> class provides several static methods to create fields with
-                different characteristics:
-            </para>
+        <para>
+            It is the responsibility of your application to control the indexer.
+            This means that data can be indexed from any source
+            that is accessible by your application. For example, this could be the
+            filesystem, a database, an HTML form, etc.
+        </para>
 
-            <programlisting language="php"><![CDATA[
+        <para>
+            <classname>Zend_Search_Lucene_Field</classname> class provides several static methods to
+            create fields with different characteristics:
+        </para>
+
+        <programlisting language="php"><![CDATA[
 $doc = new Zend_Search_Lucene_Document();
 
 // Field is not tokenized, but is indexed and stored within the index.
@@ -95,15 +114,17 @@ $doc->addField(Zend_Search_Lucene_Field::UnStored('contents',
                                                   'My document content'));
 ]]></programlisting>
 
-            <para>
-                Each of these methods (excluding the <methodname>Zend_Search_Lucene_Field::Binary()</methodname> method) has an optional
-                <varname>$encoding</varname> parameter for specifying input data encoding.
-            </para>
+        <para>
+            Each of these methods (excluding the
+            <methodname>Zend_Search_Lucene_Field::Binary()</methodname> method) has an optional
+            <varname>$encoding</varname> parameter for specifying input data encoding.
+        </para>
 
-            <para>
-                Encoding may differ for different documents as well as for different fields within one document:
+        <para>
+            Encoding may differ for different documents as well as for different fields within one
+            document:
 
-                <programlisting language="php"><![CDATA[
+            <programlisting language="php"><![CDATA[
 $doc = new Zend_Search_Lucene_Document();
 $doc->addField(Zend_Search_Lucene_Field::Text('title',
                                               $title,
@@ -112,82 +133,97 @@ $doc->addField(Zend_Search_Lucene_Field::UnStored('contents',
                                                   $contents,
                                                   'utf-8'));
 ]]></programlisting>
-            </para>
+        </para>
 
-            <para>
-                If encoding parameter is omitted, then the current locale is used at processing time. For example:
-                <programlisting language="php"><![CDATA[
+        <para>
+            If encoding parameter is omitted, then the current locale is used at processing time.
+            For example:
+
+            <programlisting language="php"><![CDATA[
 setlocale(LC_ALL, 'de_DE.iso-8859-1');
 ...
 $doc->addField(Zend_Search_Lucene_Field::UnStored('contents', $contents));
 ]]></programlisting>
-            </para>
+        </para>
 
-            <para>
-                Fields are always stored and returned from the index in UTF-8 encoding. Any required conversion to UTF-8 happens
-                automatically.
-            </para>
+        <para>
+            Fields are always stored and returned from the index in UTF-8 encoding. Any required
+            conversion to UTF-8 happens automatically.
+        </para>
 
-            <para>
-                Text analyzers (<link linkend="zend.search.lucene.extending.analysis">see below</link>) may also convert text
-                to some other encodings. Actually, the default analyzer converts text to 'ASCII//TRANSLIT' encoding.
-                Be careful, however; this translation may depend on current locale.
-            </para>
+        <para>
+            Text analyzers (<link linkend="zend.search.lucene.extending.analysis">see below</link>)
+            may also convert text to some other encodings. Actually, the default analyzer converts
+            text to 'ASCII//TRANSLIT' encoding. Be careful, however; this translation may depend on
+            current locale.
+        </para>
 
-            <para>
-                Fields' names are defined at your discretion in the <methodname>addField()</methodname> method.
-            </para>
+        <para>
+            Fields' names are defined at your discretion in the <methodname>addField()</methodname>
+            method.
+        </para>
 
-            <para>
-                Java Lucene uses the 'contents' field as a default field to search.
-                <classname>Zend_Search_Lucene</classname> searches through all fields by default, but the behavior is configurable.
-                See the <link linkend="zend.search.lucene.query-language.fields">"Default search field"</link> chapter for details.
-            </para>
+        <para>
+            Java Lucene uses the 'contents' field as a default field to search.
+            <classname>Zend_Search_Lucene</classname> searches through all fields by default, but
+            the behavior is configurable. See the <link
+                linkend="zend.search.lucene.query-language.fields">"Default search field"</link>
+            chapter for details.
+        </para>
     </sect2>
 
     <sect2 id="zend.search.lucene.index-creation.understanding-field-types">
         <title>Understanding Field Types</title>
+
         <itemizedlist>
             <listitem>
                 <para>
-                    <code>Keyword</code> fields are stored and indexed, meaning that they can be searched as well
-                    as displayed in search results. They are not split up into separate words by tokenization.
-                    Enumerated database fields usually translate well to Keyword fields in <classname>Zend_Search_Lucene</classname>.
+                    <code>Keyword</code> fields are stored and indexed, meaning that they can be
+                    searched as well as displayed in search results. They are not split up into
+                    separate words by tokenization. Enumerated database fields usually translate
+                    well to Keyword fields in <classname>Zend_Search_Lucene</classname>.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
-                    <code>UnIndexed</code> fields are not searchable, but they are returned with search hits. Database
-                    timestamps, primary keys, file system paths, and other external identifiers are good
-                    candidates for UnIndexed fields.
+                    <code>UnIndexed</code> fields are not searchable, but they are returned with
+                    search hits. Database timestamps, primary keys, file system paths, and other
+                    external identifiers are good candidates for UnIndexed fields.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
-                    <code>Binary</code> fields are not tokenized or indexed, but are stored for retrieval with search hits.
-                    They can be used to store any data encoded as a binary string, such as an image icon.
+                    <code>Binary</code> fields are not tokenized or indexed, but are stored for
+                    retrieval with search hits. They can be used to store any data encoded as a
+                    binary string, such as an image icon.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
-                    <code>Text</code> fields are stored, indexed, and tokenized. Text fields are appropriate for storing
-                    information like subjects and titles that need to be searchable as well as returned with
-                    search results.
+                    <code>Text</code> fields are stored, indexed, and tokenized. Text fields are
+                    appropriate for storing information like subjects and titles that need to be
+                    searchable as well as returned with search results.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
-                    <code>UnStored</code> fields are tokenized and indexed, but not stored in the index. Large amounts of
-                    text are best indexed using this type of field. Storing data creates a larger index on
-                    disk, so if you need to search but not redisplay the data, use an UnStored field.
-                    UnStored fields are practical when using a <classname>Zend_Search_Lucene</classname> index in
-                    combination with a relational database. You can index large data fields with UnStored
-                    fields for searching, and retrieve them from your relational database by using a separate
-                    field as an identifier.
+                    <code>UnStored</code> fields are tokenized and indexed, but not stored in the
+                    index. Large amounts of text are best indexed using this type of field. Storing
+                    data creates a larger index on disk, so if you need to search but not redisplay
+                    the data, use an UnStored field. UnStored fields are practical when using a
+                    <classname>Zend_Search_Lucene</classname> index in combination with a relational
+                    database. You can index large data fields with UnStored fields for searching,
+                    and retrieve them from your relational database by using a separate field as an
+                    identifier.
                </para>
 
                 <table id="zend.search.lucene.index-creation.understanding-field-types.table">
                     <title>Zend_Search_Lucene_Field Types</title>
+
                     <tgroup cols="5">
                         <thead>
                             <row>
@@ -198,6 +234,7 @@ $doc->addField(Zend_Search_Lucene_Field::UnStored('contents', $contents));
                                 <entry>Binary</entry>
                             </row>
                         </thead>
+
                         <tbody>
                             <row>
                                 <entry>Keyword</entry>
@@ -206,6 +243,7 @@ $doc->addField(Zend_Search_Lucene_Field::UnStored('contents', $contents));
                                 <entry>No</entry>
                                 <entry>No</entry>
                             </row>
+
                             <row>
                                 <entry>UnIndexed</entry>
                                 <entry>Yes</entry>
@@ -213,6 +251,7 @@ $doc->addField(Zend_Search_Lucene_Field::UnStored('contents', $contents));
                                 <entry>No</entry>
                                 <entry>No</entry>
                             </row>
+
                             <row>
                                 <entry>Binary</entry>
                                 <entry>Yes</entry>
@@ -220,6 +259,7 @@ $doc->addField(Zend_Search_Lucene_Field::UnStored('contents', $contents));
                                 <entry>No</entry>
                                 <entry>Yes</entry>
                             </row>
+
                             <row>
                                 <entry>Text</entry>
                                 <entry>Yes</entry>
@@ -227,6 +267,7 @@ $doc->addField(Zend_Search_Lucene_Field::UnStored('contents', $contents));
                                 <entry>Yes</entry>
                                 <entry>No</entry>
                             </row>
+
                             <row>
                                 <entry>UnStored</entry>
                                 <entry>No</entry>
@@ -243,8 +284,11 @@ $doc->addField(Zend_Search_Lucene_Field::UnStored('contents', $contents));
 
     <sect2 id="zend.search.lucene.index-creation.html-documents">
         <title>HTML documents</title>
+
         <para>
-            <classname>Zend_Search_Lucene</classname> offers a HTML parsing feature. Documents can be created directly from a HTML file or string:
+            <classname>Zend_Search_Lucene</classname> offers a HTML parsing feature. Documents can
+            be created directly from a HTML file or string:
+
             <programlisting language="php"><![CDATA[
 $doc = Zend_Search_Lucene_Document_Html::loadHTMLFile($filename);
 $index->addDocument($doc);
@@ -255,21 +299,27 @@ $index->addDocument($doc);
         </para>
 
         <para>
-            <classname>Zend_Search_Lucene_Document_Html</classname> class uses the <methodname>DOMDocument::loadHTML()</methodname> and
-            <methodname>DOMDocument::loadHTMLFile()</methodname> methods to parse the source HTML, so it doesn't need HTML to be well formed or
-            to be <acronym>XHTML</acronym>. On the other hand, it's sensitive to the encoding specified by the "meta http-equiv" header tag.
+            <classname>Zend_Search_Lucene_Document_Html</classname> class uses the
+            <methodname>DOMDocument::loadHTML()</methodname> and
+            <methodname>DOMDocument::loadHTMLFile()</methodname> methods to parse the source HTML,
+            so it doesn't need HTML to be well formed or to be <acronym>XHTML</acronym>. On the
+            other hand, it's sensitive to the encoding specified by the "meta http-equiv" header
+            tag.
         </para>
 
         <para>
-            <classname>Zend_Search_Lucene_Document_Html</classname> class recognizes document title, body and document header meta tags.
+            <classname>Zend_Search_Lucene_Document_Html</classname> class recognizes document title,
+            body and document header meta tags.
         </para>
 
         <para>
-            The 'title' field is actually the /html/head/title value. It's stored within the index, tokenized and available for search.
+            The 'title' field is actually the /html/head/title value. It's stored within the index,
+            tokenized and available for search.
         </para>
 
         <para>
-            The 'body' field is the actual body content of the HTML file or string. It doesn't include scripts, comments or attributes.
+            The 'body' field is the actual body content of the HTML file or string. It doesn't
+            include scripts, comments or attributes.
         </para>
 
         <para>
@@ -281,18 +331,22 @@ $index->addDocument($doc);
         </para>
 
         <para>
-            The third parameter of <methodname>loadHTML()</methodname> and <methodname>loadHTMLFile()</methodname> methods optionally specifies source HTML
-            document encoding. It's used if encoding is not specified using Content-type HTTP-EQUIV meta tag.
+            The third parameter of <methodname>loadHTML()</methodname> and
+            <methodname>loadHTMLFile()</methodname> methods optionally specifies source HTML
+            document encoding. It's used if encoding is not specified using Content-type HTTP-EQUIV
+            meta tag.
         </para>
 
         <para>
-            Other document header meta tags produce additional document fields. The field 'name' is taken from 'name' attribute, and
-            the 'content' attribute populates the field 'value'. Both are tokenized, indexed and stored, so documents may be searched by their meta tags
+            Other document header meta tags produce additional document fields. The field 'name' is
+            taken from 'name' attribute, and the 'content' attribute populates the field 'value'.
+            Both are tokenized, indexed and stored, so documents may be searched by their meta tags
             (for example, by keywords).
         </para>
 
         <para>
             Parsed documents may be augmented by the programmer with any other field:
+
             <programlisting language="php"><![CDATA[
 $doc = Zend_Search_Lucene_Document_Html::loadHTML($htmlString);
 $doc->addField(Zend_Search_Lucene_Field::UnIndexed('created',
@@ -307,8 +361,9 @@ $index->addDocument($doc);
 
         <para>
             Document links are not included in the generated document, but may be retrieved with
-            the <methodname>Zend_Search_Lucene_Document_Html::getLinks()</methodname> and <methodname>Zend_Search_Lucene_Document_Html::getHeaderLinks()</methodname>
-            methods:
+            the <methodname>Zend_Search_Lucene_Document_Html::getLinks()</methodname> and
+            <methodname>Zend_Search_Lucene_Document_Html::getHeaderLinks()</methodname> methods:
+
             <programlisting language="php"><![CDATA[
 $doc = Zend_Search_Lucene_Document_Html::loadHTML($htmlString);
 $linksArray = $doc->getLinks();
@@ -317,19 +372,25 @@ $headerLinksArray = $doc->getHeaderLinks();
         </para>
 
         <para>
-            Starting from Zend Framework 1.6 it's also possible to exclude links with <code>rel</code> attribute set to <code>'nofollow'</code>.
-            Use <methodname>Zend_Search_Lucene_Document_Html::setExcludeNoFollowLinks($true)</methodname> to turn on this option.
+            Starting from Zend Framework 1.6 it's also possible to exclude links with
+            <code>rel</code> attribute set to <code>'nofollow'</code>. Use
+            <methodname>Zend_Search_Lucene_Document_Html::setExcludeNoFollowLinks($true)</methodname>
+            to turn on this option.
         </para>
+
         <para>
-            <methodname>Zend_Search_Lucene_Document_Html::getExcludeNoFollowLinks()</methodname> method returns current state of
-            "Exclude nofollow links" flag.
+            <methodname>Zend_Search_Lucene_Document_Html::getExcludeNoFollowLinks()</methodname>
+            method returns current state of "Exclude nofollow links" flag.
         </para>
     </sect2>
 
     <sect2 id="zend.search.lucene.index-creation.docx-documents">
         <title>Word 2007 documents</title>
+
         <para>
-            <classname>Zend_Search_Lucene</classname> offers a Word 2007 parsing feature. Documents can be created directly from a Word 2007 file:
+            <classname>Zend_Search_Lucene</classname> offers a Word 2007 parsing feature. Documents
+            can be created directly from a Word 2007 file:
+
             <programlisting language="php"><![CDATA[
 $doc = Zend_Search_Lucene_Document_Docx::loadDocxFile($filename);
 $index->addDocument($doc);
@@ -337,13 +398,18 @@ $index->addDocument($doc);
         </para>
 
         <para>
-            <classname>Zend_Search_Lucene_Document_Docx</classname> class uses the <code>ZipArchive</code> class and
-            <code>simplexml</code> methods to parse the source document. If the <code>ZipArchive</code> class (from module php_zip)
-            is not available, the <classname>Zend_Search_Lucene_Document_Docx</classname> will also not be available for use with Zend Framework.
+            <classname>Zend_Search_Lucene_Document_Docx</classname> class uses the
+            <code>ZipArchive</code> class and <code>simplexml</code> methods to parse the source
+            document. If the <code>ZipArchive</code> class (from module php_zip) is not available,
+            the <classname>Zend_Search_Lucene_Document_Docx</classname> will also not be available
+            for use with Zend Framework.
         </para>
 
         <para>
-            <classname>Zend_Search_Lucene_Document_Docx</classname> class recognizes document meta data and document text. Meta data consists, depending on document contents, of filename, title, subject, creator, keywords, description, lastModifiedBy, revision, modified, created.
+            <classname>Zend_Search_Lucene_Document_Docx</classname> class recognizes document meta
+            data and document text. Meta data consists, depending on document contents, of filename,
+            title, subject, creator, keywords, description, lastModifiedBy, revision, modified,
+            created.
         </para>
 
         <para>
@@ -387,7 +453,8 @@ $index->addDocument($doc);
         </para>
 
         <para>
-            The 'body' field is the actual body content of the Word 2007 document. It only includes normal text, comments and revisions are not included.
+            The 'body' field is the actual body content of the Word 2007 document. It only includes
+            normal text, comments and revisions are not included.
         </para>
 
         <para>
@@ -400,6 +467,7 @@ $index->addDocument($doc);
 
         <para>
             Parsed documents may be augmented by the programmer with any other field:
+
             <programlisting language="php"><![CDATA[
 $doc = Zend_Search_Lucene_Document_Docx::loadDocxFile($filename);
 $doc->addField(Zend_Search_Lucene_Field::UnIndexed(
@@ -418,8 +486,11 @@ $index->addDocument($doc);
 
     <sect2 id="zend.search.lucene.index-creation.pptx-documents">
         <title>Powerpoint 2007 documents</title>
+
         <para>
-            <classname>Zend_Search_Lucene</classname> offers a Powerpoint 2007 parsing feature. Documents can be created directly from a Powerpoint 2007 file:
+            <classname>Zend_Search_Lucene</classname> offers a Powerpoint 2007 parsing feature.
+            Documents can be created directly from a Powerpoint 2007 file:
+
             <programlisting language="php"><![CDATA[
 $doc = Zend_Search_Lucene_Document_Pptx::loadPptxFile($filename);
 $index->addDocument($doc);
@@ -427,13 +498,18 @@ $index->addDocument($doc);
         </para>
 
         <para>
-            <classname>Zend_Search_Lucene_Document_Pptx</classname> class uses the <code>ZipArchive</code> class and
-            <code>simplexml</code> methods to parse the source document. If the <code>ZipArchive</code> class (from module php_zip)
-            is not available, the <classname>Zend_Search_Lucene_Document_Pptx</classname> will also not be available for use with Zend Framework.
+            <classname>Zend_Search_Lucene_Document_Pptx</classname> class uses the
+            <code>ZipArchive</code> class and <code>simplexml</code> methods to parse the source
+            document. If the <code>ZipArchive</code> class (from module php_zip) is not available,
+            the <classname>Zend_Search_Lucene_Document_Pptx</classname> will also not be available
+            for use with Zend Framework.
         </para>
 
         <para>
-            <classname>Zend_Search_Lucene_Document_Pptx</classname> class recognizes document meta data and document text. Meta data consists, depending on document contents, of filename, title, subject, creator, keywords, description, lastModifiedBy, revision, modified, created.
+            <classname>Zend_Search_Lucene_Document_Pptx</classname> class recognizes document meta
+            data and document text. Meta data consists, depending on document contents, of filename,
+            title, subject, creator, keywords, description, lastModifiedBy, revision, modified,
+            created.
         </para>
 
         <para>
@@ -477,7 +553,8 @@ $index->addDocument($doc);
         </para>
 
         <para>
-            The 'body' field is the actual content of all slides and slide notes in the Powerpoint 2007 document.
+            The 'body' field is the actual content of all slides and slide notes in the Powerpoint
+            2007 document.
         </para>
 
         <para>
@@ -490,6 +567,7 @@ $index->addDocument($doc);
 
         <para>
             Parsed documents may be augmented by the programmer with any other field:
+
             <programlisting language="php"><![CDATA[
 $doc = Zend_Search_Lucene_Document_Pptx::loadPptxFile($filename);
 $doc->addField(Zend_Search_Lucene_Field::UnIndexed(
@@ -506,7 +584,9 @@ $index->addDocument($doc);
     <sect2 id="zend.search.lucene.index-creation.xlsx-documents">
         <title>Excel 2007 documents</title>
         <para>
-            <classname>Zend_Search_Lucene</classname> offers a Excel 2007 parsing feature. Documents can be created directly from a Excel 2007 file:
+            <classname>Zend_Search_Lucene</classname> offers a Excel 2007 parsing feature. Documents
+            can be created directly from a Excel 2007 file:
+
             <programlisting language="php"><![CDATA[
 $doc = Zend_Search_Lucene_Document_Xlsx::loadXlsxFile($filename);
 $index->addDocument($doc);
@@ -514,13 +594,18 @@ $index->addDocument($doc);
         </para>
 
         <para>
-            <classname>Zend_Search_Lucene_Document_Xlsx</classname> class uses the <code>ZipArchive</code> class and
-            <code>simplexml</code> methods to parse the source document. If the <code>ZipArchive</code> class (from module php_zip)
-            is not available, the <classname>Zend_Search_Lucene_Document_Xlsx</classname> will also not be available for use with Zend Framework.
+            <classname>Zend_Search_Lucene_Document_Xlsx</classname> class uses the
+            <code>ZipArchive</code> class and <code>simplexml</code> methods to parse the source
+            document. If the <code>ZipArchive</code> class (from module php_zip) is not available,
+            the <classname>Zend_Search_Lucene_Document_Xlsx</classname> will also not be available
+            for use with Zend Framework.
         </para>
 
         <para>
-            <classname>Zend_Search_Lucene_Document_Xlsx</classname> class recognizes document meta data and document text. Meta data consists, depending on document contents, of filename, title, subject, creator, keywords, description, lastModifiedBy, revision, modified, created.
+            <classname>Zend_Search_Lucene_Document_Xlsx</classname> class recognizes document meta
+            data and document text. Meta data consists, depending on document contents, of filename,
+            title, subject, creator, keywords, description, lastModifiedBy, revision, modified,
+            created.
         </para>
 
         <para>
@@ -564,7 +649,8 @@ $index->addDocument($doc);
         </para>
 
         <para>
-            The 'body' field is the actual content of all cells in all worksheets of the Excel 2007 document.
+            The 'body' field is the actual content of all cells in all worksheets of the Excel 2007
+            document.
         </para>
 
         <para>
@@ -577,6 +663,7 @@ $index->addDocument($doc);
 
         <para>
             Parsed documents may be augmented by the programmer with any other field:
+
             <programlisting language="php"><![CDATA[
 $doc = Zend_Search_Lucene_Document_Xlsx::loadXlsxFile($filename);
 $doc->addField(Zend_Search_Lucene_Field::UnIndexed(

+ 161 - 92
documentation/manual/en/module_specs/Zend_Search_Lucene-Queries.xml

@@ -4,11 +4,14 @@
     <title>Query Construction API</title>
 
     <para>
-        In addition to parsing a string query automatically it's also possible to construct them with the query <acronym>API</acronym>.
+        In addition to parsing a string query automatically it's also possible to construct them
+        with the query <acronym>API</acronym>.
     </para>
 
     <para>
-        User queries can be combined with queries created through the query API. Simply use the query parser to construct a query from a string:
+        User queries can be combined with queries created through the query API. Simply use the
+        query parser to construct a query from a string:
+
         <programlisting language="php"><![CDATA[
 $query = Zend_Search_Lucene_Search_QueryParser::parse($queryString);
 ]]></programlisting>
@@ -18,21 +21,29 @@ $query = Zend_Search_Lucene_Search_QueryParser::parse($queryString);
         <title>Query Parser Exceptions</title>
 
         <para>
-        The query parser may generate two types of exceptions:
-        <itemizedlist>
-            <listitem>
-                <para>
-                    <classname>Zend_Search_Lucene_Exception</classname> is thrown if something goes wrong in the query parser itself.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <classname>Zend_Search_Lucene_Search_QueryParserException</classname> is thrown when there is an error in the query syntax.
-                </para>
-            </listitem>
-        </itemizedlist>
-        It's a good idea to catch <classname>Zend_Search_Lucene_Search_QueryParserException</classname>s and handle them appropriately:
-        <programlisting language="php"><![CDATA[
+            The query parser may generate two types of exceptions:
+
+            <itemizedlist>
+                <listitem>
+                    <para>
+                        <classname>Zend_Search_Lucene_Exception</classname> is thrown if something
+                        goes wrong in the query parser itself.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <classname>Zend_Search_Lucene_Search_QueryParserException</classname> is
+                        thrown when there is an error in the query syntax.
+                    </para>
+                </listitem>
+            </itemizedlist>
+
+            It's a good idea to catch
+            <classname>Zend_Search_Lucene_Search_QueryParserException</classname>s and handle them
+            appropriately:
+
+            <programlisting language="php"><![CDATA[
 try {
     $query = Zend_Search_Lucene_Search_QueryParser::parse($queryString);
 } catch (Zend_Search_Lucene_Search_QueryParserException $e) {
@@ -42,32 +53,34 @@ try {
         </para>
 
         <para>
-            The same technique should be used for the find() method of a <classname>Zend_Search_Lucene</classname> object.
+            The same technique should be used for the find() method of a
+            <classname>Zend_Search_Lucene</classname> object.
         </para>
 
         <para>
-            Starting in 1.5, query parsing exceptions are suppressed by default. If query doesn't conform query language,
-            then it's tokenized using current default analyzer and all tokenized terms are used for searching.
-
-            Use <methodname>Zend_Search_Lucene_Search_QueryParser::dontSuppressQueryParsingExceptions()</methodname> method
-            to turn exceptions on.
-            <methodname>Zend_Search_Lucene_Search_QueryParser::suppressQueryParsingExceptions()</methodname> and
-            <methodname>Zend_Search_Lucene_Search_QueryParser::queryParsingExceptionsSuppressed()</methodname> methods are also
-            intended to manage exceptions handling behavior.
-
+            Starting in 1.5, query parsing exceptions are suppressed by default. If query doesn't
+            conform query language, then it's tokenized using current default analyzer and all
+            tokenized terms are used for searching. Use
+            <methodname>Zend_Search_Lucene_Search_QueryParser::dontSuppressQueryParsingExceptions()</methodname>
+            method to turn exceptions on.
+            <methodname>Zend_Search_Lucene_Search_QueryParser::suppressQueryParsingExceptions()</methodname>
+            and
+            <methodname>Zend_Search_Lucene_Search_QueryParser::queryParsingExceptionsSuppressed()</methodname>
+            methods are also intended to manage exceptions handling behavior.
         </para>
-
     </sect2>
 
     <sect2 id="zend.search.lucene.queries.term-query">
         <title>Term Query</title>
+
         <para>
             Term queries can be used for searching with a single term.
         </para>
 
         <para>
-        Query string:
+            Query string:
         </para>
+
         <programlisting language="querystring"><![CDATA[
 word1
 ]]></programlisting>
@@ -75,8 +88,9 @@ word1
         <para>or</para>
 
         <para>
-        Query construction by <acronym>API</acronym>:
+            Query construction by <acronym>API</acronym>:
         </para>
+
         <programlisting language="php"><![CDATA[
 $term  = new Zend_Search_Lucene_Index_Term('word1', 'field1');
 $query = new Zend_Search_Lucene_Search_Query_Term($term);
@@ -84,7 +98,9 @@ $hits  = $index->find($query);
 ]]></programlisting>
 
         <para>
-            The term field is optional. <classname>Zend_Search_Lucene</classname> searches through all indexed fields in each document if the field is not specified:
+            The term field is optional. <classname>Zend_Search_Lucene</classname> searches through
+            all indexed fields in each document if the field is not specified:
+
             <programlisting language="php"><![CDATA[
 // Search for 'word1' in all indexed fields
 $term  = new Zend_Search_Lucene_Index_Term('word1');
@@ -96,6 +112,7 @@ $hits  = $index->find($query);
 
     <sect2 id="zend.search.lucene.queries.multiterm-query">
         <title>Multi-Term Query</title>
+
         <para>
             Multi-term queries can be used for searching with a set of terms.
         </para>
@@ -107,29 +124,31 @@ $hits  = $index->find($query);
             <itemizedlist>
                 <listitem>
                     <para>
-                        <emphasis>required</emphasis> means that documents not matching this term will not match
-                        the query;
+                        <emphasis>required</emphasis> means that documents not matching this term
+                        will not match the query;
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <emphasis>prohibited</emphasis> means that documents matching this term will not match
-                        the query;
+                        <emphasis>prohibited</emphasis> means that documents matching this term will
+                        not match the query;
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <emphasis>neither</emphasis>, in which case matched documents are neither prohibited
-                        from, nor required to, match the term. A document must match at least 1 term, however, to
-                        match the query.
+                        <emphasis>neither</emphasis>, in which case matched documents are neither
+                        prohibited from, nor required to, match the term. A document must match at
+                        least 1 term, however, to match the query.
                     </para>
                 </listitem>
             </itemizedlist>
         </para>
 
         <para>
-            If optional terms are added to a query with required terms,
-            both queries will have the same result set but the optional terms may affect the score of the matched documents.
+            If optional terms are added to a query with required terms, both queries will have the
+            same result set but the optional terms may affect the score of the matched documents.
         </para>
 
         <para>
@@ -139,21 +158,15 @@ $hits  = $index->find($query);
         <para>
             Query string:
         </para>
+
         <programlisting language="querystring"><![CDATA[
 +word1 author:word2 -word3
 ]]></programlisting>
 
         <itemizedlist>
-            <listitem>
-                <para>
-                    '+' is used to define a required term.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    '-' is used to define a prohibited term.
-                </para>
-            </listitem>
+            <listitem><para>'+' is used to define a required term.</para></listitem>
+            <listitem><para>'-' is used to define a prohibited term.</para></listitem>
+
             <listitem>
                 <para>
                     'field:' prefix is used to indicate a document field for a search.
@@ -165,8 +178,9 @@ $hits  = $index->find($query);
         <para>or</para>
 
         <para>
-        Query construction by <acronym>API</acronym>:
+            Query construction by <acronym>API</acronym>:
         </para>
+
         <programlisting language="php"><![CDATA[
 $query = new Zend_Search_Lucene_Search_Query_MultiTerm();
 
@@ -180,6 +194,7 @@ $hits  = $index->find($query);
 
         <para>
             It's also possible to specify terms list within MultiTerm query constructor:
+
             <programlisting language="php"><![CDATA[
 $terms = array(new Zend_Search_Lucene_Index_Term('word1'),
                new Zend_Search_Lucene_Index_Term('word2', 'author'),
@@ -194,12 +209,14 @@ $hits  = $index->find($query);
 
         <para>
             The <varname>$signs</varname> array contains information about the term type:
+
             <itemizedlist>
                 <listitem>
                     <para>
                         <constant>TRUE</constant> is used to define required term.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
                         <constant>FALSE</constant> is used to define prohibited term.
@@ -218,6 +235,7 @@ $hits  = $index->find($query);
 
     <sect2 id="zend.search.lucene.queries.boolean-query">
         <title>Boolean Query</title>
+
         <para>
             Boolean queries allow to construct query using other queries and boolean operators.
         </para>
@@ -229,29 +247,32 @@ $hits  = $index->find($query);
             <itemizedlist>
                 <listitem>
                     <para>
-                        <emphasis>required</emphasis> means that documents not matching this subquery will not match
-                        the query;
+                        <emphasis>required</emphasis> means that documents not matching this
+                        subquery will not match the query;
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <emphasis>prohibited</emphasis> means that documents matching this subquery will not match
-                        the query;
+                        <emphasis>prohibited</emphasis> means that documents matching this subquery
+                        will not match the query;
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <emphasis>optional</emphasis>, in which case matched documents are neither prohibited
-                        from, nor required to, match the subquery. A document must match at least 1 subquery, however, to
-                        match the query.
+                        <emphasis>optional</emphasis>, in which case matched documents are neither
+                        prohibited from, nor required to, match the subquery. A document must match
+                        at least 1 subquery, however, to match the query.
                     </para>
                 </listitem>
             </itemizedlist>
         </para>
 
         <para>
-            If optional subqueries are added to a query with required subqueries,
-            both queries will have the same result set but the optional subqueries may affect the score of the matched documents.
+            If optional subqueries are added to a query with required subqueries, both queries will
+            have the same result set but the optional subqueries may affect the score of the matched
+            documents.
         </para>
 
         <para>
@@ -261,6 +282,7 @@ $hits  = $index->find($query);
         <para>
             Query string:
         </para>
+
         <programlisting language="querystring"><![CDATA[
 +(word1 word2 word3) (author:word4 author:word5) -(word6)
 ]]></programlisting>
@@ -271,11 +293,13 @@ $hits  = $index->find($query);
                     '+' is used to define a required subquery.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
                     '-' is used to define a prohibited subquery.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
                     'field:' prefix is used to indicate a document field for a search.
@@ -287,8 +311,9 @@ $hits  = $index->find($query);
         <para>or</para>
 
         <para>
-        Query construction by <acronym>API</acronym>:
+            Query construction by <acronym>API</acronym>:
         </para>
+
         <programlisting language="php"><![CDATA[
 $query = new Zend_Search_Lucene_Search_Query_Boolean();
 
@@ -326,12 +351,14 @@ $hits  = $index->find($query);
 
         <para>
             The <varname>$signs</varname> array contains information about the subquery type:
+
             <itemizedlist>
                 <listitem>
                     <para>
                         <constant>TRUE</constant> is used to define required subquery.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
                         <constant>FALSE</constant> is used to define prohibited subquery.
@@ -348,7 +375,9 @@ $hits  = $index->find($query);
         </para>
 
         <para>
-            Each query which uses boolean operators can be rewritten using signs notation and constructed using API. For example:
+            Each query which uses boolean operators can be rewritten using signs notation and
+            constructed using API. For example:
+
             <programlisting language="querystring"><![CDATA[
 word1 AND (word2 AND word3 AND NOT word4) OR word5
 ]]></programlisting>
@@ -361,8 +390,10 @@ word1 AND (word2 AND word3 AND NOT word4) OR word5
 
     <sect2 id="zend.search.lucene.queries.wildcard">
         <title>Wildcard Query</title>
+
         <para>
-            Wildcard queries can be used to search for documents containing strings matching specified patterns.
+            Wildcard queries can be used to search for documents containing strings matching
+            specified patterns.
         </para>
 
         <para>
@@ -375,6 +406,7 @@ word1 AND (word2 AND word3 AND NOT word4) OR word5
 
         <para>
             Query string:
+
             <programlisting language="querystring"><![CDATA[
 field1:test*
 ]]></programlisting>
@@ -384,6 +416,7 @@ field1:test*
 
         <para>
             Query construction by API:
+
             <programlisting language="php"><![CDATA[
 $pattern = new Zend_Search_Lucene_Index_Term('test*', 'field1');
 $query = new Zend_Search_Lucene_Search_Query_Wildcard($pattern);
@@ -392,7 +425,9 @@ $hits  = $index->find($query);
         </para>
 
         <para>
-            The term field is optional. <classname>Zend_Search_Lucene</classname> searches through all fields on each document if a field is not specified:
+            The term field is optional. <classname>Zend_Search_Lucene</classname> searches through
+            all fields on each document if a field is not specified:
+
             <programlisting language="php"><![CDATA[
 $pattern = new Zend_Search_Lucene_Index_Term('test*');
 $query = new Zend_Search_Lucene_Search_Query_Wildcard($pattern);
@@ -403,15 +438,19 @@ $hits  = $index->find($query);
 
     <sect2 id="zend.search.lucene.queries.fuzzy">
         <title>Fuzzy Query</title>
+
         <para>
-            Fuzzy queries can be used to search for documents containing strings matching terms similar to specified term.
+            Fuzzy queries can be used to search for documents containing strings matching terms
+            similar to specified term.
         </para>
 
         <para>
             Query string:
+
             <programlisting language="querystring"><![CDATA[
 field1:test~
 ]]></programlisting>
+
             This query matches documents containing 'test' 'text' 'best' words and others.
         </para>
 
@@ -419,6 +458,7 @@ field1:test~
 
         <para>
             Query construction by API:
+
             <programlisting language="php"><![CDATA[
 $term = new Zend_Search_Lucene_Index_Term('test', 'field1');
 $query = new Zend_Search_Lucene_Search_Query_Fuzzy($term);
@@ -432,6 +472,7 @@ $hits  = $index->find($query);
 
         <para>
             Query string:
+
             <programlisting language="querystring"><![CDATA[
 field1:test~0.4
 ]]></programlisting>
@@ -441,6 +482,7 @@ field1:test~0.4
 
         <para>
             Query construction by API:
+
             <programlisting language="php"><![CDATA[
 $term = new Zend_Search_Lucene_Index_Term('test', 'field1');
 $query = new Zend_Search_Lucene_Search_Query_Fuzzy($term, 0.4);
@@ -449,7 +491,9 @@ $hits  = $index->find($query);
         </para>
 
         <para>
-            The term field is optional. <classname>Zend_Search_Lucene</classname> searches through all fields on each document if a field is not specified:
+            The term field is optional. <classname>Zend_Search_Lucene</classname> searches through
+            all fields on each document if a field is not specified:
+
             <programlisting language="php"><![CDATA[
 $term = new Zend_Search_Lucene_Index_Term('test');
 $query = new Zend_Search_Lucene_Search_Query_Fuzzy($term);
@@ -460,18 +504,20 @@ $hits  = $index->find($query);
 
     <sect2 id="zend.search.lucene.queries.phrase-query">
         <title>Phrase Query</title>
+
         <para>
             Phrase Queries can be used to search for a phrase within documents.
         </para>
 
         <para>
-            Phrase Queries are very flexible and allow the user or developer to search for exact phrases as well as 'sloppy' phrases.
+            Phrase Queries are very flexible and allow the user or developer to search for exact
+            phrases as well as 'sloppy' phrases.
         </para>
 
         <para>
             Phrases can also contain gaps or terms in the same places; they can be generated by
-            the analyzer for different purposes. For example, a term can be duplicated to increase the term
-            its weight, or several synonyms can be placed into a single position.
+            the analyzer for different purposes. For example, a term can be duplicated to increase
+            the term its weight, or several synonyms can be placed into a single position.
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -504,13 +550,16 @@ $query4 = new Zend_Search_Lucene_Search_Query_Phrase(
 ]]></programlisting>
 
         <para>
-            A phrase query can be constructed in one step with a class constructor or step by step with
-            <methodname>Zend_Search_Lucene_Search_Query_Phrase::addTerm()</methodname> method calls.
+            A phrase query can be constructed in one step with a class constructor or step by step
+            with <methodname>Zend_Search_Lucene_Search_Query_Phrase::addTerm()</methodname> method
+            calls.
         </para>
 
         <para>
-            <classname>Zend_Search_Lucene_Search_Query_Phrase</classname> class constructor takes three optional arguments:
+            <classname>Zend_Search_Lucene_Search_Query_Phrase</classname> class constructor takes
+            three optional arguments:
         </para>
+
         <programlisting language="php"><![CDATA[
 Zend_Search_Lucene_Search_Query_Phrase(
     [array $terms[, array $offsets[, string $field]]]
@@ -538,10 +587,12 @@ Zend_Search_Lucene_Search_Query_Phrase(
         <para>
             Thus:
         </para>
+
         <programlisting language="php"><![CDATA[
 $query =
     new Zend_Search_Lucene_Search_Query_Phrase(array('zend', 'framework'));
 ]]></programlisting>
+
         <para>
             will search for the phrase 'zend framework' in all fields.
         </para>
@@ -551,9 +602,10 @@ $query = new Zend_Search_Lucene_Search_Query_Phrase(
                  array('zend', 'download'), array(0, 2)
              );
 ]]></programlisting>
+
         <para>
-            will search for the phrase 'zend ????? download' and match 'zend platform download', 'zend studio
-            download', 'zend core download', 'zend framework download', and so on.
+            will search for the phrase 'zend ????? download' and match 'zend platform download',
+            'zend studio download', 'zend core download', 'zend framework download', and so on.
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -567,9 +619,11 @@ $query = new Zend_Search_Lucene_Search_Query_Phrase(
         </para>
 
         <para>
-            <methodname>Zend_Search_Lucene_Search_Query_Phrase::addTerm()</methodname> takes two arguments, a
-            required <classname>Zend_Search_Lucene_Index_Term</classname> object and an optional position:
+            <methodname>Zend_Search_Lucene_Search_Query_Phrase::addTerm()</methodname> takes two
+            arguments, a required <classname>Zend_Search_Lucene_Index_Term</classname> object and an
+            optional position:
         </para>
+
         <programlisting language="php"><![CDATA[
 Zend_Search_Lucene_Search_Query_Phrase::addTerm(
     Zend_Search_Lucene_Index_Term $term[, integer $position]
@@ -577,7 +631,8 @@ Zend_Search_Lucene_Search_Query_Phrase::addTerm(
 ]]></programlisting>
 
         <para>
-            The <varname>$term</varname> parameter describes the next term in the phrase. It must indicate the same field as previous terms, or an exception will be thrown.
+            The <varname>$term</varname> parameter describes the next term in the phrase. It must
+            indicate the same field as previous terms, or an exception will be thrown.
         </para>
 
         <para>
@@ -587,11 +642,13 @@ Zend_Search_Lucene_Search_Query_Phrase::addTerm(
         <para>
             Thus:
         </para>
+
         <programlisting language="php"><![CDATA[
 $query = new Zend_Search_Lucene_Search_Query_Phrase();
 $query->addTerm(new Zend_Search_Lucene_Index_Term('zend'));
 $query->addTerm(new Zend_Search_Lucene_Index_Term('framework'));
 ]]></programlisting>
+
         <para>
             will search for the phrase 'zend framework'.
          </para>
@@ -601,37 +658,44 @@ $query = new Zend_Search_Lucene_Search_Query_Phrase();
 $query->addTerm(new Zend_Search_Lucene_Index_Term('zend'), 0);
 $query->addTerm(new Zend_Search_Lucene_Index_Term('framework'), 2);
 ]]></programlisting>
+
         <para>
-            will search for the phrase 'zend ????? download' and match 'zend platform download', 'zend studio
-            download', 'zend core download', 'zend framework download', and so on.
+            will search for the phrase 'zend ????? download' and match 'zend platform download',
+            'zend studio download', 'zend core download', 'zend framework download', and so on.
         </para>
+
         <programlisting language="php"><![CDATA[
 $query = new Zend_Search_Lucene_Search_Query_Phrase();
 $query->addTerm(new Zend_Search_Lucene_Index_Term('zend', 'title'));
 $query->addTerm(new Zend_Search_Lucene_Index_Term('framework', 'title'));
 ]]></programlisting>
+
         <para>
             will search for the phrase 'zend framework' in the 'title' field.
         </para>
 
         <para>
-            The slop factor sets the number of other words permitted between specified words in the query phrase. If set to zero,
-            then the corresponding query is an exact phrase search. For larger values this works like the WITHIN or NEAR
-            operators.
+            The slop factor sets the number of other words permitted between specified words in the
+            query phrase. If set to zero, then the corresponding query is an exact phrase search.
+            For larger values this works like the WITHIN or NEAR operators.
         </para>
+
         <para>
-            The slop factor is in fact an edit distance, where the edits correspond to moving terms in the query
-            phrase. For example, to switch the order of two words requires two moves (the
-            first move places the words atop one another), so to permit re-orderings of phrases, the slop factor
-            must be at least two.
+            The slop factor is in fact an edit distance, where the edits correspond to moving terms
+            in the query phrase. For example, to switch the order of two words requires two moves
+            (the first move places the words atop one another), so to permit re-orderings of
+            phrases, the slop factor must be at least two.
         </para>
+
         <para>
-            More exact matches are scored higher than sloppier matches; thus, search results are sorted by
-            exactness. The slop is zero by default, requiring exact matches.
+            More exact matches are scored higher than sloppier matches; thus, search results are
+            sorted by exactness. The slop is zero by default, requiring exact matches.
         </para>
+
         <para>
             The slop factor can be assigned after query creation:
         </para>
+
         <programlisting language="php"><![CDATA[
 // Query without a gap.
 $query =
@@ -650,12 +714,15 @@ $hits2 = $index->find($query);
 
     <sect2 id="zend.search.lucene.queries.range">
         <title>Range Query</title>
+
         <para>
-            <link linkend="zend.search.lucene.query-language.range">Range queries</link> are intended for searching terms within specified interval.
+            <link linkend="zend.search.lucene.query-language.range">Range queries</link> are
+            intended for searching terms within specified interval.
         </para>
 
         <para>
             Query string:
+
             <programlisting language="querystring"><![CDATA[
 mod_date:[20020101 TO 20030101]
 title:{Aida TO Carmen}
@@ -666,6 +733,7 @@ title:{Aida TO Carmen}
 
         <para>
             Query construction by API:
+
             <programlisting language="php"><![CDATA[
 $from = new Zend_Search_Lucene_Index_Term('20020101', 'mod_date');
 $to   = new Zend_Search_Lucene_Index_Term('20030101', 'mod_date');
@@ -677,7 +745,9 @@ $hits  = $index->find($query);
         </para>
 
         <para>
-            Term fields are optional. <classname>Zend_Search_Lucene</classname> searches through all fields if the field is not specified:
+            Term fields are optional. <classname>Zend_Search_Lucene</classname> searches through all
+            fields if the field is not specified:
+
             <programlisting language="php"><![CDATA[
 $from = new Zend_Search_Lucene_Index_Term('Aida');
 $to   = new Zend_Search_Lucene_Index_Term('Carmen');
@@ -692,6 +762,7 @@ $hits  = $index->find($query);
             Either (but not both) of the boundary terms may be set to <constant>NULL</constant>.
             <classname>Zend_Search_Lucene</classname> searches from the beginning or
             up to the end of the dictionary for the specified field(s) in this case:
+
             <programlisting language="php"><![CDATA[
 // searches for ['20020101' TO ...]
 $from = new Zend_Search_Lucene_Index_Term('20020101', 'mod_date');
@@ -702,9 +773,7 @@ $hits  = $index->find($query);
 ]]></programlisting>
         </para>
     </sect2>
-
 </sect1>
-
 <!--
 vim:se ts=4 sw=4 et:
 -->

+ 202 - 89
documentation/manual/en/module_specs/Zend_Search_Lucene-QueryLanguage.xml

@@ -4,7 +4,8 @@
     <title>Query Language</title>
 
     <para>
-        Java Lucene and <classname>Zend_Search_Lucene</classname> provide quite powerful query languages.
+        Java Lucene and <classname>Zend_Search_Lucene</classname> provide quite powerful query
+        languages.
     </para>
 
     <para>
@@ -20,20 +21,25 @@
         <title>Terms</title>
 
         <para>
-            A query is broken up into terms and operators. There are three types of terms: Single Terms, Phrases,
-            and Subqueries.
+            A query is broken up into terms and operators. There are three types of terms: Single
+            Terms, Phrases, and Subqueries.
         </para>
+
         <para>
             A Single Term is a single word such as "test" or "hello".
         </para>
+
         <para>
             A Phrase is a group of words surrounded by double quotes such as "hello dolly".
         </para>
+
         <para>
             A Subquery is a query surrounded by parentheses such as "(hello dolly)".
         </para>
+
         <para>
-            Multiple terms can be combined together with boolean operators to form complex queries (see below).
+            Multiple terms can be combined together with boolean operators to form complex queries
+            (see below).
         </para>
     </sect2>
 
@@ -41,17 +47,21 @@
         <title>Fields</title>
 
         <para>
-            Lucene supports fields of data. When performing a search you can either specify a field, or use
-            the default field. The field names depend on indexed data and default field is defined
-            by current settings.
+            Lucene supports fields of data. When performing a search you can either specify a field,
+            or use the default field. The field names depend on indexed data and default field is
+            defined by current settings.
         </para>
+
         <para>
-            The first and most significant difference from Java Lucene is that terms are searched through
-            <emphasis>all fields</emphasis> by default.
+            The first and most significant difference from Java Lucene is that terms are searched
+            through <emphasis>all fields</emphasis> by default.
         </para>
+
         <para>
-            There are two static methods in the <classname>Zend_Search_Lucene</classname> class which allow the developer to configure these settings:
+            There are two static methods in the <classname>Zend_Search_Lucene</classname> class
+            which allow the developer to configure these settings:
         </para>
+
         <programlisting language="php"><![CDATA[
 $defaultSearchField = Zend_Search_Lucene::getDefaultSearchField();
 ...
@@ -59,45 +69,57 @@ Zend_Search_Lucene::setDefaultSearchField('contents');
 ]]></programlisting>
 
         <para>
-            The <constant>NULL</constant> value indicated that the search is performed across all fields. It's the default setting.
+            The <constant>NULL</constant> value indicated that the search is performed across all
+            fields. It's the default setting.
         </para>
+
         <para>
-            You can search specific fields by typing the field name followed by a colon ":" followed by the term you
-            are looking for.
+            You can search specific fields by typing the field name followed by a colon ":" followed
+            by the term you are looking for.
         </para>
+
         <para>
-            As an example, let's assume a Lucene index contains two fields- title and text- with text as the default field.
-            If you want to find the document entitled "The Right Way" which contains the text "don't go this way",
-            you can enter:
+            As an example, let's assume a Lucene index contains two fields- title and text- with
+            text as the default field. If you want to find the document entitled "The Right Way"
+            which contains the text "don't go this way", you can enter:
         </para>
+
         <programlisting language="querystring"><![CDATA[
 title:"The Right Way" AND text:go
 ]]></programlisting>
+
         <para>
             or
         </para>
+
         <programlisting language="querystring"><![CDATA[
 title:"Do it right" AND go
 ]]></programlisting>
+
         <para>
             Because "text" is the default field, the field indicator is not required.
         </para>
 
         <para>
-            Note: The field is only valid for the term, phrase or subquery that it directly precedes,
-            so the query
+            Note: The field is only valid for the term, phrase or subquery that it directly
+            precedes, so the query
+
             <programlisting language="querystring"><![CDATA[
 title:Do it right
 ]]></programlisting>
-            Will only find "Do" in the title field. It will find "it" and "right" in the default field (if the default field is set)
-            or in all indexed fields (if the default field is set to <constant>NULL</constant>).
+
+            Will only find "Do" in the title field. It will find "it" and "right" in the default
+            field (if the default field is set) or in all indexed fields (if the default field is
+            set to <constant>NULL</constant>).
         </para>
     </sect2>
 
     <sect2 id="zend.search.lucene.query-language.wildcard">
         <title>Wildcards</title>
+
         <para>
-            Lucene supports single and multiple character wildcard searches within single terms (but not within phrase queries).
+            Lucene supports single and multiple character wildcard searches within single terms (but
+            not within phrase queries).
         </para>
 
         <para>
@@ -109,16 +131,19 @@ title:Do it right
         </para>
 
         <para>
-            The single character wildcard search looks for string that match the term with the "?" replaced by any single character.
-            For example, to search for "text" or "test" you can use the search:
+            The single character wildcard search looks for string that match the term with the "?"
+            replaced by any single character. For example, to search for "text" or "test" you can
+            use the search:
+
             <programlisting language="querystring"><![CDATA[
 te?t
 ]]></programlisting>
         </para>
 
         <para>
-            Multiple character wildcard searches look for 0 or more characters when matching strings against terms. For example, to search for test,
-            tests or tester, you can use the search:
+            Multiple character wildcard searches look for 0 or more characters when matching strings
+            against terms. For example, to search for test, tests or tester, you can use the search:
+
             <programlisting language="querystring"><![CDATA[
 test*
 ]]></programlisting>
@@ -126,20 +151,32 @@ test*
 
         <para>
             You can use "?", "*" or both at any place of the term:
+
             <programlisting language="querystring"><![CDATA[
 *wr?t*
 ]]></programlisting>
+
             It searches for "write", "wrote", "written", "rewrite", "rewrote" and so on.
         </para>
 
         <para>
-            Starting from ZF 1.7.7 wildcard patterns need some non-wildcard prefix. Default prefix length is 3 (like in Java Lucene).
-            So "*", "te?t", "*wr?t*" terms will cause an exception<footnote>
-            <para>Please note, that it's not a <code>Zend_Search_Lucene_Search_QueryParserException</code>, but a
-            <code>Zend_Search_Lucene_Exception</code>. It's thrown during query rewrite (execution) operation.</para></footnote>.
+            Starting from ZF 1.7.7 wildcard patterns need some non-wildcard prefix. Default prefix
+            length is 3 (like in Java Lucene). So "*", "te?t", "*wr?t*" terms will cause an
+            exception
+
+            <footnote>
+                <para>
+                    Please note, that it's not a
+                    <code>Zend_Search_Lucene_Search_QueryParserException</code>, but a
+                    <code>Zend_Search_Lucene_Exception</code>. It's thrown during query rewrite
+                    (execution) operation.
+                </para>
+            </footnote>.
         </para>
+
         <para>
-            It can be altered using <code>Zend_Search_Lucene_Search_Query_Wildcard::getMinPrefixLength()</code> and
+            It can be altered using
+            <code>Zend_Search_Lucene_Search_Query_Wildcard::getMinPrefixLength()</code> and
             <code>Zend_Search_Lucene_Search_Query_Wildcard::setMinPrefixLength()</code> methods.
         </para>
     </sect2>
@@ -150,31 +187,47 @@ test*
         <para>
             Lucene supports modifying query terms to provide a wide range of searching options.
         </para>
+
         <para>
-            "~" modifier can be used to specify proximity search for phrases or fuzzy search for individual terms.
+            "~" modifier can be used to specify proximity search for phrases or fuzzy search for
+            individual terms.
         </para>
     </sect2>
 
     <sect2 id="zend.search.lucene.query-language.range">
         <title>Range Searches</title>
+
         <para>
-            Range queries allow the developer or user to match documents whose field(s) values are between the lower and upper bound specified by the range query.
-            Range Queries can be inclusive or exclusive of the upper and lower bounds. Sorting is performed lexicographically.
+            Range queries allow the developer or user to match documents whose field(s) values are
+            between the lower and upper bound specified by the range query. Range Queries can be
+            inclusive or exclusive of the upper and lower bounds. Sorting is performed
+            lexicographically.
+
             <programlisting language="querystring"><![CDATA[
 mod_date:[20020101 TO 20030101]
 ]]></programlisting>
-            This will find documents whose mod_date fields have values between 20020101 and 20030101, inclusive. Note that Range Queries are not
-            reserved for date fields. You could also use range queries with non-date fields:
+
+            This will find documents whose mod_date fields have values between 20020101 and
+            20030101, inclusive. Note that Range Queries are not reserved for date fields. You could
+            also use range queries with non-date fields:
+
             <programlisting language="querystring"><![CDATA[
 title:{Aida TO Carmen}
 ]]></programlisting>
-            This will find all documents whose titles would be sorted between Aida and Carmen, but not including Aida and Carmen.
+
+            This will find all documents whose titles would be sorted between Aida and Carmen, but
+            not including Aida and Carmen.
         </para>
+
         <para>
-            Inclusive range queries are denoted by square brackets. Exclusive range queries are denoted by curly brackets.
+            Inclusive range queries are denoted by square brackets. Exclusive range queries are
+            denoted by curly brackets.
         </para>
+
         <para>
-            If field is not specified then <classname>Zend_Search_Lucene</classname> searches for specified interval through all fields by default.
+            If field is not specified then <classname>Zend_Search_Lucene</classname> searches for
+            specified interval through all fields by default.
+
             <programlisting language="querystring"><![CDATA[
 {Aida TO Carmen}
 ]]></programlisting>
@@ -183,19 +236,20 @@ title:{Aida TO Carmen}
 
     <sect2 id="zend.search.lucene.query-language.fuzzy">
         <title>Fuzzy Searches</title>
+
         <para>
-            <classname>Zend_Search_Lucene</classname> as well as Java Lucene supports fuzzy searches based on the Levenshtein Distance, or Edit Distance algorithm.
-            To do a fuzzy search use the tilde, "~", symbol at the end of a Single word Term. For example to search for a term similar
-            in spelling to "roam" use the fuzzy search:
+            <classname>Zend_Search_Lucene</classname> as well as Java Lucene supports fuzzy searches
+            based on the Levenshtein Distance, or Edit Distance algorithm. To do a fuzzy search use
+            the tilde, "~", symbol at the end of a Single word Term. For example to search for a
+            term similar in spelling to "roam" use the fuzzy search:
 
             <programlisting language="querystring"><![CDATA[
 roam~
 ]]></programlisting>
 
-            This search will find terms like foam and roams.
-
-            Additional (optional) parameter can specify the required similarity. The value is between 0 and 1, with a value closer to 1 only terms
-            with a higher similarity will be matched. For example:
+            This search will find terms like foam and roams. Additional (optional) parameter can
+            specify the required similarity. The value is between 0 and 1, with a value closer to 1
+            only terms with a higher similarity will be matched. For example:
 
             <programlisting language="querystring"><![CDATA[
 roam~0.8
@@ -209,14 +263,17 @@ roam~0.8
         <title>Matched terms limitation</title>
 
         <para>
-            Wildcard, range and fuzzy search queries may match too many terms. It may cause incredible search performance downgrade.
+            Wildcard, range and fuzzy search queries may match too many terms. It may cause
+            incredible search performance downgrade.
         </para>
 
         <para>
-            So Zend_Search_Lucene sets a limit of matching terms per query (subquery). This limit can be retrieved and set using
+            So Zend_Search_Lucene sets a limit of matching terms per query (subquery). This limit
+            can be retrieved and set using
             <code>Zend_Search_Lucene::getTermsPerQueryLimit()</code>/<code>Zend_Search_Lucene::setTermsPerQueryLimit($limit)</code>
             methods.
         </para>
+
         <para>
             Default matched terms per query limit is 1024.
         </para>
@@ -226,9 +283,11 @@ roam~0.8
         <title>Proximity Searches</title>
 
         <para>
-            Lucene supports finding words from a phrase that are within a specified word distance in a string. To do a proximity search
-            use the tilde, "~", symbol at the end of the phrase. For example to search for a "Zend" and
-            "Framework" within 10 words of each other in a document use the search:
+            Lucene supports finding words from a phrase that are within a specified word distance in
+            a string. To do a proximity search use the tilde, "~", symbol at the end of the phrase.
+            For example to search for a "Zend" and "Framework" within 10 words of each other in a
+            document use the search:
+
             <programlisting language="querystring"><![CDATA[
 "Zend Framework"~10
 ]]></programlisting>
@@ -239,27 +298,34 @@ roam~0.8
         <title>Boosting a Term</title>
 
         <para>
-            Java Lucene and <classname>Zend_Search_Lucene</classname> provide the relevance level of matching documents based
-            on the terms found. To boost the relevance of a term use the caret, "^", symbol with a boost factor (a number)
-            at the end of the term you are searching. The higher the boost factor, the more relevant
-            the term will be.
+            Java Lucene and <classname>Zend_Search_Lucene</classname> provide the relevance level of
+            matching documents based on the terms found. To boost the relevance of a term use the
+            caret, "^", symbol with a boost factor (a number) at the end of the term you are
+            searching. The higher the boost factor, the more relevant the term will be.
         </para>
+
         <para>
-            Boosting allows you to control the relevance of a document by boosting individual terms. For example,
-            if you are searching for
+            Boosting allows you to control the relevance of a document by boosting individual terms.
+            For example, if you are searching for
+
             <programlisting language="querystring"><![CDATA[
 PHP framework
 ]]></programlisting>
-            and you want the term "PHP" to be more relevant boost it using the ^ symbol along with the
-            boost factor next to the term. You would type:
+
+            and you want the term "PHP" to be more relevant boost it using the ^ symbol along with
+            the boost factor next to the term. You would type:
+
             <programlisting language="querystring"><![CDATA[
 PHP^4 framework
 ]]></programlisting>
-            This will make documents with the term PHP appear more relevant. You can also boost phrase
-            terms and subqueries as in the example:
+
+            This will make documents with the term PHP appear more relevant. You can also boost
+            phrase terms and subqueries as in the example:
+
             <programlisting language="querystring"><![CDATA[
 "PHP framework"^4 "Zend Framework"
 ]]></programlisting>
+
             By default, the boost factor is 1. Although the boost factor must be positive,
             it may be less than 1 (e.g. 0.2).
         </para>
@@ -271,26 +337,34 @@ PHP^4 framework
         <para>
             Boolean operators allow terms to be combined through logic operators.
             Lucene supports AND, "+", OR, NOT and "-" as Boolean operators.
-            Java Lucene requires boolean operators to be ALL CAPS. <classname>Zend_Search_Lucene</classname> does not.
+            Java Lucene requires boolean operators to be ALL CAPS.
+            <classname>Zend_Search_Lucene</classname> does not.
         </para>
 
         <para>
-            AND, OR, and NOT operators and "+", "-" defines two different styles to construct boolean queries.
-            Unlike Java Lucene, <classname>Zend_Search_Lucene</classname> doesn't allow these two styles to be mixed.
+            AND, OR, and NOT operators and "+", "-" defines two different styles to construct
+            boolean queries. Unlike Java Lucene, <classname>Zend_Search_Lucene</classname> doesn't
+            allow these two styles to be mixed.
         </para>
+
         <para>
-            If the AND/OR/NOT style is used, then an AND or OR operator must be present between all query terms.
-            Each term may also be preceded by NOT operator. The AND operator has higher precedence than the OR operator.
-            This differs from Java Lucene behavior.
+            If the AND/OR/NOT style is used, then an AND or OR operator must be present between all
+            query terms. Each term may also be preceded by NOT operator. The AND operator has higher
+            precedence than the OR operator. This differs from Java Lucene behavior.
         </para>
 
         <sect3 id="zend.search.lucene.query-language.boolean.and">
             <title>AND</title>
+
             <para>
-                The AND operator means that all terms in the "AND group" must match some part of the searched field(s).
+                The AND operator means that all terms in the "AND group" must match some part of the
+                searched field(s).
             </para>
+
             <para>
-                To search for documents that contain "PHP framework" and "Zend Framework" use the query:
+                To search for documents that contain "PHP framework" and "Zend Framework" use the
+                query:
+
                 <programlisting language="querystring"><![CDATA[
 "PHP framework" AND "Zend Framework"
 ]]></programlisting>
@@ -299,11 +373,15 @@ PHP^4 framework
 
         <sect3 id="zend.search.lucene.query-language.boolean.or">
             <title>OR</title>
+
             <para>
                 The OR operator divides the query into several optional terms.
             </para>
+
             <para>
-                To search for documents that contain "PHP framework" or "Zend Framework" use the query:
+                To search for documents that contain "PHP framework" or "Zend Framework" use the
+                query:
+
                 <programlisting language="querystring"><![CDATA[
 "PHP framework" OR "Zend Framework"
 ]]></programlisting>
@@ -312,12 +390,17 @@ PHP^4 framework
 
         <sect3 id="zend.search.lucene.query-language.boolean.not">
             <title>NOT</title>
+
             <para>
-                The NOT operator excludes documents that contain the term after NOT. But an "AND group" which contains
-                only terms with the NOT operator gives an empty result set instead of a full set of indexed documents.
+                The NOT operator excludes documents that contain the term after NOT. But an "AND
+                group" which contains only terms with the NOT operator gives an empty result set
+                instead of a full set of indexed documents.
             </para>
+
             <para>
-                To search for documents that contain "PHP framework" but not "Zend Framework" use the query:
+                To search for documents that contain "PHP framework" but not "Zend Framework" use
+                the query:
+
                 <programlisting language="querystring"><![CDATA[
 "PHP framework" AND NOT "Zend Framework"
 ]]></programlisting>
@@ -326,6 +409,7 @@ PHP^4 framework
 
         <sect3 id="zend.search.lucene.query-language.boolean.other-form">
             <title>&amp;&amp;, ||, and ! operators</title>
+
             <para>
                 &amp;&amp;, ||, and ! may be used instead of AND, OR, and NOT notation.
             </para>
@@ -333,11 +417,16 @@ PHP^4 framework
 
         <sect3 id="zend.search.lucene.query-language.boolean.plus">
             <title>+</title>
+
             <para>
-                The "+" or required operator stipulates that the term after the "+" symbol must match the document.
+                The "+" or required operator stipulates that the term after the "+" symbol must
+                match the document.
             </para>
+
             <para>
-                To search for documents that must contain "Zend" and may contain "Framework" use the query:
+                To search for documents that must contain "Zend" and may contain "Framework" use the
+                query:
+
                 <programlisting language="querystring"><![CDATA[
 +Zend Framework
 ]]></programlisting>
@@ -346,11 +435,16 @@ PHP^4 framework
 
         <sect3 id="zend.search.lucene.query-language.boolean.minus">
             <title>-</title>
+
             <para>
-                The "-" or prohibit operator excludes documents that match the term after the "-" symbol.
+                The "-" or prohibit operator excludes documents that match the term after the "-"
+                symbol.
             </para>
+
             <para>
-                To search for documents that contain "PHP framework" but not "Zend Framework" use the query:
+                To search for documents that contain "PHP framework" but not "Zend Framework" use
+                the query:
+
                 <programlisting language="querystring"><![CDATA[
 "PHP framework" -"Zend Framework"
 ]]></programlisting>
@@ -359,18 +453,25 @@ PHP^4 framework
 
         <sect3 id="zend.search.lucene.query-language.boolean.no-operator">
             <title>No Operator</title>
+
             <para>
-                If no operator is used, then the search behavior is defined by the "default boolean operator".
+                If no operator is used, then the search behavior is defined by the "default boolean
+                operator".
             </para>
+
             <para>
                 This is set to <code>OR</code> by default.
             </para>
+
             <para>
-                That implies each term is optional by default. It may or may not be present within document, but documents with this term
-                will receive a higher score.
+                That implies each term is optional by default. It may or may not be present within
+                document, but documents with this term will receive a higher score.
             </para>
+
             <para>
-                To search for documents that requires "PHP framework" and may contain "Zend Framework" use the query:
+                To search for documents that requires "PHP framework" and may contain "Zend
+                Framework" use the query:
+
                 <programlisting language="querystring"><![CDATA[
 +"PHP framework" "Zend Framework"
 ]]></programlisting>
@@ -378,9 +479,12 @@ PHP^4 framework
 
             <para>
                 The default boolean operator may be set or retrieved with the
-                <classname>Zend_Search_Lucene_Search_QueryParser::setDefaultOperator($operator)</classname> and
-                <classname>Zend_Search_Lucene_Search_QueryParser::getDefaultOperator()</classname> methods, respectively.
+                <classname>Zend_Search_Lucene_Search_QueryParser::setDefaultOperator($operator)</classname>
+                and
+                <classname>Zend_Search_Lucene_Search_QueryParser::getDefaultOperator()</classname>
+                methods, respectively.
             </para>
+
             <para>
                 These methods operate with the
                 <classname>Zend_Search_Lucene_Search_QueryParser::B_AND</classname> and
@@ -393,8 +497,10 @@ PHP^4 framework
         <title>Grouping</title>
 
         <para>
-            Java Lucene and <classname>Zend_Search_Lucene</classname> support using parentheses to group clauses to form sub queries. This can be
-            useful if you want to control the precedence of boolean logic operators for a query or mix different boolean query styles:
+            Java Lucene and <classname>Zend_Search_Lucene</classname> support using parentheses to
+            group clauses to form sub queries. This can be useful if you want to control the
+            precedence of boolean logic operators for a query or mix different boolean query styles:
+
             <programlisting language="querystring"><![CDATA[
 +(framework OR library) +php
 ]]></programlisting>
@@ -408,8 +514,11 @@ PHP^4 framework
         <para>
             Lucene also supports using parentheses to group multiple clauses to a single field.
         </para>
+
         <para>
-            To search for a title that contains both the word "return" and the phrase "pink panther" use the query:
+            To search for a title that contains both the word "return" and the phrase "pink panther"
+            use the query:
+
             <programlisting language="querystring"><![CDATA[
 title:(+return +"pink panther")
 ]]></programlisting>
@@ -420,21 +529,25 @@ title:(+return +"pink panther")
         <title>Escaping Special Characters</title>
 
         <para>
-            Lucene supports escaping special characters that are used in query syntax. The current list of special
-            characters is:
+            Lucene supports escaping special characters that are used in query syntax. The current
+            list of special characters is:
         </para>
+
         <para>
             + - &amp;&amp; || ! ( ) { } [ ] ^ " ~ * ? : \
         </para>
+
         <para>
             + and - inside single terms are automatically treated as common characters.
         </para>
+
         <para>
-            For other instances of these characters use the \ before each special character you'd like to escape. For example to search for (1+1):2 use the query:
+            For other instances of these characters use the \ before each special character you'd
+            like to escape. For example to search for (1+1):2 use the query:
+
             <programlisting language="querystring"><![CDATA[
 \(1\+1\)\:2
 ]]></programlisting>
         </para>
     </sect2>
-
 </sect1>

File diff suppressed because it is too large
+ 353 - 152
documentation/manual/en/module_specs/Zend_Service_Amazon.xml


+ 151 - 96
documentation/manual/en/module_specs/Zend_Service_Amazon_Ec2-Image.xml

@@ -2,6 +2,7 @@
 <!-- Reviewed: no -->
 <sect1 id="zend.service.amazon.ec2.images">
     <title>Zend_Service_Amazon_Ec2: Amazon Machine Images (AMI)</title>
+
     <para>
         Amazon Machine Images (AMIs) are preconfigured with an ever-growing list
         of operating systems.
@@ -12,13 +13,15 @@
 
         <example id="zend.service.amazon.ec2.images.register">
             <title>Register an AMI with EC2</title>
+
             <para>
-                <code>register</code> Each <acronym>AMI</acronym> is associated with an unique ID which
-                is provided by the Amazon EC2 service through the RegisterImage
+                <code>register</code> Each <acronym>AMI</acronym> is associated with an unique ID
+                which is provided by the Amazon EC2 service through the RegisterImage
                 operation. During registration, Amazon EC2 retrieves the specified
                 image manifest from Amazon S3 and verifies that the image is owned by
                 the user registering the image.
             </para>
+
             <para>
                 <code>register</code> returns the imageId for the registered Image.
             </para>
@@ -31,9 +34,10 @@ $ip = $ec2_img->register('imageLocation');
 
         <example id="zend.service.amazon.ec2.images.deregister">
             <title>Deregister an AMI with EC2</title>
+
             <para>
-                <code>deregister</code>, Deregisters an <acronym>AMI</acronym>. Once deregistered, instances
-                of the <acronym>AMI</acronym> can no longer be launched.
+                <code>deregister</code>, Deregisters an <acronym>AMI</acronym>. Once deregistered,
+                instances of the <acronym>AMI</acronym> can no longer be launched.
             </para>
 
             <para>
@@ -49,73 +53,103 @@ $ip = $ec2_img->deregister('imageId');
 
         <example id="zend.service.amazon.ec2.images.describe">
             <title>Describe an AMI</title>
+
             <para>
-                <code>describe</code> Returns information about <acronym>AMI</acronym>s, AKIs, and ARIs
-                available to the user. Information returned includes image type,
+                <code>describe</code> Returns information about <acronym>AMI</acronym>s, AKIs, and
+                ARIs available to the user. Information returned includes image type,
                 product codes, architecture, and kernel and <acronym>RAM</acronym> disk IDs. Images
                 available to the user include public images available for any user
                 to launch, private images owned by the user making the request,
                 and private images owned by other users for which the user has
                 explicit launch permissions.
             </para>
+
+            <para>
+                <table id="zend.service.amazon.ec2.images.describe-table">
+                    <title>Launch permissions fall into three categories</title>
+
+                    <tgroup cols="2">
+                        <thead>
+                            <row>
+                                <entry>Name</entry>
+                                <entry>Description</entry>
+                            </row>
+                        </thead>
+
+                        <tbody>
+                            <row>
+                                <entry><code>public</code></entry>
+
+                                <entry>
+                                    <para>
+                                        The owner of the <acronym>AMI</acronym> granted launch
+                                        permissions for the <acronym>AMI</acronym> to the all group.
+                                        All users have launch permissions for these
+                                        <constant>AMIs</constant>.
+                                    </para>
+                                </entry>
+                            </row>
+
+                            <row>
+                                <entry><code>explicit</code></entry>
+
+                                <entry>
+                                    <para>
+                                        The owner of the <acronym>AMI</acronym> granted launch
+                                        permissions to a specific user.
+                                    </para>
+                                </entry>
+                            </row>
+
+                            <row>
+                                <entry><code>implicit</code></entry>
+
+                                <entry>
+                                    <para>
+                                        A user has implicit launch permissions for all
+                                        <constant>AMIs</constant> he or she owns.
+                                    </para>
+                                </entry>
+                            </row>
+                        </tbody>
+                    </tgroup>
+                </table>
+            </para>
+
+            <para>
+                The list of <acronym>AMI</acronym>s returned can be modified by specifying
+                <acronym>AMI</acronym> IDs, <acronym>AMI</acronym> owners, or users with launch
+                permissions. If no options are specified, Amazon EC2 returns all
+                <acronym>AMI</acronym>s for which the user has launch permissions.
+            </para>
+
+            <para>
+                If you specify one or more <acronym>AMI</acronym> IDs, only <acronym>AMI</acronym>s
+                that have the specified IDs are returned. If you specify an invalid
+                <acronym>AMI</acronym> ID, a fault is returned. If you specify an
+                <acronym>AMI</acronym> ID for which you do not have access, it will not be included
+                in the returned results.
+            </para>
+
             <para>
-            <table id="zend.service.amazon.ec2.images.describe-table">
-                <title>Launch permissions fall into three categories</title>
-                <tgroup cols="2">
-                    <thead>
-                        <row>
-                            <entry>Name</entry>
-                            <entry>Description</entry>
-                        </row>
-                    </thead>
-                    <tbody>
-                        <row>
-                            <entry><code>public</code></entry>
-                            <entry><para>
-                                The owner of the <acronym>AMI</acronym> granted launch permissions for the <acronym>AMI</acronym>
-                                to the all group. All users have launch permissions for these <constant>AMIs</constant>.
-                            </para></entry>
-                        </row>
-                        <row>
-                            <entry><code>explicit</code></entry>
-                            <entry><para>
-                                The owner of the <acronym>AMI</acronym> granted launch permissions to a specific user.
-                            </para></entry>
-                        </row>
-                        <row>
-                            <entry><code>implicit</code></entry>
-                            <entry><para>
-                                A user has implicit launch permissions for all <constant>AMIs</constant> he or she owns.
-                            </para></entry>
-                        </row>
-                    </tbody>
-                </tgroup>
-            </table>
-            </para>
-            <para>
-                The list of <acronym>AMI</acronym>s returned can be modified by specifying <acronym>AMI</acronym> IDs, <acronym>AMI</acronym> owners,
-                or users with launch permissions. If no options are specified, Amazon EC2 returns
-                all <acronym>AMI</acronym>s for which the user has launch permissions.
-            </para>
-            <para>
-                If you specify one or more <acronym>AMI</acronym> IDs, only <acronym>AMI</acronym>s that have the specified IDs are returned.
-                If you specify an invalid <acronym>AMI</acronym> ID, a fault is returned. If you specify an <acronym>AMI</acronym> ID for which
-                you do not have access, it will not be included in the returned results.
-            </para>
-            <para>
-                If you specify one or more <acronym>AMI</acronym> owners, only <acronym>AMI</acronym>s from the specified owners and for
-                which you have access are returned. The results can include the account IDs of the
-                specified owners, amazon for <acronym>AMI</acronym>s owned by Amazon or self for <acronym>AMI</acronym>s that you own.
+                If you specify one or more <acronym>AMI</acronym> owners, only
+                <acronym>AMI</acronym>s from the specified owners and for which you have access are
+                returned. The results can include the account IDs of the specified owners, amazon
+                for <acronym>AMI</acronym>s owned by Amazon or self for <acronym>AMI</acronym>s that
+                you own.
             </para>
+
             <para>
                 If you specify a list of executable users, only users that have launch permissions
-                for the <acronym>AMI</acronym>s are returned. You can specify account IDs (if you own the <acronym>AMI</acronym>(s)), self
-                for <acronym>AMI</acronym>s for which you own or have explicit permissions, or all for public <acronym>AMI</acronym>s.
+                for the <acronym>AMI</acronym>s are returned. You can specify account IDs (if you
+                own the <acronym>AMI</acronym>(s)), self for <acronym>AMI</acronym>s for which you
+                own or have explicit permissions, or all for public <acronym>AMI</acronym>s.
             </para>
+
             <para>
-                <code>describe</code> returns an array for all the images that match the critera that was
-                passed in. The array contains the imageId, imageLocation, imageState, imageOwnerId, isPublic,
-                architecture, imageType, kernelId, ramdiskId and platform.
+                <code>describe</code> returns an array for all the images that match the critera
+                that was passed in. The array contains the imageId, imageLocation, imageState,
+                imageOwnerId, isPublic, architecture, imageType, kernelId, ramdiskId and platform.
             </para>
 
             <programlisting language="php"><![CDATA[
@@ -130,39 +164,57 @@ $ip = $ec2_img->describe();
 
         <example id="zend.service.amazon.ec2.images.attribute.modify">
             <title>Modify Image Attributes</title>
+
             <para>Modifies an attribute of an <acronym>AMI</acronym></para>
+
             <para>
-            <table id="zend.service.amazon.ec2.images.attribute.modify-table">
-                <title>Valid Attributes</title>
-                <tgroup cols="2">
-                    <thead>
-                        <row>
-                            <entry>Name</entry>
-                            <entry>Description</entry>
-                        </row>
-                    </thead>
-                    <tbody>
-                        <row>
-                            <entry><code>launchPermission</code></entry>
-                            <entry><para>
-                                Controls who has permission to launch the <acronym>AMI</acronym>. Launch permissions
-                                can be granted to specific users by adding userIds.
-                            </para><para>To make the <acronym>AMI</acronym> public, add the all group.</para></entry>
-                        </row>
-                        <row>
-                            <entry><code>productCodes</code></entry>
-                            <entry><para>
-                                Associates a product code with <constant>AMIs</constant>. This allows developers to
-                                charge users for using <constant>AMIs</constant>. The user must be signed up for the
-                                product before they can launch the <acronym>AMI</acronym>.
-                                <emphasis>This is a write once attribute;
-                                after it is set, it cannot be changed or
-                                removed.</emphasis>
-                            </para></entry>
-                        </row>
-                    </tbody>
-                </tgroup>
-            </table>
+                <table id="zend.service.amazon.ec2.images.attribute.modify-table">
+                    <title>Valid Attributes</title>
+
+                    <tgroup cols="2">
+                        <thead>
+                            <row>
+                                <entry>Name</entry>
+                                <entry>Description</entry>
+                            </row>
+                        </thead>
+
+                        <tbody>
+                            <row>
+                                <entry><code>launchPermission</code></entry>
+
+                                <entry>
+                                    <para>
+                                        Controls who has permission to launch the
+                                        <acronym>AMI</acronym>. Launch permissions can be granted to
+                                        specific users by adding userIds.
+                                    </para>
+
+                                    <para>
+                                        To make the <acronym>AMI</acronym> public, add the all
+                                        group.
+                                    </para>
+                                </entry>
+                            </row>
+
+                            <row>
+                                <entry><code>productCodes</code></entry>
+
+                                <entry>
+                                    <para>
+                                        Associates a product code with <constant>AMIs</constant>.
+                                        This allows developers to charge users for using
+                                        <constant>AMIs</constant>. The user must be signed up for
+                                        the product before they can launch the
+                                        <acronym>AMI</acronym>. <emphasis>This is a write once
+                                            attribute; after it is set, it cannot be changed or
+                                            removed.</emphasis>
+                                    </para>
+                                </entry>
+                            </row>
+                        </tbody>
+                    </tgroup>
+                </table>
             </para>
 
             <para>
@@ -187,15 +239,16 @@ $return = $ec2_img->modifyAttribute('imageId',
                                     null,
                                     'productCode');
 ]]></programlisting>
-
         </example>
 
         <example id="zend.service.amazon.ec2.images.attribute.reset">
             <title>Reset an AMI Attribute</title>
             <para>
-                <code>resetAttribute</code> will reset the attribute of an <acronym>AMI</acronym> to its default value.
-                <emphasis>The productCodes attribute cannot be reset.</emphasis>
+                <code>resetAttribute</code> will reset the attribute of an <acronym>AMI</acronym> to
+                its default value. <emphasis>The productCodes attribute cannot be reset.</emphasis>
             </para>
+
             <programlisting language="php"><![CDATA[
 $ec2_img = new Zend_Service_Amazon_Ec2_Image('aws_key','aws_secret_key');
 $return = $ec2_img->resetAttribute('imageId', 'launchPermission');
@@ -204,20 +257,22 @@ $return = $ec2_img->resetAttribute('imageId', 'launchPermission');
 
         <example id="zend.service.amazon.ec2.images.attribute.describe">
             <title>Describe AMI Attribute</title>
+
             <para>
-                <code>describeAttribute</code> returns information about an attribute of an <acronym>AMI</acronym>.
-                Only one attribute can be specified per call. Currently only launchPermission and
-                productCodes are supported.
+                <code>describeAttribute</code> returns information about an attribute of an
+                <acronym>AMI</acronym>. Only one attribute can be specified per call. Currently only
+                launchPermission and productCodes are supported.
             </para>
+
             <para>
                 <code>describeAttribute</code> returns an array with the value of the attribute
                 that was requested.
             </para>
+
             <programlisting language="php"><![CDATA[
 $ec2_img = new Zend_Service_Amazon_Ec2_Image('aws_key','aws_secret_key');
 $return = $ec2_img->describeAttribute('imageId', 'launchPermission');
 ]]></programlisting>
         </example>
-
     </sect2>
 </sect1>

+ 253 - 157
documentation/manual/en/module_specs/Zend_Service_Amazon_S3.xml

@@ -7,12 +7,12 @@
         <title>Introduction</title>
 
         <para>
-    Amazon S3 provides a simple web services interface that can be used to
-    store and retrieve any amount of data, at any time, from anywhere on
-    the web. It gives any developer access to the same highly scalable,
-    reliable, fast, inexpensive data storage infrastructure that Amazon
-    uses to run its own global network of web sites. The service aims to
-    maximize benefits of scale and to pass those benefits on to developers.
+            Amazon S3 provides a simple web services interface that can be used to
+            store and retrieve any amount of data, at any time, from anywhere on
+            the web. It gives any developer access to the same highly scalable,
+            reliable, fast, inexpensive data storage infrastructure that Amazon
+            uses to run its own global network of web sites. The service aims to
+            maximize benefits of scale and to pass those benefits on to developers.
         </para>
     </sect2>
 
@@ -20,8 +20,8 @@
         <title>Registering with Amazon S3</title>
 
         <para>
-            Before you can get started with <classname>Zend_Service_Amazon_S3</classname>, you must first
-            register for an account. Please see the
+            Before you can get started with <classname>Zend_Service_Amazon_S3</classname>, you must
+            first register for an account. Please see the
             <ulink url="http://aws.amazon.com/s3/faqs/">S3 FAQ</ulink>
             page on the Amazon website for more information.
         </para>
@@ -36,13 +36,13 @@
         <title>API Documentation</title>
 
         <para>
-            The <classname>Zend_Service_Amazon_S3</classname> class provides the <acronym>PHP</acronym> wrapper to the
-            Amazon S3 REST interface. Please consult the
-            <ulink url="http://developer.amazonwebservices.com/connect/kbcategory.jspa?categoryID=48">Amazon S3 documentation</ulink>
-            for detailed description of the service. You will need to be familiar with basic concepts
-            in order to use this service.
+            The <classname>Zend_Service_Amazon_S3</classname> class provides the
+            <acronym>PHP</acronym> wrapper to the Amazon S3 REST interface. Please consult the
+            <ulink
+                url="http://developer.amazonwebservices.com/connect/kbcategory.jspa?categoryID=48">Amazon
+                S3 documentation</ulink> for detailed description of the service. You will need to
+            be familiar with basic concepts in order to use this service.
         </para>
-
     </sect2>
 
     <sect2 id="zend.service.amazon.s3.features">
@@ -61,9 +61,9 @@
 
                 <listitem>
                     <para>
-                        A proxy object that is more convenient to use than an <acronym>HTTP</acronym> client
-                        alone, mostly removing the need to manually construct <acronym>HTTP</acronym> POST
-                        requests to access the REST service.
+                        A proxy object that is more convenient to use than an
+                        <acronym>HTTP</acronym> client alone, mostly removing the need to manually
+                        construct <acronym>HTTP</acronym> POST requests to access the REST service.
                     </para>
                 </listitem>
 
@@ -101,6 +101,7 @@
 
         <example id="zend.service.amazon.s3.storing-your-first.example">
             <title>Zend_Service_Amazon_S3 Usage Example</title>
+
              <programlisting language="php"><![CDATA[
 require_once 'Zend/Service/Amazon/S3.php';
 
@@ -117,7 +118,6 @@ echo $s3->getObject("my-own-bucket/myobject");
         <para>
             Since <classname>Zend_Service_Amazon_S3</classname> service requires authentication,
             you should pass your credentials (AWS key and secret key) to the constructor.
-
             If you only use one account, you can set default credentials for the service:
         </para>
 
@@ -133,15 +133,16 @@ $s3 = new Zend_Service_Amazon_S3();
         <title>Bucket operations</title>
 
         <para>
-        All objects in S3 system are stored in buckets. Bucket has to be created
-        before any storage operation. Bucket name is unique in the system, so
-        you can not have bucket named the same as someone else's bucket.
+            All objects in S3 system are stored in buckets. Bucket has to be created
+            before any storage operation. Bucket name is unique in the system, so
+            you can not have bucket named the same as someone else's bucket.
         </para>
 
         <para>
-        Bucket name can contain lowercase letters, digits, periods (.), underscores (_), and dashes (-).
-        No other symbols allowed. Bucket name should start with letter or digit, and be 3 to 255 characters long.
-        Names looking like an IP address (e.g. "192.168.16.255") are not allowed.
+            Bucket name can contain lowercase letters, digits, periods (.), underscores (_), and
+            dashes (-). No other symbols allowed. Bucket name should start with letter or digit, and
+            be 3 to 255 characters long. Names looking like an IP address (e.g. "192.168.16.255")
+            are not allowed.
         </para>
 
         <itemizedlist>
@@ -150,19 +151,24 @@ $s3 = new Zend_Service_Amazon_S3();
                     <methodname>createBucket()</methodname> creates a new bucket.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
-                    <methodname>cleanBucket()</methodname> removes all objects that are contained in a bucket.
+                    <methodname>cleanBucket()</methodname> removes all objects that are contained in
+                    a bucket.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
-                    <methodname>removeBucket()</methodname> removes the bucket from the system. The bucket should be
-                    empty to be removed.
+                    <methodname>removeBucket()</methodname> removes the bucket from the system. The
+                    bucket should be empty to be removed.
                 </para>
-        <example id="zend.service.amazon.s3.buckets.remove.example">
-            <title>Zend_Service_Amazon_S3 Bucket Removal Example</title>
-             <programlisting language="php"><![CDATA[
+
+                <example id="zend.service.amazon.s3.buckets.remove.example">
+                    <title>Zend_Service_Amazon_S3 Bucket Removal Example</title>
+
+                    <programlisting language="php"><![CDATA[
 require_once 'Zend/Service/Amazon/S3.php';
 
 $s3 = new Zend_Service_Amazon_S3($my_aws_key, $my_aws_secret_key);
@@ -170,16 +176,19 @@ $s3 = new Zend_Service_Amazon_S3($my_aws_key, $my_aws_secret_key);
 $s3->cleanBucket("my-own-bucket");
 $s3->removeBucket("my-own-bucket");
 ]]></programlisting>
-        </example>
+                </example>
             </listitem>
+
             <listitem>
                 <para>
-                    <methodname>getBuckets()</methodname> returns the list of the names of all buckets belonging to the
-                    user.
+                    <methodname>getBuckets()</methodname> returns the list of the names of all
+                    buckets belonging to the user.
                 </para>
-        <example id="zend.service.amazon.s3.buckets.list.example">
-            <title>Zend_Service_Amazon_S3 Bucket Listing Example</title>
-             <programlisting language="php"><![CDATA[
+
+                <example id="zend.service.amazon.s3.buckets.list.example">
+                    <title>Zend_Service_Amazon_S3 Bucket Listing Example</title>
+
+                    <programlisting language="php"><![CDATA[
 require_once 'Zend/Service/Amazon/S3.php';
 
 $s3 = new Zend_Service_Amazon_S3($my_aws_key, $my_aws_secret_key);
@@ -189,13 +198,13 @@ foreach($list as $bucket) {
   echo "I have bucket $bucket\n";
 }
 ]]></programlisting>
-        </example>
+                </example>
             </listitem>
 
             <listitem>
                 <para>
-                    <methodname>isBucketAvailable()</methodname> check if the bucket exists and returns
-                    <constant>TRUE</constant> if it does.
+                    <methodname>isBucketAvailable()</methodname> check if the bucket exists and
+                    returns <constant>TRUE</constant> if it does.
                 </para>
             </listitem>
         </itemizedlist>
@@ -203,81 +212,119 @@ foreach($list as $bucket) {
 
     <sect2 id="zend.service.amazon.s3.objects">
         <title>Object operations</title>
+
         <para>
-        The object is the basic storage unit in S3. Object stores unstructured data, which can be
-        any size up to 4 gigabytes. There's no limit on how many objects can be stored on the system.
+            The object is the basic storage unit in S3. Object stores unstructured data, which can
+            be any size up to 4 gigabytes. There's no limit on how many objects can be stored on the
+            system.
         </para>
 
         <para>
-        The object are contained in buckets. Object is identified by name, which can be any utf-8 string.
-        It is common to use hierarchical names (such as <code>Pictures/Myself/CodingInPHP.jpg</code>) to
-        organise object names. Object name is prefixed with bucket name when using object functions, so for
-        object "mydata" in bucket "my-own-bucket" the name would be <code>my-own-bucket/mydata</code>.
+            The object are contained in buckets. Object is identified by name, which can be any
+            utf-8 string. It is common to use hierarchical names (such as
+            <code>Pictures/Myself/CodingInPHP.jpg</code>) to organise object names. Object name is
+            prefixed with bucket name when using object functions, so for object "mydata" in bucket
+            "my-own-bucket" the name would be <code>my-own-bucket/mydata</code>.
         </para>
 
         <para>
-        Objects can be replaced (by rewriting new data with the same key) or deleted, but not modified, appended, etc.
-        Object is always stored whole.
+            Objects can be replaced (by rewriting new data with the same key) or deleted, but not
+            modified, appended, etc. Object is always stored whole.
         </para>
 
         <para>
-        By default, all objects are private and can be accessed only by their owner. However, it is possible
-        to specify object with public access, in which case it will be available through the <acronym>URL</acronym>:
-        <code>http://s3.amazonaws.com/[bucket-name]/[object-name]</code>.
+            By default, all objects are private and can be accessed only by their owner. However, it
+            is possible to specify object with public access, in which case it will be available
+            through the <acronym>URL</acronym>:
+            <code>http://s3.amazonaws.com/[bucket-name]/[object-name]</code>.
         </para>
 
         <itemizedlist>
             <listitem>
                 <para>
-                    <methodname>putObject($object, $data, $meta)</methodname> created an object with name <varname>$object</varname>
-                    (should contain the bucket name as prefix!) having <varname>$data</varname> as its content.
+                    <methodname>putObject($object, $data, $meta)</methodname> created an object with
+                    name <varname>$object</varname> (should contain the bucket name as prefix!)
+                    having <varname>$data</varname> as its content.
                 </para>
-                <para>Optional <varname>$meta</varname> parameter is the array of metadata, which currently supports the
-                following parameters as keys:
+
+                <para>
+                Optional <varname>$meta</varname> parameter is the array of metadata, which
+                currently supports the following parameters as keys:
                 </para>
+
                 <variablelist>
-                <varlistentry><term><constant>S3_CONTENT_TYPE_HEADER</constant></term>
-                    <listitem>
-                    <para>
-                    <acronym>MIME</acronym> content type of the data. If not specified, the type will be guessed according
-                    to the file extension of the object name.
-                    </para>
-                    </listitem>
-                </varlistentry>
-                <varlistentry><term><constant>S3_ACL_HEADER</constant></term>
-                    <listitem>
-                    <para>
-                    The access to the item. Following access constants can be used:
-                        <variablelist>
-                        <varlistentry><term><constant>S3_ACL_PRIVATE</constant></term>
-                            <listitem>
-                            <para>Only the owner has access to the item.</para>
-                            </listitem>
-                        </varlistentry>
-                        <varlistentry><term><constant>S3_ACL_PUBLIC_READ</constant></term>
-                            <listitem>
-                            <para>Anybody can read the object, but only owner can write.
-                            This is setting may be used to store publicly accessible content.</para>
-                            </listitem>
-                        </varlistentry>
-                        <varlistentry><term><constant>S3_ACL_PUBLIC_WRITE</constant></term>
-                            <listitem>
-                            <para>Anybody can read or write the object. This policy is rarely useful.</para>
-                            </listitem>
-                        </varlistentry>
-                        <varlistentry><term><constant>S3_ACL_AUTH_READ</constant></term>
-                            <listitem>
-                            <para>Only the owner has write access to the item, and other authenticated S3
-                            users have read access. This is useful for sharing data between S3 accounts without
-                            exposing them to the public.</para>
-                            </listitem>
-                        </varlistentry>
-                        </variablelist>
-                    By default, all the items are private.
-                    </para>
-        <example id="zend.service.amazon.s3.objects.public.example">
-            <title>Zend_Service_Amazon_S3 Public Object Example</title>
-             <programlisting language="php"><![CDATA[
+                    <varlistentry>
+                        <term><constant>S3_CONTENT_TYPE_HEADER</constant></term>
+
+                        <listitem>
+                            <para>
+                                <acronym>MIME</acronym> content type of the data. If not specified,
+                                the type will be guessed according to the file extension of the
+                                object name.
+                            </para>
+                        </listitem>
+                    </varlistentry>
+
+                    <varlistentry>
+                        <term><constant>S3_ACL_HEADER</constant></term>
+
+                        <listitem>
+                            <para>
+                                The access to the item. Following access constants can be used:
+
+                                <variablelist>
+                                    <varlistentry>
+                                        <term><constant>S3_ACL_PRIVATE</constant></term>
+
+                                        <listitem>
+                                            <para>Only the owner has access to the item.</para>
+                                        </listitem>
+                                    </varlistentry>
+
+                                    <varlistentry>
+                                        <term><constant>S3_ACL_PUBLIC_READ</constant></term>
+
+                                        <listitem>
+                                            <para>
+                                                Anybody can read the object, but only owner can
+                                                write. This is setting may be used to store publicly
+                                                accessible content.
+                                            </para>
+                                        </listitem>
+                                    </varlistentry>
+
+                                    <varlistentry>
+                                        <term><constant>S3_ACL_PUBLIC_WRITE</constant></term>
+
+                                        <listitem>
+                                            <para>
+                                                Anybody can read or write the object. This policy is
+                                                rarely useful.
+                                            </para>
+                                        </listitem>
+                                    </varlistentry>
+
+                                    <varlistentry>
+                                        <term><constant>S3_ACL_AUTH_READ</constant></term>
+
+                                        <listitem>
+                                            <para>
+                                                Only the owner has write access to the item, and
+                                                other authenticated S3 users have read access. This
+                                                is useful for sharing data between S3 accounts
+                                                without exposing them to the public.
+                                            </para>
+                                        </listitem>
+                                    </varlistentry>
+                                </variablelist>
+
+                                By default, all the items are private.
+                            </para>
+
+                            <example id="zend.service.amazon.s3.objects.public.example">
+                                <title>Zend_Service_Amazon_S3 Public Object Example</title>
+
+                                <programlisting language="php"><![CDATA[
 require_once 'Zend/Service/Amazon/S3.php';
 
 $s3 = new Zend_Service_Amazon_S3($my_aws_key, $my_aws_secret_key);
@@ -291,58 +338,85 @@ $s3->putFile("me.png", "my-own-bucket/Pictures/Me.png",
           Zend_Service_Amazon_S3::S3_ACL_PUBLIC_READ));
 echo "Go to http://s3.amazonaws.com/my-own-bucket/Pictures/Me.png to see me!\n";
 ]]></programlisting>
-        </example>
-                    </listitem>
-                </varlistentry>
-                   </variablelist>
+                            </example>
+                        </listitem>
+                    </varlistentry>
+                </variablelist>
             </listitem>
+
             <listitem>
                 <para>
-                    <methodname>getObject($object)</methodname> retrieves object data from the storage by name.
+                    <methodname>getObject($object)</methodname> retrieves object data from the
+                    storage by name.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
-                    <methodname>removeObject($object)</methodname> removes the object from the storage.
+                    <methodname>removeObject($object)</methodname> removes the object from the
+                    storage.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
-                    <methodname>getInfo($object)</methodname> retrieves the metadata information about the object. The
-                    function will return array with metadata information. Some of the useful keys are:
-                        <variablelist>
-                        <varlistentry><term><code>type</code></term>
+                    <methodname>getInfo($object)</methodname> retrieves the metadata information
+                    about the object. The function will return array with metadata information. Some
+                    of the useful keys are:
+
+                    <variablelist>
+                        <varlistentry>
+                            <term><code>type</code></term>
+
                             <listitem>
-                            <para>The <acronym>MIME</acronym> type of the item.</para>
+                                <para>The <acronym>MIME</acronym> type of the item.</para>
                             </listitem>
                         </varlistentry>
-                        <varlistentry><term><code>size</code></term>
+                        <varlistentry>
+                            <term><code>size</code></term>
+
                             <listitem>
-                            <para>The size of the object data.</para>
+                                <para>The size of the object data.</para>
                             </listitem>
                         </varlistentry>
-                        <varlistentry><term><code>mtime</code></term>
+
+                        <varlistentry>
+                            <term><code>mtime</code></term>
+
                             <listitem>
-                            <para>UNIX-type timestamp of the last modification for the object.</para>
+                                <para>
+                                    UNIX-type timestamp of the last modification for the object.
+                                </para>
                             </listitem>
                         </varlistentry>
-                        <varlistentry><term><code>etag</code></term>
+
+                        <varlistentry>
+                            <term><code>etag</code></term>
+
                             <listitem>
-                            <para>The ETag of the data, which is the MD5 hash of the data, surrounded by quotes (").</para>
+                                <para>
+                                    The ETag of the data, which is the MD5 hash of the data,
+                                    surrounded by quotes (").
+                                </para>
                             </listitem>
                         </varlistentry>
-                        </variablelist>
-                        The function will return <constant>FALSE</constant> if the key does not correspond to any existing object.
+                    </variablelist>
+
+                    The function will return <constant>FALSE</constant> if the key does not
+                    correspond to any existing object.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
-                    <methodname>getObjectsByBucket($bucket)</methodname> returns the list of the object keys, contained
-                    in the bucket.
+                    <methodname>getObjectsByBucket($bucket)</methodname> returns the list of the
+                    object keys, contained in the bucket.
                 </para>
-        <example id="zend.service.amazon.s3.objects.list.example">
-            <title>Zend_Service_Amazon_S3 Object Listing Example</title>
-             <programlisting language="php"><![CDATA[
+
+                <example id="zend.service.amazon.s3.objects.list.example">
+                    <title>Zend_Service_Amazon_S3 Object Listing Example</title>
+
+                    <programlisting language="php"><![CDATA[
 require_once 'Zend/Service/Amazon/S3.php';
 
 $s3 = new Zend_Service_Amazon_S3($my_aws_key, $my_aws_secret_key);
@@ -354,38 +428,51 @@ foreach($list as $name) {
   echo "with data: $data\n";
 }
 ]]></programlisting>
-        </example>
+                </example>
             </listitem>
+
             <listitem>
                 <para>
-                    <methodname>isObjectAvailable($object)</methodname> checks if the object with given name exists.
+                    <methodname>isObjectAvailable($object)</methodname> checks if the object with
+                    given name exists.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
-                    <methodname>putFile($path, $object, $meta)</methodname> puts the content of the file in <varname>$path</varname>
-                    into the object named <varname>$object</varname>.
+                    <methodname>putFile($path, $object, $meta)</methodname> puts the content of the
+                    file in <varname>$path</varname> into the object named
+                    <varname>$object</varname>.
                 </para>
+
                 <para>
-                The optional <varname>$meta</varname> argument is the same as for <code>putObject</code>. If the
-                content type is omitted, it will be guessed basing on the source file name.
+                    The optional <varname>$meta</varname> argument is the same as for
+                    <code>putObject</code>. If the content type is omitted, it will be guessed
+                    basing on the source file name.
                 </para>
             </listitem>
-       </itemizedlist>
+        </itemizedlist>
     </sect2>
+
     <sect2 id="zend.service.amazon.s3.streaming">
         <title>Data Streaming</title>
+
         <para>
-        It is possible to get and put objects using not stream data held in memory but files or PHP streams.
-        This is especially useful when file sizes are large in order not to overcome memory limits.
+            It is possible to get and put objects using not stream data held in memory but files or
+            PHP streams. This is especially useful when file sizes are large in order not to
+            overcome memory limits.
         </para>
+
         <para>
-        To receive object using streaming, use method <methodname>getObjectStream($object, $filename)</methodname>. This method
-        will return <classname>Zend_Http_Response_Stream</classname>, which can be used as described in
-        <link linkend="zend.http.client.streaming">HTTP Client Data Streaming</link> section.
-        <example id="zend.service.amazon.s3.streaming.example1">
-        <title>Zend_Service_Amazon_S3 Data Streaming Example</title>
-             <programlisting language="php"><![CDATA[
+            To receive object using streaming, use method
+            <methodname>getObjectStream($object, $filename)</methodname>. This method will return
+            <classname>Zend_Http_Response_Stream</classname>, which can be used as described in
+            <link linkend="zend.http.client.streaming">HTTP Client Data Streaming</link> section.
+
+            <example id="zend.service.amazon.s3.streaming.example1">
+                <title>Zend_Service_Amazon_S3 Data Streaming Example</title>
+
+                <programlisting language="php"><![CDATA[
 $response = $amazon->getObjectStream("mybycket/zftest");
 // copy file
 copy($response->getStreamName(), "my/downloads/file");
@@ -393,32 +480,41 @@ copy($response->getStreamName(), "my/downloads/file");
 $fp = fopen("my/downloads/file2", "w");
 stream_copy_to_stream($response->getStream(), $fp);
 ]]></programlisting>
-        </example>
+            </example>
+        </para>
+
+        <para>
+            Second parameter for <methodname>getObjectStream()</methodname> is optional and
+            specifies target file to write the data. If not specified, temporary file is used, which
+            will be deleted after the respons eobject is destroyed.
+        </para>
+
+        <para>
+            To send object using streaming, use <methodname>putFileStream()</methodname> which has
+            the same signature as <methodname>putFile()</methodname> but will use streaming and not
+            read the file into memory.
+        </para>
+
+        <para>
+            Also, you can pass stream resource to <methodname>putObject()</methodname> method data
+            parameter, in which case the data will be read from the stream when sending the request
+            to the server.
         </para>
-        <para>Second parameter for <methodname>getObjectStream()</methodname> is optional and specifies target file
-         to write the data. If not specified, temporary file is used, which will be deleted after
-         the respons eobject is destroyed.
-         </para>
-
-         <para>
-         To send object using streaming, use <methodname>putFileStream()</methodname> which has the same signature as
-         <methodname>putFile()</methodname> but will use streaming and not read the file into memory.
-         </para>
-
-         <para>
-         Also, you can pass stream resource to <methodname>putObject()</methodname> method data parameter,
-         in which case the data will be read from the stream when sending the request to the server.
-         </para>
     </sect2>
+
     <sect2 id="zend.service.amazon.s3.streams">
         <title>Stream wrapper</title>
+
         <para>
-        In addition to the interfaces described above, <classname>Zend_Service_Amazon_S3</classname> also supports
-        operating as a stream wrapper. For this, you need to register the client object as the stream wrapper:
+            In addition to the interfaces described above,
+            <classname>Zend_Service_Amazon_S3</classname> also supports operating as a stream
+            wrapper. For this, you need to register the client object as the stream wrapper:
         </para>
+
         <example id="zend.service.amazon.s3.streams.example">
             <title>Zend_Service_Amazon_S3 Streams Example</title>
-             <programlisting language="php"><![CDATA[
+
+            <programlisting language="php"><![CDATA[
 require_once 'Zend/Service/Amazon/S3.php';
 
 $s3 = new Zend_Service_Amazon_S3($my_aws_key, $my_aws_secret_key);
@@ -433,10 +529,10 @@ echo file_get_contents("s3://my-own-bucket/testdata");
         </example>
 
         <para>
-        Directory operations (<code>mkdir</code>, <code>rmdir</code>, <code>opendir</code>, etc.)
-        will operate on buckets and thus their arguments should be of the form of <code>s3://bucketname</code>.
-        File operations operate on objects. Object creation, reading, writing, deletion, stat and
-        directory listing is supported.
+            Directory operations (<code>mkdir</code>, <code>rmdir</code>, <code>opendir</code>,
+            etc.) will operate on buckets and thus their arguments should be of the form of
+            <code>s3://bucketname</code>. File operations operate on objects. Object creation,
+            reading, writing, deletion, stat and directory listing is supported.
         </para>
     </sect2>
 </sect1>

+ 186 - 135
documentation/manual/en/module_specs/Zend_Service_Audioscrobbler.xml

@@ -1,176 +1,206 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- Reviewed: no -->
 <sect1 id="zend.service.audioscrobbler">
-
     <title>Zend_Service_Audioscrobbler</title>
 
     <sect2 id="zend.service.audioscrobbler.introduction">
-
         <title>Introduction</title>
 
         <para>
-            <classname>Zend_Service_Audioscrobbler</classname> is a simple <acronym>API</acronym> for using the Audioscrobbler REST Web Service. The
-            Audioscrobbler Web Service provides access to its database of Users, Artists, Albums, Tracks, Tags, Groups,
-            and Forums. The methods of the <classname>Zend_Service_Audioscrobbler</classname> class begin with one of these terms.
-            The syntax and namespaces of the Audioscrobbler Web Service are mirrored in
-            <classname>Zend_Service_Audioscrobbler</classname>. For more information about the Audioscrobbler REST Web Service,
-            please visit the <ulink url="http://www.audioscrobbler.net/data/webservices/">Audioscrobbler Web Service
-            site</ulink>.
+            <classname>Zend_Service_Audioscrobbler</classname> is a simple <acronym>API</acronym>
+            for using the Audioscrobbler REST Web Service. The Audioscrobbler Web Service provides
+            access to its database of Users, Artists, Albums, Tracks, Tags, Groups, and Forums. The
+            methods of the <classname>Zend_Service_Audioscrobbler</classname> class begin with one
+            of these terms. The syntax and namespaces of the Audioscrobbler Web Service are mirrored
+            in <classname>Zend_Service_Audioscrobbler</classname>. For more information about the
+            Audioscrobbler REST Web Service, please visit the <ulink
+                url="http://www.audioscrobbler.net/data/webservices/">Audioscrobbler Web Service
+                site</ulink>.
         </para>
-
     </sect2>
 
     <sect2 id="zend.service.audioscrobbler.users">
-
         <title>Users</title>
 
         <para>
-            In order to retrieve information for a specific user, the <methodname>setUser()</methodname> method is first used to
-            select the user for which data are to be retrieved. <classname>Zend_Service_Audioscrobbler</classname> provides
+            In order to retrieve information for a specific user, the
+            <methodname>setUser()</methodname> method is first used to select the user for which
+            data are to be retrieved. <classname>Zend_Service_Audioscrobbler</classname> provides
             several methods for retrieving data specific to a single user:
+
             <itemizedlist>
                 <listitem>
                     <para>
-                        <methodname>userGetProfileInformation()</methodname>: Returns a SimpleXML object containing the current
-                        user's profile information.
+                        <methodname>userGetProfileInformation()</methodname>: Returns a SimpleXML
+                        object containing the current user's profile information.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>userGetTopArtists()</methodname>: Returns a SimpleXML object containing a list of the current
-                        user's most listened to artists.
+                        <methodname>userGetTopArtists()</methodname>: Returns a SimpleXML object
+                        containing a list of the current user's most listened to artists.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>userGetTopAlbums()</methodname>: Returns a SimpleXML object containing a list of the current
-                        user's most listened to albums.
+                        <methodname>userGetTopAlbums()</methodname>: Returns a SimpleXML object
+                        containing a list of the current user's most listened to albums.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>userGetTopTracks()</methodname>: Returns a SimpleXML object containing a list of the current
-                        user's most listened to tracks.
+                        <methodname>userGetTopTracks()</methodname>: Returns a SimpleXML object
+                        containing a list of the current user's most listened to tracks.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>userGetTopTags()</methodname>: Returns a SimpleXML object containing a list of tags most applied
-                        by the current user.
+                        <methodname>userGetTopTags()</methodname>: Returns a SimpleXML object
+                        containing a list of tags most applied by the current user.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>userGetTopTagsForArtist()</methodname>: Requires that an artist be set via
-                        <methodname>setArtist()</methodname>. Returns a SimpleXML object containing the tags most applied to the
-                        current artist by the current user.
+                        <methodname>userGetTopTagsForArtist()</methodname>: Requires that an artist
+                        be set via <methodname>setArtist()</methodname>. Returns a SimpleXML object
+                        containing the tags most applied to the current artist by the current user.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>userGetTopTagsForAlbum()</methodname>: Requires that an album be set via
-                        <methodname>setAlbum()</methodname>. Returns a SimpleXML object containing the tags most applied to the
-                        current album by the current user.
+                        <methodname>userGetTopTagsForAlbum()</methodname>: Requires that an album be
+                        set via <methodname>setAlbum()</methodname>. Returns a SimpleXML object
+                        containing the tags most applied to the current album by the current user.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>userGetTopTagsForTrack()</methodname>: Requires that a track be set via
-                        <methodname>setTrack()</methodname>. Returns a SimpleXML object containing the tags most applied to the
-                        current track by the current user.
+                        <methodname>userGetTopTagsForTrack()</methodname>: Requires that a track be
+                        set via <methodname>setTrack()</methodname>. Returns a SimpleXML object
+                        containing the tags most applied to the current track by the current user.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>userGetFriends()</methodname>: Returns a SimpleXML object containing the user names of the
-                        current user's friends.
+                        <methodname>userGetFriends()</methodname>: Returns a SimpleXML object
+                        containing the user names of the current user's friends.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>userGetNeighbours()</methodname>: Returns a SimpleXML object containing the user names of
-                        people with similar listening habits to the current user.
+                        <methodname>userGetNeighbours()</methodname>: Returns a SimpleXML object
+                        containing the user names of people with similar listening habits to the
+                        current user.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>userGetRecentTracks()</methodname>: Returns a SimpleXML object containing the 10 tracks most
-                        recently played by the current user.
+                        <methodname>userGetRecentTracks()</methodname>: Returns a SimpleXML object
+                        containing the 10 tracks most recently played by the current user.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>userGetRecentBannedTracks()</methodname>: Returns a SimpleXML object containing a list of the 10
-                        tracks most recently banned by the current user.
+                        <methodname>userGetRecentBannedTracks()</methodname>: Returns a SimpleXML
+                        object containing a list of the 10 tracks most recently banned by the
+                        current user.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>userGetRecentLovedTracks()</methodname>: Returns a SimpleXML object containing a list of the 10
-                        tracks most recently loved by the current user.
+                        <methodname>userGetRecentLovedTracks()</methodname>: Returns a SimpleXML
+                        object containing a list of the 10 tracks most recently loved by the current
+                        user.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>userGetRecentJournals()</methodname>: Returns a SimpleXML object containing a list of the
-                        current user's most recent journal entries.
+                        <methodname>userGetRecentJournals()</methodname>: Returns a SimpleXML object
+                        containing a list of the current user's most recent journal entries.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>userGetWeeklyChartList()</methodname>: Returns a SimpleXML object containing a list of weeks for
-                        which there exist Weekly Charts for the current user.
+                        <methodname>userGetWeeklyChartList()</methodname>: Returns a SimpleXML
+                        object containing a list of weeks for which there exist Weekly Charts for
+                        the current user.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>userGetRecentWeeklyArtistChart()</methodname>: Returns a SimpleXML object containing the most
-                        recent Weekly Artist Chart for the current user.
+                        <methodname>userGetRecentWeeklyArtistChart()</methodname>: Returns a
+                        SimpleXML object containing the most recent Weekly Artist Chart for the
+                        current user.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>userGetRecentWeeklyAlbumChart()</methodname>: Returns a SimpleXML object containing the most
-                        recent Weekly Album Chart for the current user.
+                        <methodname>userGetRecentWeeklyAlbumChart()</methodname>: Returns a
+                        SimpleXML object containing the most recent Weekly Album Chart for the
+                        current user.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>userGetRecentWeeklyTrackChart()</methodname>: Returns a SimpleXML object containing the most
-                        recent Weekly Track Chart for the current user.
+                        <methodname>userGetRecentWeeklyTrackChart()</methodname>: Returns a
+                        SimpleXML object containing the most recent Weekly Track Chart for the
+                        current user.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>userGetPreviousWeeklyArtistChart($fromDate, $toDate)</methodname>: Returns a SimpleXML object
-                        containing the Weekly Artist Chart from <varname>$fromDate</varname> to <varname>$toDate</varname> for the
-                        current user.
+                        <methodname>userGetPreviousWeeklyArtistChart($fromDate,
+                            $toDate)</methodname>: Returns a SimpleXML object containing the Weekly
+                        Artist Chart from <varname>$fromDate</varname> to <varname>$toDate</varname>
+                        for the current user.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>userGetPreviousWeeklyAlbumChart($fromDate, $toDate)</methodname>: Returns a SimpleXML object
-                        containing the Weekly Album Chart from <varname>$fromDate</varname> to <varname>$toDate</varname> for the
-                        current user.
+                        <methodname>userGetPreviousWeeklyAlbumChart($fromDate,
+                            $toDate)</methodname>: Returns a SimpleXML object containing the Weekly
+                        Album Chart from <varname>$fromDate</varname> to <varname>$toDate</varname>
+                        for the current user.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>userGetPreviousWeeklyTrackChart($fromDate, $toDate)</methodname>: Returns a SimpleXML object
-                        containing the Weekly Track Chart from <varname>$fromDate</varname> to <varname>$toDate</varname> for the
-                        current user.
+                        <methodname>userGetPreviousWeeklyTrackChart($fromDate,
+                            $toDate)</methodname>: Returns a SimpleXML object containing the Weekly
+                        Track Chart from <varname>$fromDate</varname> to <varname>$toDate</varname>
+                        for the current user.
                     </para>
                 </listitem>
             </itemizedlist>
         </para>
 
         <example id="zend.service.audioscrobbler.users.example.profile_information">
-
             <title>Retrieving User Profile Information</title>
 
             <para>
-                In this example, we use the <methodname>setUser()</methodname> and <methodname>userGetProfileInformation()</methodname> methods
-                to retrieve a specific user's profile information:
+                In this example, we use the <methodname>setUser()</methodname> and
+                <methodname>userGetProfileInformation()</methodname> methods to retrieve a specific
+                user's profile information:
             </para>
 
             <programlisting language="php"><![CDATA[
@@ -183,11 +213,9 @@ $profileInfo = $as->userGetProfileInformation();
 print "Information for $profileInfo->realname "
     . "can be found at $profileInfo->url";
 ]]></programlisting>
-
         </example>
 
         <example id="zend.service.audioscrobbler.users.example.weekly_artist_chart">
-
             <title>Retrieving a User's Weekly Artist Chart</title>
 
             <programlisting language="php"><![CDATA[
@@ -215,54 +243,56 @@ foreach ($previousWeeklyArtists as $artist) {
     print '<a href="' . $artist->url . '">' . $artist->name . '</a><br />';
 }
 ]]></programlisting>
-
         </example>
-
     </sect2>
 
     <sect2 id="zend.service.audioscrobbler.artists">
-
         <title>Artists</title>
 
         <para>
-            <classname>Zend_Service_Audioscrobbler</classname> provides several methods for retrieving data about a specific
-            artist, specified via the <methodname>setArtist()</methodname> method:
+            <classname>Zend_Service_Audioscrobbler</classname> provides several methods for
+            retrieving data about a specific artist, specified via the
+            <methodname>setArtist()</methodname> method:
+
             <itemizedlist>
                 <listitem>
                     <para>
-                        <methodname>artistGetRelatedArtists()</methodname>: Returns a SimpleXML object containing a list of
-                        Artists similar to the current Artist.
+                        <methodname>artistGetRelatedArtists()</methodname>: Returns a SimpleXML
+                        object containing a list of Artists similar to the current Artist.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>artistGetTopFans()</methodname>: Returns a SimpleXML object containing a list of Users who
-                        listen most to the current Artist.
+                        <methodname>artistGetTopFans()</methodname>: Returns a SimpleXML object
+                        containing a list of Users who listen most to the current Artist.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>artistGetTopTracks()</methodname>: Returns a SimpleXML object containing a list of the current
-                        Artist's top-rated Tracks.
+                        <methodname>artistGetTopTracks()</methodname>: Returns a SimpleXML object
+                        containing a list of the current Artist's top-rated Tracks.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>artistGetTopAlbums()</methodname>: Returns a SimpleXML object containing a list of the current
-                        Artist's top-rated Albums.
+                        <methodname>artistGetTopAlbums()</methodname>: Returns a SimpleXML object
+                        containing a list of the current Artist's top-rated Albums.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>artistGetTopTags()</methodname>: Returns a SimpleXML object containing a list of the Tags most
-                        frequently applied to current Artist.
+                        <methodname>artistGetTopTags()</methodname>: Returns a SimpleXML object
+                        containing a list of the Tags most frequently applied to current Artist.
                     </para>
                 </listitem>
             </itemizedlist>
         </para>
 
         <example id="zend.service.audioscrobbler.artists.example.related_artists">
-
             <title>Retrieving Related Artists</title>
 
             <programlisting language="php"><![CDATA[
@@ -276,157 +306,178 @@ foreach ($relatedArtists as $artist) {
     print '<a href="' . $artist->url . '">' . $artist->name . '</a><br />';
 }
 ]]></programlisting>
-
         </example>
-
     </sect2>
 
     <sect2 id="zend.service.audioscrobbler.tracks">
-
         <title>Tracks</title>
 
         <para>
-            <classname>Zend_Service_Audioscrobbler</classname> provides two methods for retrieving data specific to a single
-            track, specified via the <methodname>setTrack()</methodname> method:
+            <classname>Zend_Service_Audioscrobbler</classname> provides two methods for retrieving
+            data specific to a single track, specified via the <methodname>setTrack()</methodname>
+            method:
+
             <itemizedlist>
                 <listitem>
                     <para>
-                        <methodname>trackGetTopFans()</methodname>: Returns a SimpleXML object containing a list of Users who
-                        listen most to the current Track.
+                        <methodname>trackGetTopFans()</methodname>: Returns a SimpleXML object
+                        containing a list of Users who listen most to the current Track.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>trackGetTopTags()</methodname>: Returns a SimpleXML object containing a list of the Tags most
-                        frequently applied to the current Track.
+                        <methodname>trackGetTopTags()</methodname>: Returns a SimpleXML object
+                        containing a list of the Tags most frequently applied to the current Track.
                     </para>
                 </listitem>
             </itemizedlist>
         </para>
-
     </sect2>
 
     <sect2 id="zend.service.audioscrobbler.tags">
-
         <title>Tags</title>
 
         <para>
-            <classname>Zend_Service_Audioscrobbler</classname> provides several methods for retrieving data specific to a single
-            tag, specified via the <methodname>setTag()</methodname> method:
+            <classname>Zend_Service_Audioscrobbler</classname> provides several methods for
+            retrieving data specific to a single tag, specified via the
+            <methodname>setTag()</methodname> method:
+
             <itemizedlist>
                 <listitem>
                     <para>
-                        <methodname>tagGetOverallTopTags()</methodname>: Returns a SimpleXML object containing a list of Tags most
-                        frequently used on Audioscrobbler.
+                        <methodname>tagGetOverallTopTags()</methodname>: Returns a SimpleXML object
+                        containing a list of Tags most frequently used on Audioscrobbler.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>tagGetTopArtists()</methodname>: Returns a SimpleXML object containing a list of Artists to whom
-                        the current Tag was most frequently applied.
+                        <methodname>tagGetTopArtists()</methodname>: Returns a SimpleXML object
+                        containing a list of Artists to whom the current Tag was most frequently
+                        applied.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>tagGetTopAlbums()</methodname>: Returns a SimpleXML object containing a list of Albums to which
-                        the current Tag was most frequently applied.
+                        <methodname>tagGetTopAlbums()</methodname>: Returns a SimpleXML object
+                        containing a list of Albums to which the current Tag was most frequently
+                        applied.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>tagGetTopTracks()</methodname>: Returns a SimpleXML object containing a list of Tracks to which
-                        the current Tag was most frequently applied.
+                        <methodname>tagGetTopTracks()</methodname>: Returns a SimpleXML object
+                        containing a list of Tracks to which the current Tag was most frequently
+                        applied.
                     </para>
                 </listitem>
             </itemizedlist>
         </para>
-
     </sect2>
 
     <sect2 id="zend.service.audioscrobbler.groups">
-
         <title>Groups</title>
 
         <para>
-            <classname>Zend_Service_Audioscrobbler</classname> provides several methods for retrieving data specific to a single
-            group, specified via the <methodname>setGroup()</methodname> method:
+            <classname>Zend_Service_Audioscrobbler</classname> provides several methods for
+            retrieving data specific to a single group, specified via the
+            <methodname>setGroup()</methodname> method:
+
             <itemizedlist>
                 <listitem>
                     <para>
-                        <methodname>groupGetRecentJournals()</methodname>: Returns a SimpleXML object containing a list of recent
-                        journal posts by Users in the current Group.
+                        <methodname>groupGetRecentJournals()</methodname>: Returns a SimpleXML
+                        object containing a list of recent journal posts by Users in the current
+                        Group.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>groupGetWeeklyChart()</methodname>: Returns a SimpleXML object containing a list of weeks for
-                        which there exist Weekly Charts for the current Group.
+                        <methodname>groupGetWeeklyChart()</methodname>: Returns a SimpleXML object
+                        containing a list of weeks for which there exist Weekly Charts for the
+                        current Group.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>groupGetRecentWeeklyArtistChart()</methodname>: Returns a SimpleXML object containing the most
-                        recent Weekly Artist Chart for the current Group.
+                        <methodname>groupGetRecentWeeklyArtistChart()</methodname>: Returns a
+                        SimpleXML object containing the most recent Weekly Artist Chart for the
+                        current Group.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>groupGetRecentWeeklyAlbumChart()</methodname>: Returns a SimpleXML object containing the most
-                        recent Weekly Album Chart for the current Group.
+                        <methodname>groupGetRecentWeeklyAlbumChart()</methodname>: Returns a
+                        SimpleXML object containing the most recent Weekly Album Chart for the
+                        current Group.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>groupGetRecentWeeklyTrackChart()</methodname>: Returns a SimpleXML object containing the most
-                        recent Weekly Track Chart for the current Group.
+                        <methodname>groupGetRecentWeeklyTrackChart()</methodname>: Returns a
+                        SimpleXML object containing the most recent Weekly Track Chart for the
+                        current Group.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>groupGetPreviousWeeklyArtistChart($fromDate, $toDate)</methodname>: Requires
-                        <methodname>setFromDate()</methodname> and <methodname>setToDate()</methodname>. Returns a SimpleXML object containing
-                        the Weekly Artist Chart from the current fromDate to the current toDate for the current Group.
+                        <methodname>groupGetPreviousWeeklyArtistChart($fromDate,
+                            $toDate)</methodname>: Requires <methodname>setFromDate()</methodname>
+                        and <methodname>setToDate()</methodname>. Returns a SimpleXML object
+                        containing the Weekly Artist Chart from the current fromDate to the current
+                        toDate for the current Group.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>groupGetPreviousWeeklyAlbumChart($fromDate, $toDate)</methodname>: Requires
-                        <methodname>setFromDate()</methodname> and <methodname>setToDate()</methodname>. Returns a SimpleXML object containing
-                        the Weekly Album Chart from the current fromDate to the current toDate for the current Group.
+                        <methodname>groupGetPreviousWeeklyAlbumChart($fromDate,
+                            $toDate)</methodname>: Requires <methodname>setFromDate()</methodname>
+                        and <methodname>setToDate()</methodname>. Returns a SimpleXML object
+                        containing the Weekly Album Chart from the current fromDate to the current
+                        toDate for the current Group.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <methodname>groupGetPreviousWeeklyTrackChart($fromDate, $toDate)</methodname>: Returns a SimpleXML object
-                        containing the Weekly Track Chart from the current fromDate to the current toDate for the
-                        current Group.
+                        <methodname>groupGetPreviousWeeklyTrackChart($fromDate,
+                            $toDate)</methodname>: Returns a SimpleXML object containing the Weekly
+                        Track Chart from the current fromDate to the current toDate for the current
+                        Group.
                     </para>
                 </listitem>
             </itemizedlist>
         </para>
-
     </sect2>
 
     <sect2 id="zend.service.audioscrobbler.forums">
-
         <title>Forums</title>
 
         <para>
-            <classname>Zend_Service_Audioscrobbler</classname> provides a method for retrieving data specific to a single forum,
-            specified via the <methodname>setForum()</methodname> method:
+            <classname>Zend_Service_Audioscrobbler</classname> provides a method for retrieving data
+            specific to a single forum, specified via the <methodname>setForum()</methodname>
+            method:
+
             <itemizedlist>
                 <listitem>
                     <para>
-                        <methodname>forumGetRecentPosts()</methodname>: Returns a SimpleXML object containing a list of recent posts
-                        in the current forum.
+                        <methodname>forumGetRecentPosts()</methodname>: Returns a SimpleXML object
+                        containing a list of recent posts in the current forum.
                     </para>
                 </listitem>
             </itemizedlist>
         </para>
-
     </sect2>
-
 </sect1>
 <!--
 vim:se ts=4 sw=4 et:
--->
+-->

Some files were not shown because too many files changed in this diff