[hibernate-commits] Hibernate SVN: r16212 - in search/trunk: doc and 8 other directories.

hibernate-commits at lists.jboss.org hibernate-commits at lists.jboss.org
Wed Mar 25 06:53:04 EDT 2009


Author: hardy.ferentschik
Date: 2009-03-25 06:53:03 -0400 (Wed, 25 Mar 2009)
New Revision: 16212

Added:
   search/trunk/src/main/docbook/
   search/trunk/src/main/docbook/en-US/
   search/trunk/src/main/docbook/en-US/images/
   search/trunk/src/main/docbook/en-US/master.xml
   search/trunk/src/main/docbook/en-US/modules/
   search/trunk/src/main/javadoc/
Removed:
   search/trunk/doc/api/
   search/trunk/doc/reference/en/images/
   search/trunk/doc/reference/en/master.xml
   search/trunk/doc/reference/en/modules/
Modified:
   search/trunk/pom.xml
   search/trunk/src/main/assembly/dist.xml
   search/trunk/src/main/docbook/en-US/modules/architecture.xml
   search/trunk/src/main/docbook/en-US/modules/configuration.xml
Log:
HSEARCH-82 Moved the docbook documentation

Deleted: search/trunk/doc/reference/en/master.xml
===================================================================
--- search/trunk/doc/reference/en/master.xml	2009-03-25 10:09:34 UTC (rev 16211)
+++ search/trunk/doc/reference/en/master.xml	2009-03-25 10:53:03 UTC (rev 16212)
@@ -1,92 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--  $Id$ -->
-<!--
-  ~ Hibernate, Relational Persistence for Idiomatic Java
-  ~
-  ~ Copyright (c) 2008, Red Hat Middleware LLC or third-party contributors as
-  ~ indicated by the @author tags or express copyright attribution
-  ~ statements applied by the authors.  All third-party contributions are
-  ~ distributed under license by Red Hat Middleware LLC.
-  ~
-  ~ This copyrighted material is made available to anyone wishing to use, modify,
-  ~ copy, or redistribute it subject to the terms and conditions of the GNU
-  ~ Lesser General Public License, as published by the Free Software Foundation.
-  ~
-  ~ This program is distributed in the hope that it will be useful,
-  ~ but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
-  ~ or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
-  ~ for more details.
-  ~
-  ~ You should have received a copy of the GNU Lesser General Public License
-  ~ along with this distribution; if not, write to:
-  ~ Free Software Foundation, Inc.
-  ~ 51 Franklin Street, Fifth Floor
-  ~ Boston, MA  02110-1301  USA
-  -->
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
-"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY versionNumber "3.1.0.GA">
-<!ENTITY copyrightYear "2004">
-<!ENTITY copyrightHolder "Red Hat Middleware, LLC.">
-]>
-<book lang="en">
-  <bookinfo>
-    <title>Hibernate Search</title>
-
-    <subtitle>Apache <trademark>Lucene</trademark> Integration</subtitle>
-
-    <subtitle>Reference Guide</subtitle>
-
-    <releaseinfo>&versionNumber;</releaseinfo>
-
-    <mediaobject>
-      <imageobject>
-        <imagedata fileref="images/hibernate_logo_a.png" format="PNG" />
-      </imageobject>
-    </mediaobject>
-  </bookinfo>
-
-  <toc></toc>
-
-  <preface id="preface" revision="2">
-    <title>Preface</title>
-
-    <para>Full text search engines like Apache Lucene are very powerful
-    technologies to add efficient free text search capabilities to
-    applications. However, Lucene suffers several mismatches when dealing with
-    object domain model. Amongst other things indexes have to be kept up to
-    date and mismatches between index structure and domain model as well as
-    query mismatches have to be avoided.</para>
-
-    <para>Hibernate Search addresses these shortcomings - it indexes your
-    domain model with the help of a few annotations, takes care of
-    database/index synchronization and brings back regular managed objects
-    from free text queries. To achieve this Hibernate Search is combining the
-    power of <ulink url="http://www.hibernate.org">Hibernate</ulink> and
-    <ulink url="http://lucene.apache.org">Apache Lucene</ulink>.</para>
-  </preface>
-
-  <xi:include href="modules/getting-started.xml"
-              xmlns:xi="http://www.w3.org/2001/XInclude" />
-
-  <xi:include href="modules/architecture.xml"
-              xmlns:xi="http://www.w3.org/2001/XInclude" />
-
-  <xi:include href="modules/configuration.xml"
-              xmlns:xi="http://www.w3.org/2001/XInclude" />
-
-  <xi:include href="modules/mapping.xml"
-              xmlns:xi="http://www.w3.org/2001/XInclude" />
-
-  <xi:include href="modules/query.xml"
-              xmlns:xi="http://www.w3.org/2001/XInclude" />
-
-  <xi:include href="modules/batchindex.xml"
-              xmlns:xi="http://www.w3.org/2001/XInclude" />
-
-  <xi:include href="modules/optimize.xml"
-              xmlns:xi="http://www.w3.org/2001/XInclude" />
-
-  <xi:include href="modules/lucene-native.xml"
-              xmlns:xi="http://www.w3.org/2001/XInclude" />
-</book>

