HSEARCH-949 Switching from 'literal' to 'property' in tables. More ap…

…propriate and renders nicer in HTML. In pdf is still does not allow line breaks

hibernate-search-documentation/src/main/docbook/en-US/modules/configuration.xml

@@ -105,7 +105,7 @@
       strategy, back ends and directory providers. Refer to <xref
       linkend="search-configuration-directory" />, <xref
       linkend="configuration-worker" /> and <xref
-      linkend="configuration-reader-strategy" /> for more details. </para>
+      linkend="configuration-reader-strategy" /> for more details.</para>
     </section>
 
     <section>
@@ -241,17 +241,17 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr
 
         <tbody>
           <row>
-            <entry><literal>ram</literal>: Memory based directory, the
+            <entry><property>ram</property>: Memory based directory, the
             directory will be uniquely identified (in the same deployment
             unit) by the <literal>@Indexed.index</literal> element</entry>
 
             <entry>none</entry>
           </row>
 
           <row>
-            <entry><literal>filesystem</literal>: File system based directory.
-            The directory used will be &lt;indexBase&gt;/&lt; indexName
-            &gt;</entry>
+            <entry><property>filesystem</property>: File system based
+            directory. The directory used will be &lt;indexBase&gt;/&lt;
+            indexName &gt;</entry>
 
             <entry><para><literal>indexBase</literal> : Base
             directory</para><para><literal>indexName</literal>: override
@@ -278,7 +278,7 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr
           </row>
 
           <row>
-            <entry><para><literal>filesystem-master</literal>: File system
+            <entry><para><property>filesystem-master</property>: File system
             based directory. Like <literal>filesystem</literal>. It also
             copies the index to a source directory (aka copy directory) on a
             regular basis.</para><para>The recommended value for the refresh
@@ -326,7 +326,7 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr
           </row>
 
           <row>
-            <entry><para><literal>filesystem-slave</literal>: File system
+            <entry><para><property>filesystem-slave</property>: File system
             based directory. Like <literal>filesystem</literal>, but retrieves
             a master version (source) on a regular basis. To avoid locking and
             inconsistent search results, 2 local copies are
@@ -389,7 +389,7 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr
           </row>
 
           <row>
-            <entry><para><literal>infinispan</literal>: Infinispan based
+            <entry><para><property>infinispan</property>: Infinispan based
             directory. Use it to store the index in a distributed grid, making
             index changes visible to all elements of the cluster very quickly.
             Also see <xref linkend="infinispan-directories" /> for additional
@@ -590,7 +590,7 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr
           </row>
 
           <row>
-            <entry><literal>hibernate.search.worker.scope</literal></entry>
+            <entry><property>hibernate.search.worker.scope</property></entry>
 
             <entry>The fully qualifed class name of the
             <classname>Worker</classname> implementation to use. If this
@@ -600,7 +600,7 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr
           </row>
 
           <row>
-            <entry><literal>hibernate.search.worker.*</literal></entry>
+            <entry><property>hibernate.search.worker.*</property></entry>
 
             <entry>All configuration properties prefixed with
             <literal>hibernate.search.worker</literal> are passed to the
@@ -609,7 +609,7 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr
           </row>
 
           <row>
-            <entry><literal>hibernate.search.worker.batch_size</literal></entry>
+            <entry><property>hibernate.search.worker.batch_size</property></entry>
 
             <entry>Defines the maximum number of indexing operation batched
             per context. Once the limit is reached indexing will be triggered
@@ -649,15 +649,15 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr
           </row>
 
           <row>
-            <entry><literal>hibernate.search.&lt;indexName&gt;.worker.execution</literal></entry>
+            <entry><property>hibernate.search.&lt;indexName&gt;.worker.execution</property></entry>
 
             <entry><para><literal>sync</literal>: synchronous execution
             (default)</para><para><literal>async</literal>: asynchronous
             execution</para></entry>
           </row>
 
           <row>
-            <entry><literal>hibernate.search.&lt;indexName&gt;.worker.thread_pool.size</literal></entry>
+            <entry><property>hibernate.search.&lt;indexName&gt;.worker.thread_pool.size</property></entry>
 
             <entry>The backend can apply updates from the same transaction
             context (or batch) in parallel, using a threadpool. The default
@@ -666,7 +666,7 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr
           </row>
 
           <row>
-            <entry><literal>hibernate.search.&lt;indexName&gt;.worker.buffer_queue.max</literal></entry>
+            <entry><property>hibernate.search.&lt;indexName&gt;.worker.buffer_queue.max</property></entry>
 
             <entry>Defines the maximal number of work queue if the thread poll
             is starved. Useful only for asynchronous execution. Default to
@@ -697,7 +697,7 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr
           </row>
 
           <row>
-            <entry><literal>hibernate.search.&lt;indexName&gt;.worker.backend</literal></entry>
+            <entry><property>hibernate.search.&lt;indexName&gt;.worker.backend</property></entry>
 
             <entry><para><literal>lucene</literal>: The default backend which
             runs index updates in the same VM. Also used when the property is
