[DOCUMENTATION] English: manual fixes

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

documentation/manual/en/tutorials/lucene-index-structure.xml

@@ -20,22 +20,23 @@
                 Lucene 2.3, document storage files can be shared between segments; however,
                 <classname>Zend_Search_Lucene</classname> doesn't use this
                 capability</para></footnote>. All segment data is stored in
-        <filename>_xxxxx.cfs</filename> files, where <varname>xxxxx</varname> is a segment name.
+        <filename>_xxxxx.cfs</filename> files, where <emphasis>xxxxx</emphasis> is a segment name.
     </para>
 
     <para>
-        Once an index segment file is created, it can't be updated.  New documents are added to new
-        segments.  Deleted documents are only marked as deleted in an optional
+        Once an index segment file is created, it can't be updated. New documents are added to new
+        segments. Deleted documents are only marked as deleted in an optional
         <filename>&lt;segmentname&gt;.del</filename> file.
     </para>
 
     <para>
         Document updating is performed as separate delete and add operations, even though it's done
-        using an <methodname>update()</methodname> API call<footnote><para>This call is provided
-                only by Java Lucene now, but it's planned to extend the
-                <classname>Zend_Search_Lucene</classname> API with similar
-                functionality</para></footnote>.  This simplifies adding new documents, and allows
-        updating concurrently with search operations.
+        using an <methodname>update()</methodname> <acronym>API</acronym> call
+        <footnote><para>This call is provided only by Java Lucene now, but it's planned to extend
+            the <classname>Zend_Search_Lucene</classname> <acronym>API</acronym> with similar
+            functionality</para></footnote>.
+        This simplifies adding new documents, and allows updating concurrently with search
+        operations.
     </para>
 
     <para>
@@ -88,21 +89,21 @@
     <itemizedlist>
         <listitem>
             <para>
-                <varname>MaxBufferedDocs</varname> (the minimal number of documents required before
-                the buffered in-memory documents are written into a new segment);
+                <emphasis>MaxBufferedDocs</emphasis> (the minimal number of documents required
+                before the buffered in-memory documents are written into a new segment);
             </para>
         </listitem>
 
         <listitem>
             <para>
-                <varname>MaxMergeDocs</varname> (the largest number of documents ever merged by
+                <emphasis>MaxMergeDocs</emphasis> (the largest number of documents ever merged by
                 an optimization operation); and
             </para>
         </listitem>
 
         <listitem>
             <para>
-                <varname>MergeFactor</varname> (which determines how often segment indices are
+                <emphasis>MergeFactor</emphasis> (which determines how often segment indices are
                 merged by auto-optimization operations).
             </para>
         </listitem>

documentation/manual/en/tutorials/lucene-indexing.xml

@@ -55,8 +55,8 @@ $doc = Zend_Search_Lucene_Document_Xlsx::loadXlsxFile($path);
         </para>
 
         <para>
-            You may need an on-demand indexing configuration (something like OLTP system). In such
-            systems, you usually add one document per user request. As such, the
+            You may need an on-demand indexing configuration (something like <acronym>OLTP</acronym>
+            system). In such systems, you usually add one document per user request. As such, the
             <emphasis>MaxBufferedDocs</emphasis> option will not affect the system. On the other
             hand, <emphasis>MaxMergeDocs</emphasis> is really helpful as it allows you to limit
             maximum script execution time. <emphasis>MergeFactor</emphasis> should be set to a value
@@ -68,7 +68,7 @@ $doc = Zend_Search_Lucene_Document_Xlsx::loadXlsxFile($path);
         <para>
             If you will be primarily performing batch index updates, your configuration should use a
             <emphasis>MaxBufferedDocs</emphasis> option set to the maximum value supported by the
-            available amount of memory.  <emphasis>MaxMergeDocs</emphasis> and
+            available amount of memory. <emphasis>MaxMergeDocs</emphasis> and
             <emphasis>MergeFactor</emphasis> have to be set to values reducing auto-optimization
             involvement as much as possible <footnote><para>An additional limit is the maximum file
                     handlers supported by the operation system for concurrent open

documentation/manual/en/tutorials/lucene-intro.xml

@@ -5,16 +5,16 @@
 
     <para>
         The <classname>Zend_Search_Lucene</classname> component is intended to provide a
-        ready-for-use full-text search solution.  It doesn't require any PHP
+        ready-for-use full-text search solution. It doesn't require any <acronym>PHP</acronym>
         extensions<footnote><para>Though some <acronym>UTF-8</acronym> processing functionality
-                requires the <classname>mbstring</classname> extension to be turned
+                requires the <emphasis>mbstring</emphasis> extension to be turned
                 on</para></footnote> or additional software to be installed, and can be used
         immediately after Zend Framework installation.
     </para>
 
     <para>
-        <classname>Zend_Search_Lucene</classname> is a pure PHP port of the popular open source
-        full-text search engine known as Apache Lucene.  See <ulink
+        <classname>Zend_Search_Lucene</classname> is a pure <acronym>PHP</acronym> port of the
+        popular open source full-text search engine known as Apache Lucene. See <ulink
             url="http://lucene.apache.org">http://lucene.apache.org/</ulink> for the details.
     </para>
 
@@ -40,7 +40,7 @@
     <para>
         Several analyzers are provided within the <classname>Zend_Search_Lucene</classname> package.
         The default analyzer works with <acronym>ASCII</acronym> text (since the
-        <acronym>UTF-8</acronym> analyzer needs the <classname>mbstring</classname> extension to be
+        <acronym>UTF-8</acronym> analyzer needs the <emphasis>mbstring</emphasis> extension to be
         turned on). It is case insensitive, and it skips numbers. Use other analyzers or create your
         own analyzer if you need to change this behavior.
     </para>
@@ -79,9 +79,9 @@
             <para>
                 <emphasis>Not</emphasis> to use Lucene index as a storage since it may dramatically
                 decrease search hit retrieving performance. Store only unique document identifiers
-                (doc paths, URLs, database unique IDs) and associated data within an index. E.g.
-                title, annotation, category, language info, avatar. (Note: a field may be included
-                in indexing, but not stored, or stored, but not indexed).
+                (doc paths, <acronym>URL</acronym>s, database unique IDs) and associated data within
+                an index. E.g. title, annotation, category, language info, avatar. (Note: a field
+                may be included in indexing, but not stored, or stored, but not indexed).
             </para>
         </listitem>
 

documentation/manual/en/tutorials/lucene-queries.xml

@@ -102,8 +102,8 @@ title:"The Right Way" AND text:go
 ]]></programlisting>
 
         <para>