Modified: search/trunk/pom.xml
===================================================================
--- search/trunk/pom.xml	2009-03-25 10:09:34 UTC (rev 16211)
+++ search/trunk/pom.xml	2009-03-25 10:53:03 UTC (rev 16212)
@@ -156,27 +156,25 @@
                 </dependencies>
                 <configuration>
                     <sourceDocumentName>master.xml</sourceDocumentName>
-                    <sourceDirectory>${basedir}/doc/reference/en</sourceDirectory>
+                    <sourceDirectory>${basedir}/src/main/docbook/en-US</sourceDirectory>
                     <masterTranslation>en-US</masterTranslation>
                     <imageResource>
-                        <directory>${basedir}/doc/reference/en/images</directory>
+                        <directory>${basedir}/src/main/docbook/en-US/images</directory>
                     </imageResource>
                     <formats>
                         <format>
                             <formatName>pdf</formatName>
                             <stylesheetResource>classpath:/xslt/hibernate/pdf/main-pdf.xsl</stylesheetResource>
-                            <finalName>hibernate-validator-legacy-guide.pdf</finalName>
+                            <finalName>hibernate-search-guide.pdf</finalName>
                         </format>
                         <format>
                             <formatName>html_single</formatName>
-                            <stylesheetResource>classpath:/xslt/hibernate/html/main-single.xsl
-                            </stylesheetResource>
+                            <stylesheetResource>classpath:/xslt/hibernate/html/main-single.xsl</stylesheetResource>
                             <finalName>index.html</finalName>
                         </format>
                         <format>
                             <formatName>html</formatName>
-                            <stylesheetResource>classpath:/xslt/hibernate/html/main-chunk.xsl
-                            </stylesheetResource>
+                            <stylesheetResource>classpath:/xslt/hibernate/html/main-chunk.xsl</stylesheetResource>
                             <finalName>index.html</finalName>
                         </format>
                     </formats>
@@ -201,7 +199,7 @@
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
                 <configuration>
-                    <stylesheetfile>${basedir}/doc/api/jdstyle.css</stylesheetfile>
+                    <stylesheetfile>${basedir}/src/main/javadoc/jdstyle.css</stylesheetfile>
                 </configuration>
                 <executions>
                     <execution>
@@ -225,7 +223,7 @@
                 <artifactId>maven-release-plugin</artifactId>
                 <configuration>
                     <releaseProfiles>release</releaseProfiles>
-                    <goals>package site assembly:assembly</goals>
+                    <goals>package javadoc:javadoc assembly:assembly</goals>
                 </configuration>
             </plugin>
         </plugins>

Modified: search/trunk/src/main/assembly/dist.xml
===================================================================
--- search/trunk/src/main/assembly/dist.xml	2009-03-25 10:09:34 UTC (rev 16211)
+++ search/trunk/src/main/assembly/dist.xml	2009-03-25 10:53:03 UTC (rev 16212)
@@ -1,23 +1,4 @@
 <?xml version='1.0' encoding='UTF-8'?>