@@ -738,14 +738,14 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr
           </row>
 
           <row>
-            <entry><literal>hibernate.search.&lt;indexName&gt;.worker.jndi.*</literal></entry>
+            <entry><property>hibernate.search.&lt;indexName&gt;.worker.jndi.*</property></entry>
 
             <entry>Defines the JNDI properties to initiate the InitialContext
             (if needed). JNDI is only used by the JMS back end.</entry>
           </row>
 
           <row>
-            <entry><literal>hibernate.search.&lt;indexName&gt;.worker.jms.connection_factory</literal></entry>
+            <entry><property>hibernate.search.&lt;indexName&gt;.worker.jms.connection_factory</property></entry>
 
             <entry>Mandatory for the JMS back end. Defines the JNDI name to
             lookup the JMS connection factory from
@@ -754,7 +754,7 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr
           </row>
 
           <row>
-            <entry><literal>hibernate.search.&lt;indexName&gt;.worker.jms.queue</literal></entry>
+            <entry><property>hibernate.search.&lt;indexName&gt;.worker.jms.queue</property></entry>
 
             <entry>Mandatory for the JMS back end. Defines the JNDI name to
             lookup the JMS queue from. The queue will be used to post work
@@ -776,29 +776,29 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr
           </row>
 
           <row>
-            <entry><literal>hibernate.search.&lt;indexName&gt;.worker.jgroups.clusterName</literal></entry>
+            <entry><property>hibernate.search.&lt;indexName&gt;.worker.jgroups.clusterName</property></entry>
 
             <entry>Optional for JGroups back end. Defines the name of JGroups
             channel.</entry>
           </row>
 
           <row>
-            <entry><literal>hibernate.search.&lt;indexName&gt;.worker.jgroups.configurationFile</literal></entry>
+            <entry><property>hibernate.search.&lt;indexName&gt;.worker.jgroups.configurationFile</property></entry>
 
             <entry>Optional JGroups network stack configuration. Defines the
             name of a JGroups configuration file, which must exist on
             classpath.</entry>
           </row>
 
           <row>
-            <entry><literal>hibernate.search.&lt;indexName&gt;.worker.jgroups.configurationXml</literal></entry>
+            <entry><property>hibernate.search.&lt;indexName&gt;.worker.jgroups.configurationXml</property></entry>
 
             <entry>Optional JGroups network stack configuration. Defines a
             String representing JGroups configuration as XML.</entry>
           </row>
 
           <row>
-            <entry><literal>hibernate.search.&lt;indexName&gt;.worker.jgroups.configurationString</literal></entry>
+            <entry><property>hibernate.search.&lt;indexName&gt;.worker.jgroups.configurationString</property></entry>
 
             <entry>Optional JGroups network stack configuration. Provides
             JGroups configuration in plain text.</entry>
@@ -1191,9 +1191,7 @@ hibernate.search.default.indexwriter.ram_buffer_size 64</programlisting>
         <tbody>
           <row>
             <entry>
-              <literallayout>hibernate.search.
-[default|&lt;indexname&gt;].   
-exclusive_index_use</literallayout>
+              <property>hibernate.search.[default|&lt;indexname&gt;].exclusive_index_use</property>
             </entry>
 
             <entry>
@@ -1209,9 +1207,7 @@ exclusive_index_use</literallayout>
 
           <row>
             <entry>
-              <literallayout>hibernate.search.
-[default|&lt;indexname&gt;].   
-max_queue_length</literallayout>
+              <property>hibernate.search.[default|&lt;indexname&gt;].max_queue_length</property>
             </entry>
 
             <entry>
@@ -1230,9 +1226,7 @@ max_queue_length</literallayout>
 
           <row>
             <entry>
-              <literallayout>hibernate.search.
-[default|&lt;indexname&gt;].
-indexwriter.max_buffered_delete_terms</literallayout>
+              <property>hibernate.search.[default|&lt;indexname&gt;].indexwriter.max_buffered_delete_terms</property>
             </entry>
 
             <entry>
@@ -1247,9 +1241,7 @@ indexwriter.max_buffered_delete_terms</literallayout>
 
           <row>
             <entry>
-              <literallayout>hibernate.search.
-[default|&lt;indexname&gt;].
-indexwriter.max_buffered_docs</literallayout>
+              <property>hibernate.search.[default|&lt;indexname&gt;].indexwriter.max_buffered_docs</property>
             </entry>
 
             <entry>
@@ -1262,9 +1254,7 @@ indexwriter.max_buffered_docs</literallayout>
 
           <row>
             <entry>
-              <literallayout>hibernate.search.
-[default|&lt;indexname&gt;].
-indexwriter.max_merge_docs</literallayout>
+              <property>hibernate.search.[default|&lt;indexname&gt;].indexwriter.max_merge_docs</property>
             </entry>
 
             <entry>
