[hibernate-commits] Hibernate SVN: r12904 - trunk/HibernateExt/search/doc/reference/en/modules.

hibernate-commits at lists.jboss.org hibernate-commits at lists.jboss.org
Tue Aug 7 12:51:42 EDT 2007


Author: hardy.ferentschik
Date: 2007-08-07 12:51:42 -0400 (Tue, 07 Aug 2007)
New Revision: 12904

Modified:
   trunk/HibernateExt/search/doc/reference/en/modules/architecture.xml
   trunk/HibernateExt/search/doc/reference/en/modules/configuration.xml
   trunk/HibernateExt/search/doc/reference/en/modules/getting-started.xml
   trunk/HibernateExt/search/doc/reference/en/modules/mapping.xml
Log:
HSEARCH-98 Updated the dependencies list

Modified: trunk/HibernateExt/search/doc/reference/en/modules/architecture.xml
===================================================================
--- trunk/HibernateExt/search/doc/reference/en/modules/architecture.xml	2007-08-06 16:47:30 UTC (rev 12903)
+++ trunk/HibernateExt/search/doc/reference/en/modules/architecture.xml	2007-08-07 16:51:42 UTC (rev 12904)
@@ -26,7 +26,7 @@
   fact, the Search Session is built on top of the Hibernate Session. The
   application code use the unified <classname>org.hibernate.Query</classname>
   or <classname>javax.persistence.Query</classname> APIs exactly the way a
-  HQL, JPA-QL or native queries would be done.</para>
+  HQL, JPA-QL or native queries would do.</para>
 
   <section>
     <title>Batching Scope</title>

Modified: trunk/HibernateExt/search/doc/reference/en/modules/configuration.xml
===================================================================
--- trunk/HibernateExt/search/doc/reference/en/modules/configuration.xml	2007-08-06 16:47:30 UTC (rev 12903)
+++ trunk/HibernateExt/search/doc/reference/en/modules/configuration.xml	2007-08-07 16:51:42 UTC (rev 12904)
@@ -327,7 +327,7 @@
     </section>
 
     <section id="jms-backend">
-      <title>JMS Back end</title>
+      <title>JMS Master/Slave configuration</title>
 
       <para>This chapter describes in greater detail how to configure the
       Master / Slaves Hibernate Search architecture.</para>

Modified: trunk/HibernateExt/search/doc/reference/en/modules/getting-started.xml
===================================================================
--- trunk/HibernateExt/search/doc/reference/en/modules/getting-started.xml	2007-08-06 16:47:30 UTC (rev 12903)
+++ trunk/HibernateExt/search/doc/reference/en/modules/getting-started.xml	2007-08-07 16:51:42 UTC (rev 12904)
@@ -28,47 +28,24 @@
 					<row>
 						<entry>Hibernate Search</entry>
 						<entry>
-							Version 3.0.0.Beta4.
+							Version 3.0.0.Beta4 with all its dependencies - hibernate-search.jar, lucene-core-2.2.0.jar, jms.jar, ejb3-persistence.jar and
+							hibernate-commons-annotations.jar
 						</entry>	
-					</row>
-					<row>		
-						<entry>Lucene</entry>
-						<entry>
-							Version 2.2.0. This library is contained in the Hibernate Search zip file.
-						</entry>
-					</row>	
-					<row>		
-						<entry>EJB3 Persistence</entry>
-						<entry>
-							Contained in the Hibernate Search zip file.
-						</entry>
-					</row>	
-					<row>		
-						<entry>JMS</entry>
-						<entry>
-							Contained in the Hibernate Search zip file. Needed for JMS configuration
-							via <classname>org.hibernate.search.store.FSMasterDirectoryProvider</classname>
-							resp. <classname>org.hibernate.search.store.FSSlaveDirectoryProvider</classname>.
-							See <xref linkend="jms-backend"/>.
-						</entry>
-					</row>																								
+					</row>																						
 					<row>
 						<entry>Hibernate Core</entry>
 						<entry>
-							Version >= 3.2.2 with all its dependencies.
+							Version >= 3.2.2 with all its dependencies - hibernate3.jar, ehcache-1.2.3.jar,
+							swarmcache-1.0rc2.jar, jboss-cache.jar, jgroups-2.2.8.jar, jta.jar, commons-logging-1.0.4.jar,
+							c3p0-0.9.1.jar, asm-attrs.jar, dom4j-1.6.1.jar, ant-antlr-1.6.5.jar, cglib-2.1.3.jar,
+							oscache-2.1.jar, asm.jar, commons-collections-2.1.1.jar, ant-1.6.5.jar and proxool-0.8.3.jar.					
 						</entry>
 					</row>
 					<row>
 						<entry>Hibernate Annotations</entry>
 						<entry>
-							Version 3.3x with all its dependencies
+							Version 3.3.x with all its dependencies - hibernate-annotations.jar, ejb3-persistence.jar and jta.jar. 
 						</entry>
-					</row>	
-					<row>		
-						<entry>Hibernate Commons Annotations</entry>
-						<entry>
-							Contained in the Hibernate Search zip file.
-						</entry>
 					</row>										
 				</tbody>
 			</tgroup>
@@ -82,7 +59,7 @@
 	</section>
 
 	<section>
-		<title>Hibernate Configuration</title>
+		<title>Configuration</title>
 		<para>
 		Once you have downloaded and added all required dependencies to your application you have 
 		to add a few properties to your hibernate configuration file. The good
@@ -184,7 +161,7 @@
 	</section>
 	
 	<section>
-		<title>Indexing</title>
+		<title>Inital Indexing</title>
 		<para>
 		Once you have added the above properties and annotations it is time to trigger an
 		initial batch index of your books. You can achieve this by adding the following lines 
@@ -228,4 +205,15 @@
 session.close();	
 		</programlisting>		
 	</section>
+	
+	<section>
+		<title>What's next</title>
+		<para>
+		The above paragraphs hopefully helped you to get started with Hibernate Search. You
+		should have a simple file system based index and be able to search and retrieve a list of
+		your indexed objects via Hibernate Search. The next step is to get more familiar with the 
+		overall architecture and explore more advanced topics like <xref linkend="jms-backend"/> and
+		<xref linkend="search-configuration-directory-sharding"/>.
+		</para>
+	</section>
 </chapter>
\ No newline at end of file

Modified: trunk/HibernateExt/search/doc/reference/en/modules/mapping.xml
===================================================================
--- trunk/HibernateExt/search/doc/reference/en/modules/mapping.xml	2007-08-06 16:47:30 UTC (rev 12903)
+++ trunk/HibernateExt/search/doc/reference/en/modules/mapping.xml	2007-08-07 16:51:42 UTC (rev 12904)
@@ -123,7 +123,7 @@
     </section>
 
     <section>
-      <title>mapping a property multiple times</title>
+      <title>Mapping properties multiple times</title>
 
       <para>It is sometimes needed to map a proeprty multiple times per index,
       with slightly different indexing strategies. Especially, sorting a query




More information about the hibernate-commits mailing list