5:57 a.m.
Author: hardy.ferentschik
Date: 2008-10-31 06:57:35 -0400 (Fri, 31 Oct 2008)
New Revision: 15457
Added:
core/trunk/annotations/src/main/docbook/
core/trunk/annotations/src/main/docbook/en/
core/trunk/annotations/src/main/docbook/fr/
core/trunk/annotations/src/main/docbook/zh_cn/
Removed:
core/trunk/annotations/doc/reference/en/
core/trunk/annotations/doc/reference/fr/
core/trunk/annotations/doc/reference/zh_cn/
core/trunk/annotations/src/main/docbook/en/styles/
core/trunk/annotations/src/main/docbook/fr/styles/
core/trunk/annotations/src/main/docbook/zh_cn/styles/
Modified:
core/trunk/annotations/pom.xml
core/trunk/annotations/src/main/docbook/en/master.xml
core/trunk/annotations/src/main/docbook/en/modules/additionalmodules.xml
core/trunk/annotations/src/main/docbook/en/modules/entity.xml
core/trunk/annotations/src/main/docbook/en/modules/setup.xml
core/trunk/annotations/src/main/docbook/en/modules/xml-overriding.xml
Log:
make the documentation buildable via maven as well. In the long run we will have to
combine all the documentation though
Modified: core/trunk/annotations/pom.xml
===================================================================
--- core/trunk/annotations/pom.xml 2008-10-31 10:26:47 UTC (rev 15456)
+++ core/trunk/annotations/pom.xml 2008-10-31 10:57:35 UTC (rev 15457)
@@ -134,6 +134,70 @@
<profiles>
+ <profile>
+ <id>doc</id>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.1.0</version>
+ <extensions>true</extensions>
+ <dependencies>
+ <dependency>
+ <groupId>org.hibernate</groupId>
+
<artifactId>hibernate-jdocbook-style</artifactId>
+ <version>1.0.2</version>
+ <type>jdocbook-style</type>
+ </dependency>
+ </dependencies>
+ <configuration>
+
<sourceDocumentName>master.xml</sourceDocumentName>
+
<sourceDirectory>${basedir}/src/main/docbook/en</sourceDirectory>
+ <masterTranslation>en-US</masterTranslation>
+ <imageResource>
+
<directory>${basedir}/src/main/docbook/en/images</directory>
+ </imageResource>
+ <formats>
+ <format>
+ <formatName>pdf</formatName>
+
<stylesheetResource>classpath:/xslt/hibernate/pdf/main-pdf.xsl</stylesheetResource>
+
<finalName>hibernate-validator-legacy-guide.pdf</finalName>
+ </format>
+ <format>
+ <formatName>html_single</formatName>
+
<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>
+ <finalName>index.html</finalName>
+ </format>
+ </formats>
+ <options>
+ <xincludeSupported>true</xincludeSupported>
+ <localeSeparator>-</localeSeparator>
+
<useRelativeImageUris>true</useRelativeImageUris>
+ </options>
+ </configuration>
+ <executions>
+ <execution>
+ <id>make-doc</id>
+ <phase>package</phase>
+ <goals>
+ <goal>resources</goal>
+ <goal>generate</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
+
<!-- HSQLDB is the default (eventually move to H2) -->
<profile>
<id>hsqldb</id>
Copied: core/trunk/annotations/src/main/docbook/en (from rev 15436,
core/trunk/annotations/doc/reference/en)
Property changes on: core/trunk/annotations/src/main/docbook/en
___________________________________________________________________
Name: svn:mergeinfo
+
Modified: core/trunk/annotations/src/main/docbook/en/master.xml
===================================================================
--- core/trunk/annotations/doc/reference/en/master.xml 2008-10-29 16:34:25 UTC (rev
15436)
+++ core/trunk/annotations/src/main/docbook/en/master.xml 2008-10-31 10:57:35 UTC (rev
15457)
@@ -1,10 +1,31 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN"
-"../support/docbook-dtd/docbookx.dtd" [
-<!ENTITY setup SYSTEM "modules/setup.xml">
-<!ENTITY entity SYSTEM "modules/entity.xml">
-<!ENTITY xml-overriding SYSTEM "modules/xml-overriding.xml">
-<!ENTITY additionalmodules SYSTEM "modules/additionalmodules.xml">
+<?xml version='1.0' encoding="UTF-8"?>
+<!--
+ ~ 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.4.0.GA">
+ <!ENTITY copyrightYear "2004">
+ <!ENTITY copyrightHolder "Red Hat Middleware, LLC.">
]>
<book lang="en">
<bookinfo>
@@ -12,7 +33,7 @@
<subtitle>Reference Guide</subtitle>
- <releaseinfo>3.4.0.GA</releaseinfo>
+ <releaseinfo>&versionNumber;</releaseinfo>
<mediaobject>
<imageobject>
@@ -21,7 +42,7 @@
</mediaobject>
</bookinfo>
- <toc></toc>
+ <toc/>
<preface id="preface" revision="1">
<title>Preface</title>
@@ -67,11 +88,9 @@
Persistence migration guide</ulink>.</para>
</preface>
- &setup;
-
- &entity;
-
- &xml-overriding;
-
- &additionalmodules;
+ <xi:include href="modules/setup.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="modules/entity.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="modules/xml-overriding.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="modules/additionalmodules.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+
</book>
\ No newline at end of file
Modified: core/trunk/annotations/src/main/docbook/en/modules/additionalmodules.xml
===================================================================
--- core/trunk/annotations/doc/reference/en/modules/additionalmodules.xml 2008-10-29
16:34:25 UTC (rev 15436)
+++ core/trunk/annotations/src/main/docbook/en/modules/additionalmodules.xml 2008-10-31
10:57:35 UTC (rev 15457)
@@ -1,4 +1,29 @@
-<?xml version="1.0" encoding="UTF-8"?>
+<?xml version='1.0' encoding="UTF-8"?>
+<!--
+ ~ 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 chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<chapter id="additionalmodules">
<title>Additional modules</title>
Modified: core/trunk/annotations/src/main/docbook/en/modules/entity.xml
===================================================================
--- core/trunk/annotations/doc/reference/en/modules/entity.xml 2008-10-29 16:34:25 UTC
(rev 15436)
+++ core/trunk/annotations/src/main/docbook/en/modules/entity.xml 2008-10-31 10:57:35 UTC
(rev 15457)
@@ -1,4 +1,29 @@
-<?xml version="1.0" encoding="UTF-8"?>
+<?xml version='1.0' encoding="UTF-8"?>
+<!--
+ ~ 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 chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<chapter id="entity">
<title>Entity Beans</title>
Modified: core/trunk/annotations/src/main/docbook/en/modules/setup.xml
===================================================================
--- core/trunk/annotations/doc/reference/en/modules/setup.xml 2008-10-29 16:34:25 UTC (rev
15436)
+++ core/trunk/annotations/src/main/docbook/en/modules/setup.xml 2008-10-31 10:57:35 UTC
(rev 15457)
@@ -1,4 +1,29 @@
-<?xml version="1.0" encoding="UTF-8"?>
+<?xml version='1.0' encoding="UTF-8"?>
+<!--
+ ~ 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 chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<chapter>
<title id="setup" revision="1">Setting up an annotations
project</title>
Modified: core/trunk/annotations/src/main/docbook/en/modules/xml-overriding.xml
===================================================================
--- core/trunk/annotations/doc/reference/en/modules/xml-overriding.xml 2008-10-29 16:34:25
UTC (rev 15436)
+++ core/trunk/annotations/src/main/docbook/en/modules/xml-overriding.xml 2008-10-31
10:57:35 UTC (rev 15457)
@@ -1,4 +1,29 @@
-<?xml version="1.0" encoding="UTF-8"?>
+<?xml version='1.0' encoding="UTF-8"?>
+<!--
+ ~ 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 chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<chapter id="xml-overriding" label="Overriding metadata through
XML">
<title>Overriding metadata through XML</title>
Copied: core/trunk/annotations/src/main/docbook/fr (from rev 15436,
core/trunk/annotations/doc/reference/fr)
Property changes on: core/trunk/annotations/src/main/docbook/fr
___________________________________________________________________
Name: svn:mergeinfo
+
Copied: core/trunk/annotations/src/main/docbook/zh_cn (from rev 15436,
core/trunk/annotations/doc/reference/zh_cn)
Property changes on: core/trunk/annotations/src/main/docbook/zh_cn
___________________________________________________________________
Name: svn:mergeinfo
+