10:36 a.m.
Author: hardy.ferentschik
Date: 2010-05-03 11:36:41 -0400 (Mon, 03 May 2010)
New Revision: 19352
Modified:
search/trunk/hibernate-search-archetype/pom.xml
search/trunk/hibernate-search/pom.xml
search/trunk/hibernate-search/src/main/docbook/en-US/master.xml
search/trunk/hibernate-search/src/main/docbook/en-US/modules/getting-started.xml
Log:
HSEARCH-486 - Updated the getting started section. Removed the mention of the archetype
which is not really a problem given that we cannot deploy the archetype catalog for now
anyways
Modified: search/trunk/hibernate-search/pom.xml
===================================================================
--- search/trunk/hibernate-search/pom.xml 2010-05-03 14:33:56 UTC (rev 19351)
+++ search/trunk/hibernate-search/pom.xml 2010-05-03 15:36:41 UTC (rev 19352)
@@ -184,6 +184,9 @@
<docbookVersion>1.72.0</docbookVersion>
<localeSeparator>-</localeSeparator>
</options>
+ <profiling>
+ <enabled>true</enabled>
+ </profiling>
</configuration>
</plugin>
<plugin>
Modified: search/trunk/hibernate-search/src/main/docbook/en-US/master.xml
===================================================================
--- search/trunk/hibernate-search/src/main/docbook/en-US/master.xml 2010-05-03 14:33:56
UTC (rev 19351)
+++ search/trunk/hibernate-search/src/main/docbook/en-US/master.xml 2010-05-03 15:36:41
UTC (rev 19352)
@@ -29,7 +29,7 @@
<!ENTITY copyrightYear "2004">
<!ENTITY copyrightHolder "Red Hat Middleware, LLC.">
]>
-<book lang="en">
+<book>
<bookinfo>
<title>Hibernate Search</title>
Modified:
search/trunk/hibernate-search/src/main/docbook/en-US/modules/getting-started.xml
===================================================================
---
search/trunk/hibernate-search/src/main/docbook/en-US/modules/getting-started.xml 2010-05-03
14:33:56 UTC (rev 19351)
+++
search/trunk/hibernate-search/src/main/docbook/en-US/modules/getting-started.xml 2010-05-03
15:36:41 UTC (rev 19352)
@@ -25,7 +25,7 @@
-->
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY version "WORKING">
+<!ENTITY version "3.2.0.Final">
]>
<chapter id="getting-started">
<title>Getting started</title>
@@ -98,21 +98,64 @@
<para>Instead of managing all dependencies manually, maven users have the
possibility to use the <ulink
- url="http://repository.jboss.com/maven2">JBoss maven
repository</ulink>.
- Just add the JBoss repository url to the
<emphasis>repositories</emphasis>
- section of your <filename>pom.xml</filename> or
- <filename>settings.xml</filename>:</para>
+ url="https://repository.jboss.org/nexus/content/groups/public/"...
+ maven repository</ulink>. Add the following to your Maven
+ <filename>settings.xml file</filename> (see also <ulink
+ url="http://community.jboss.org/wiki/MavenGettingStarted-Users"...
+ Getting Started</ulink>):</para>
<example>
<title>Adding the JBoss maven repository to
<filename>settings.xml</filename></title>
- <programlisting><repository>
- <id>repository.jboss.org</id>
- <name>JBoss Maven Repository</name>
- <url>http://repository.jboss.org/maven2</url>
- <layout>default</layout>
-</repository> </programlisting>
+ <programlisting><settings>
+ ...
+ <profiles>
+ ...
+ <profile>
+ <id>jboss-public-repository</id>
+ <repositories>
+ <repository>
+ <id>jboss-public-repository-group</id>
+ <name>JBoss Public Maven Repository Group</name>
+
<url>https://repository.jboss.org/nexus/content/groups/public/</url>
+ <layout>default</layout>
+ <releases>
+ <enabled>true</enabled>
+ <updatePolicy>never</updatePolicy>
+ </releases>
+ <snapshots>
+ <enabled>true</enabled>
+ <updatePolicy>never</updatePolicy>
+ </snapshots>
+ </repository>
+ </repositories>
+ <pluginRepositories>
+ <pluginRepository>
+ <id>jboss-public-repository-group</id>
+ <name>JBoss Public Maven Repository Group</name>
+
<url>https://repository.jboss.org/nexus/content/groups/public/</url>
+ <layout>default</layout>
+ <releases>
+ <enabled>true</enabled>
+ <updatePolicy>never</updatePolicy>
+ </releases>
+ <snapshots>
+ <enabled>true</enabled>
+ <updatePolicy>never</updatePolicy>
+ </snapshots>
+ </pluginRepository>
+ </pluginRepositories>
+ </profile>
+
+ </profiles>
+
+ <activeProfiles>
+ <activeProfile>jboss-public-repository</activeProfile>
+ </activeProfiles>
+ ...
+</settings>
+ </programlisting>
</example>
<para>Then add the following dependencies to your pom.xml:</para>
@@ -132,28 +175,19 @@
</dependency></programlisting>
</example>
- <para>Not all dependencies are required. Only the
- <emphasis>hibernate-search</emphasis> dependency is mandatory. This
- dependency, together with its required transitive dependencies, contain
- all required classes needed to use Hibernate Search.</para>
+ <para>Only the <emphasis>hibernate-search</emphasis> dependency is
+ mandatory, because it contains together with its required transitive
+ dependencies all required classes needed to use Hibernate
+ Search.<emphasis> hibernate-entitymanager</emphasis> is only required if
+ you want to use Hibernate Search in conjunction with JPA.</para>
- <para><emphasis>hibernate-annotations</emphasis> is needed if you
want to
- use annotations to configure your domain model but don't want to use JPA's
- runtime APIs. If you choose not to use Hibernate Annotations and describe
- your ORM mapping using <filename>cfg.xml</filename> files, you still
have
- to use the Hibernate Search specific annotations, which are bundled with
- the hibernate-search jar file, to configure your Lucene index. There is no
- XML configuration available for Hibernate Search but we provide a powerful
- programmatic mapping API that elegantly replace this kind of deployment
- descriptor (see <xref linkend="hsearch-mapping-programmaticapi" />
for
- more information).</para>
-
- <para><emphasis>hibernate-entitymanager</emphasis> is required if
you want
- to use Hibernate Search in conjunction with JPA.</para>
-
- <para>And finally, you might want to add optional dependencies related to
- Lucene (if you use some of the contribs of Lucene). By default, we add
- lucene-snowball and lucene-analyzers as dependencies.</para>
+ <para><note>
+ <para>There is no XML configuration available for Hibernate Search but
+ we provide a powerful programmatic mapping API that elegantly replace
+ this kind of deployment form (see <xref
+ linkend="hsearch-mapping-programmaticapi" /> for more
+ information).</para>
+ </note></para>
</section>
<section>
@@ -374,12 +408,12 @@
<title>Indexing</title>
<para>Hibernate Search will transparently index every entity persisted,
- updated or removed through Hibernate Core. However, you have to trigger an
- initial indexing to populate the Lucene index with the data already
- present in your database. 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 using one of the following code snippets (see also
- <xref linkend="search-batchindex" />):</para>
+ updated or removed through Hibernate Core. However, you have to create an
+ initial Lucene index for the data already present in your database. 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 using one of
+ the following code snippets (see also <xref
+ linkend="search-batchindex" />):</para>
<example>
<title>Using Hibernate Session to index data</title>
@@ -562,27 +596,8 @@
<section>
<title>What's next</title>
- <para>The above paragraphs hopefully helped you getting an overview of
- Hibernate Search. Using the maven archetype plugin and the following
- command you can create an initial runnable maven project structure
- populated with the example code of this tutorial.</para>
-
- <example>
- <title>Using the Maven archetype to create tutorial sources</title>
-
- <programlisting>mvn archetype:create \
- -DarchetypeGroupId=org.hibernate \
- -DarchetypeArtifactId=hibernate-search-quickstart \
- -DarchetypeVersion=&version; \
- -DgroupId=my.company -DartifactId=quickstart</programlisting>
- </example>
-
- <para>Using the maven project you can execute the examples, inspect the
- file system based index and search and retrieve a list of managed objects.
- Just run <emphasis>mvn package</emphasis> to compile the sources and run
- the unit tests.</para>
-
- <para>The next step after this tutorial is to get more familiar with the
+ <para>The above paragraphs helped you getting an overview of Hibernate
+ Search. The next step after this tutorial is to get more familiar with the
overall architecture of Hibernate Search (<xref
linkend="search-architecture" />) and explore the basic features in
more
detail. Two topics which were only briefly touched in this tutorial were
Modified: search/trunk/hibernate-search-archetype/pom.xml
===================================================================
--- search/trunk/hibernate-search-archetype/pom.xml 2010-05-03 14:33:56 UTC (rev 19351)
+++ search/trunk/hibernate-search-archetype/pom.xml 2010-05-03 15:36:41 UTC (rev 19352)
@@ -32,40 +32,6 @@
<artifactId>hibernate-entitymanager</artifactId>
</dependency>
<dependency>
- <groupId>org.apache.solr</groupId>
- <artifactId>solr-core</artifactId>
- <exclusions>
- <exclusion>
- <groupId>commons-httpclient</groupId>
- <artifactId>commons-httpclient</artifactId>
- </exclusion>
- <exclusion>
- <groupId>woodstox</groupId>
- <artifactId>wstx-asl</artifactId>
- </exclusion>
- <exclusion>
- <groupId>net.java.dev.stax-utils</groupId>
- <artifactId>stax-utils</artifactId>
- </exclusion>
- <exclusion>
- <groupId>commons-logging</groupId>
- <artifactId>commons-logging</artifactId>
- </exclusion>
- <exclusion>
- <groupId>org.apache.solr</groupId>
- <artifactId>solr-lucene-core</artifactId>
- </exclusion>
- </exclusions>
- </dependency>
- <dependency>
- <groupId>org.apache.lucene</groupId>
- <artifactId>lucene-snowball</artifactId>
- </dependency>
- <dependency>
- <groupId>org.apache.lucene</groupId>
- <artifactId>lucene-analyzers</artifactId>
- </dependency>
- <dependency>
<groupId>hsqldb</groupId>
<artifactId>hsqldb</artifactId>
<version>1.8.0.2</version>