@@ -1279,9 +1269,7 @@ indexwriter.max_merge_docs</literallayout>
 
           <row>
             <entry>
-              <literallayout>hibernate.search.
-[default|&lt;indexname&gt;].
-indexwriter.merge_factor</literallayout>
+              <property>hibernate.search.[default|&lt;indexname&gt;].indexwriter.merge_factor</property>
             </entry>
 
             <entry>
@@ -1303,9 +1291,7 @@ indexwriter.merge_factor</literallayout>
 
           <row>
             <entry>
-              <literallayout>hibernate.search.
-[default|&lt;indexname&gt;].
-indexwriter.merge_min_size</literallayout>
+              <property>hibernate.search.[default|&lt;indexname&gt;].indexwriter.merge_min_size</property>
             </entry>
 
             <entry>
@@ -1327,9 +1313,7 @@ indexwriter.merge_min_size</literallayout>
 
           <row>
             <entry>
-              <literallayout>hibernate.search.
-[default|&lt;indexname&gt;].
-indexwriter.merge_max_size</literallayout>
+              <property>hibernate.search.[default|&lt;indexname&gt;].indexwriter.merge_max_size</property>
             </entry>
 
             <entry>
@@ -1352,9 +1336,7 @@ indexwriter.merge_max_size</literallayout>
 
           <row>
             <entry>
-              <literallayout>hibernate.search.
-[default|&lt;indexname&gt;].
-indexwriter.merge_max_optimize_size</literallayout>
+              <property>hibernate.search.[default|&lt;indexname&gt;].indexwriter.merge_max_optimize_size</property>
             </entry>
 
             <entry>
@@ -1374,9 +1356,7 @@ indexwriter.merge_max_optimize_size</literallayout>
 
           <row>
             <entry>
-              <literallayout>hibernate.search.
-[default|&lt;indexname&gt;].
-indexwriter.merge_calibrate_by_deletes</literallayout>
+              <property>hibernate.search.[default|&lt;indexname&gt;].indexwriter.merge_calibrate_by_deletes</property>
             </entry>
 
             <entry>
@@ -1397,9 +1377,7 @@ indexwriter.merge_calibrate_by_deletes</literallayout>
 
           <row>
             <entry>
-              <literallayout>hibernate.search.
-[default|&lt;indexname&gt;].
-indexwriter.ram_buffer_size</literallayout>
+              <property>hibernate.search.[default|&lt;indexname&gt;].indexwriter.ram_buffer_size</property>
             </entry>
 
             <entry>
@@ -1417,9 +1395,7 @@ indexwriter.ram_buffer_size</literallayout>
 
           <row>
             <entry>
-              <literallayout>hibernate.search.
-[default|&lt;indexname&gt;].
-indexwriter.term_index_interval</literallayout>
+              <property>hibernate.search.[default|&lt;indexname&gt;].indexwriter.term_index_interval</property>
             </entry>
 
             <entry>
@@ -1436,9 +1412,7 @@ indexwriter.term_index_interval</literallayout>
 
           <row>
             <entry>
-              <literallayout>hibernate.search.
-[default|&lt;indexname&gt;].
-indexwriter.use_compound_file</literallayout>
+              <property>hibernate.search.[default|&lt;indexname&gt;].indexwriter.use_compound_file</property>
             </entry>
 
             <entry>The advantage of using the compound file format is that
@@ -1456,8 +1430,7 @@ indexwriter.use_compound_file</literallayout>
 
           <row>
             <entry>
-              <literallayout>hibernate.search.
-enable_dirty_check</literallayout>
+              <literallayout><property>hibernate.search.enable_dirty_check</property></literallayout>
             </entry>
 
             <entry>
@@ -1586,7 +1559,7 @@ hibernate.search.default.indexwriter.merge_max_size 7</programlisting>
 
         <tbody>
           <row>
-            <entry>simple</entry>
+            <entry><property>simple</property></entry>
 
             <entry>org.apache.lucene.store.SimpleFSLockFactory</entry>
 
@@ -1602,7 +1575,7 @@ hibernate.search.default.indexwriter.merge_max_size 7</programlisting>
           </row>
 
           <row>
-            <entry>native</entry>
+            <entry><property>native</property></entry>
 
             <entry>org.apache.lucene.store.NativeFSLockFactory</entry>
 
@@ -1614,7 +1587,7 @@ hibernate.search.default.indexwriter.merge_max_size 7</programlisting>
           </row>
 
           <row>
-            <entry>single</entry>
+            <entry><property>single</property></entry>
 
             <entry>org.apache.lucene.store.SingleInstanceLockFactory</entry>
 
@@ -1626,7 +1599,7 @@ hibernate.search.default.indexwriter.merge_max_size 7</programlisting>
           </row>
 
           <row>
-            <entry>none</entry>
+            <entry><property>none</property></entry>
 
             <entry>org.apache.lucene.store.NoLockFactory</entry>