-            Searches for the phrase "The Right Way" within the <varname>title</varname> field and
-            the word "go" within the <varname>text</varname> field.
+            Searches for the phrase "The Right Way" within the <property>title</property> field and
+            the word "go" within the <property>text</property> field.
         </para>
     </example>
 
@@ -115,7 +115,7 @@ title:"The Right Way" AND  go
 ]]></programlisting>
 
         <para>
-            Searches for the phrase "The Right Way" within the <varname>title</varname> field and
+            Searches for the phrase "The Right Way" within the <property>title</property> field and
             the word "go" word appearing in any field of the document.
         </para>
     </example>
@@ -128,9 +128,9 @@ title:Do it right
 ]]></programlisting>
 
         <para>
-            Searches for the word "Do" within the <varname>title</varname> field and the words "it"
-            and "right" words through all fields; any single one matching will result in a document
-            match.
+            Searches for the word "Do" within the <property>title</property> field and the words
+            "it" and "right" words through all fields; any single one matching will result in
+            a document match.
         </para>
     </example>
 

documentation/manual/en/tutorials/lucene-searching.xml

@@ -14,19 +14,20 @@
 $hits = $index->find($query);
 
 foreach ($hits as $hit) {
-    printf(“%d %f %s\n”, $hit->id, $hit->score, $hit->title);
+    printf("%d %f %s\n", $hit->id, $hit->score, $hit->title);
 }
 ]]></programlisting>
     </example>
 
     <para>
         This example demonstrates the usage of two special search hit properties -
-        <varname>id</varname> and <varname>score</varname>.
+        <property>id</property> and <property>score</property>.
     </para>
 
     <para>
-        <varname>id</varname> is an internal document identifier used within a Lucene index. It may
-        be used for a variety of operations, including deleting a document from the index:
+        <property>id</property> is an internal document identifier used within a Lucene index.
+        It may be used for a variety of operations, including deleting a document from the
+        index:
     </para>
 
     <example id="learning.lucene.searching.delete-example">
@@ -61,7 +62,7 @@ $doc = $index->getDocument($id);
     </note>
 
     <para>
-        The <varname>score</varname> field is a hit score. Search results are ordered by score by
+        The <property>score</property> field is a hit score. Search results are ordered by score by
         default (best results returned first).
     </para>
 
@@ -74,15 +75,15 @@ $doc = $index->getDocument($id);
 
     <para>
         The example also demonstrates an ability to access stored fields (e.g.,
-        <code>$hit-&gt;title</code>).  At the first access to any hit property other than
-        <varname>id</varname> or <varname>score</varname>, document stored fields are loaded, and
-        the corresponding field value is returned.
+        <command>$hit->title</command>). At the first access to any hit property other than
+        <property>id</property> or <property>score</property>, document stored fields are loaded,
+        and the corresponding field value is returned.
     </para>
 
     <para>
-        This causes an ambiguity for documents having their own <varname>id</varname> or
-        <varname>score</varname> fields; as a result, it's not recommended to use these field names
-        within stored documents. Nevertheless, they still can be accessed via the
+        This causes an ambiguity for documents having their own <property>id</property> or
+        <property>score</property> fields; as a result, it's not recommended to use these field
+        names within stored documents. Nevertheless, they still can be accessed via the
         <methodname>getDocument()</methodname> method:
     </para>