-<!--
-  Licensed to the Apache Software Foundation (ASF) under one
-  or more contributor license agreements.  See the NOTICE file
-  distributed with this work for additional information
-  regarding copyright ownership.  The ASF licenses this file
-  to you under the Apache License, Version 2.0 (the
-  "License"); you may not use this file except in compliance
-  with the License.  You may obtain a copy of the License at
-
-  http://www.apache.org/licenses/LICENSE-2.0
-
-  Unless required by applicable law or agreed to in writing,
-  software distributed under the License is distributed on an
-  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-  KIND, either express or implied.  See the License for the
-  specific language governing permissions and limitations
-  under the License.
--->
-
 <assembly>
     <id>dist</id>
     <formats>
@@ -29,14 +10,9 @@
     <dependencySets>
         <dependencySet>
             <useProjectArtifact>false</useProjectArtifact>
-            <outputDirectory>/dist/lib/runtime</outputDirectory>
+            <outputDirectory>/dist/lib</outputDirectory>
             <scope>runtime</scope>
         </dependencySet>
-        <dependencySet>
-            <useProjectArtifact>false</useProjectArtifact>
-            <outputDirectory>/dist/lib/test</outputDirectory>
-            <scope>test</scope>
-        </dependencySet>
     </dependencySets>
 
     <fileSets>
@@ -64,5 +40,4 @@
             </excludes>
         </fileSet>
     </fileSets>
-
 </assembly>

Copied: search/trunk/src/main/docbook/en-US/images (from rev 16209, search/trunk/doc/reference/en/images)


Property changes on: search/trunk/src/main/docbook/en-US/images
___________________________________________________________________
Name: svn:mergeinfo
   + 

Copied: search/trunk/src/main/docbook/en-US/master.xml (from rev 16209, search/trunk/doc/reference/en/master.xml)
===================================================================
--- search/trunk/src/main/docbook/en-US/master.xml	                        (rev 0)
+++ search/trunk/src/main/docbook/en-US/master.xml	2009-03-25 10:53:03 UTC (rev 16212)
@@ -0,0 +1,98 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--  $Id$ -->
+<!--
+  ~ Hibernate, Relational Persistence for Idiomatic Java
+  ~
+  ~ Copyright (c) 2008, Red Hat Middleware LLC or third-party contributors as
+  ~ indicated by the @author tags or express copyright attribution
+  ~ statements applied by the authors.  All third-party contributions are
+  ~ distributed under license by Red Hat Middleware LLC.
+  ~
+  ~ This copyrighted material is made available to anyone wishing to use, modify,
+  ~ copy, or redistribute it subject to the terms and conditions of the GNU
+  ~ Lesser General Public License, as published by the Free Software Foundation.
+  ~
+  ~ This program is distributed in the hope that it will be useful,
+  ~ but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+  ~ or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
+  ~ for more details.
+  ~
+  ~ You should have received a copy of the GNU Lesser General Public License
+  ~ along with this distribution; if not, write to:
+  ~ Free Software Foundation, Inc.
+  ~ 51 Franklin Street, Fifth Floor
+  ~ Boston, MA  02110-1301  USA
+  -->
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY versionNumber "3.1.0.GA">
+<!ENTITY copyrightYear "2004">
+<!ENTITY copyrightHolder "Red Hat Middleware, LLC.">
+]>
+<book lang="en">
+  <bookinfo>
+    <title>Hibernate Search</title>
+
+    <subtitle>Apache <trademark>Lucene</trademark> Integration</subtitle>
+
+    <subtitle>Reference Guide</subtitle>
+
+    <releaseinfo>&versionNumber;</releaseinfo>
+
+
+              <mediaobject>
+                          <imageobject role="fo">
+                                      <imagedata align="center" fileref="hibernate_logo_a.png" />
+                          </imageobject>
+                          
+                          <imageobject role="html">
+                                      <imagedata depth="3cm" fileref="hibernate_logo_a.png" />
+                          </imageobject>
+              </mediaobject>
+              
+  </bookinfo>
+
+  <toc></toc>
+
+  <preface id="preface" revision="2">
+    <title>Preface</title>
+
+    <para>Full text search engines like Apache Lucene are very powerful
+    technologies to add efficient free text search capabilities to
+    applications. However, Lucene suffers several mismatches when dealing with
+    object domain model. Amongst other things indexes have to be kept up to
+    date and mismatches between index structure and domain model as well as
+    query mismatches have to be avoided.</para>
+
+    <para>Hibernate Search addresses these shortcomings - it indexes your
+    domain model with the help of a few annotations, takes care of
+    database/index synchronization and brings back regular managed objects
+    from free text queries. To achieve this Hibernate Search is combining the
+    power of <ulink url="http://www.hibernate.org">Hibernate</ulink> and
+    <ulink url="http://lucene.apache.org">Apache Lucene</ulink>.</para>
+  </preface>
+
+  <xi:include href="modules/getting-started.xml"
+              xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+  <xi:include href="modules/architecture.xml"
+              xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+  <xi:include href="modules/configuration.xml"
+              xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+  <xi:include href="modules/mapping.xml"
+              xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+  <xi:include href="modules/query.xml"
+              xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+  <xi:include href="modules/batchindex.xml"
+              xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+  <xi:include href="modules/optimize.xml"
+              xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+  <xi:include href="modules/lucene-native.xml"
+              xmlns:xi="http://www.w3.org/2001/XInclude" />
+</book>


Property changes on: search/trunk/src/main/docbook/en-US/master.xml
___________________________________________________________________
Name: svn:keywords
   + Id
Name: svn:mergeinfo
   + 
Name: svn:eol-style
   + native

Copied: search/trunk/src/main/docbook/en-US/modules (from rev 16209, search/trunk/doc/reference/en/modules)


Property changes on: search/trunk/src/main/docbook/en-US/modules
___________________________________________________________________
Name: svn:mergeinfo
   + 

Modified: search/trunk/src/main/docbook/en-US/modules/architecture.xml
===================================================================
--- search/trunk/doc/reference/en/modules/architecture.xml	2009-03-24 18:19:27 UTC (rev 16209)
+++ search/trunk/src/main/docbook/en-US/modules/architecture.xml	2009-03-25 10:53:03 UTC (rev 16212)
@@ -120,12 +120,12 @@
         <mediaobject>
           <imageobject role="html">
             <imagedata align="center"
-                       fileref="../shared/images/lucene-backend.png"
+                       fileref="lucene-backend.png"
                        format="PNG" />
           </imageobject>
 
           <imageobject role="fo">
-            <imagedata align="center" fileref="images/lucene-backend.png"
+            <imagedata align="center" fileref="lucene-backend.png"
                        format="PNG" />
           </imageobject>
 
@@ -157,11 +157,11 @@
         <mediaobject>
           <imageobject role="html">
             <imagedata align="center"
-                       fileref="../shared/images/jms-backend.png" format="PNG" />
+                       fileref="jms-backend.png" format="PNG" />
           </imageobject>
 
           <imageobject role="fo">
-            <imagedata align="center" fileref="images/jms-backend.png"
+            <imagedata align="center" fileref="jms-backend.png"
                        format="PNG" />
           </imageobject>
 

Modified: search/trunk/src/main/docbook/en-US/modules/configuration.xml
===================================================================
--- search/trunk/doc/reference/en/modules/configuration.xml	2009-03-24 18:19:27 UTC (rev 16209)
+++ search/trunk/src/main/docbook/en-US/modules/configuration.xml	2009-03-25 10:53:03 UTC (rev 16212)
@@ -431,12 +431,12 @@
 
     <para><mediaobject>
         <imageobject role="html">
-          <imagedata align="center" fileref="../shared/images/jms-backend.png"
+          <imagedata align="center" fileref="jms-backend.png"
                      format="PNG" />
         </imageobject>
 
         <imageobject role="fo">
-          <imagedata align="center" fileref="images/jms-backend.png"
+          <imagedata align="center" fileref="jms-backend.png"
                      format="PNG" />
         </imageobject>
 

Copied: search/trunk/src/main/javadoc (from rev 16209, search/trunk/doc/api)


Property changes on: search/trunk/src/main/javadoc
___________________________________________________________________
Name: svn:mergeinfo
   + 




More information about the hibernate-commits mailing list