Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

'added publican compatibility to envers docs' 

git-svn-id: https://svn.jboss.org/repos/hibernate/core/trunk@18778 1b8cb986-b30d-0410-93ca-fae66ebed9b2
This commit is contained in:
Richard Wilding 2010-02-11 07:27:00 +00:00
parent 19758fe9c2
commit bdc3b50493
18 changed files with 173 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
documentation/envers/pom.xml
View File

@ -23,7 +23,7 @@
<groupId>org.jboss.maven.plugins</groupId>
<artifactId>maven-jdocbook-plugin</artifactId>
<configuration>
<sourceDocumentName>Envers_Reference.xml</sourceDocumentName>
<sourceDocumentName>Hibernate_Envers_-_Easy_Entity_Auditing.xml</sourceDocumentName>
<masterTranslation>en-US</masterTranslation>
<imageResource>
<directory>${basedir}/src/main/docbook/en-US</directory>

22
documentation/envers/src/main/docbook/en-US/Book_Info.xml Normal file
View File

@ -0,0 +1,22 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "Hibernate_Envers_-_Easy_Entity_Auditing.ent">
%BOOK_ENTITIES;
]>
<bookinfo id="Hibernate_Envers_-_Easy_Entity_Auditing.xml">
<title>Hibernate Envers - Easy Entity Auditing</title>
<subtitle>Hibernate Envers Reference Documentation</subtitle>
<releaseinfo>&versionNumber;</releaseinfo>
<edition>1.0</edition>
<pubsnumber>1</pubsnumber>
<productname>JBoss Hibernate Envers</productname>
<productnumber>&versionNumber;</productnumber>
<issuenum>1</issuenum>
<copyright>
<year>&copyrightYear;</year>
<holder>&copyrightHolder;</holder>
</copyright>
<xi:include href="legal_notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<!-- include translators... -->
</bookinfo>

5
documentation/envers/src/main/docbook/en-US/Hibernate_Envers_-_Easy_Entity_Auditing.ent Normal file
View File

@ -0,0 +1,5 @@
<!ENTITY versionNumber "3.3.0.GA">
<!ENTITY today "TODAY">
<!ENTITY copyrightYear "2004">
<!ENTITY copyrightHolder "Red Hat Middleware, LLC.">
<!ENTITY semi ";">

63
documentation/envers/src/main/docbook/en-US/Hibernate_Envers_-_Easy_Entity_Auditing.xml Normal file
View File

@ -0,0 +1,63 @@
<?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 % BOOK_ENTITIES SYSTEM "Hibernate_Envers_-_Easy_Entity_Auditing.ent">
%BOOK_ENTITIES;
]>
<book>
<!--
<bookinfo>
<title>Hibernate Envers - Easy Entity Auditing</title>
<subtitle>Hibernate Envers Reference Documentation</subtitle>
<releaseinfo>&versionNumber;</releaseinfo>
<productnumber>&versionNumber;</productnumber>
<issuenum>1</issuenum>
<copyright>
<year>&copyrightYear;</year>
<holder>&copyrightHolder;</holder>
</copyright>
<xi:include href="legal_notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<!- include translators... ->
</bookinfo>
<toc/>
-->
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="content/preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="content/quickstart.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="content/example.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="content/configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="content/revisionlog.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="content/queries.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="content/schema.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="content/tables.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="content/source.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="content/exceptions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="content/migration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="content/links.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>

5
documentation/envers/src/main/docbook/en-US/content/configuration.xml
View File

@ -23,7 +23,10 @@
~ 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">
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "../Hibernate_Envers_-_Easy_Entity_Auditing.ent">
%BOOK_ENTITIES;
]>
<chapter id="configuration">

7
documentation/envers/src/main/docbook/en-US/content/example.xml
View File

@ -23,7 +23,10 @@
~ 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">
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "../Hibernate_Envers_-_Easy_Entity_Auditing.ent">
%BOOK_ENTITIES;
]>
<chapter id="example">
@ -83,4 +86,4 @@ assert address1_rev1.getPersons().getSize() == 1;
// and so on</programlisting>
</chapter>
</chapter>

17
documentation/envers/src/main/docbook/en-US/content/exceptions.xml
View File

@ -23,12 +23,15 @@
~ 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">
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "../Hibernate_Envers_-_Easy_Entity_Auditing.ent">
%BOOK_ENTITIES;
]>
<chapter id="exceptions">
<title>Mapping exceptions</title>
<sect1 id="exceptions-wontbesupported">
<section id="exceptions-wontbesupported">
<title>What isn't and will not be supported</title>
@ -59,9 +62,9 @@
</listitem>
</orderedlist>
</sect1>
</section>
<sect1 id="exceptions-willbesupported" revision="2">
<section id="exceptions-willbesupported" revision="2">
<title>What isn't and <emphasis>will</emphasis> be supported</title>
@ -73,9 +76,9 @@
</listitem>
</orderedlist>
</sect1>
</section>
<sect1 id="exceptions-onetomanyjoincolumn" revision="3">
<section id="exceptions-onetomanyjoincolumn" revision="3">
<title><literal>@OneToMany</literal>+<literal>@JoinColumn</literal></title>
@ -106,6 +109,6 @@
Envers works. Please note that the annotation is experimental and may change in the future.
</para>
</sect1>
</section>
</chapter>

5
documentation/envers/src/main/docbook/en-US/content/links.xml
View File

@ -23,7 +23,10 @@
~ 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">
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "../Hibernate_Envers_-_Easy_Entity_Auditing.ent">
%BOOK_ENTITIES;
]>
<chapter id="links">
<title>Links</title>

17
documentation/envers/src/main/docbook/en-US/content/migration.xml
View File

@ -23,7 +23,10 @@
~ 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">
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "../Hibernate_Envers_-_Easy_Entity_Auditing.ent">
%BOOK_ENTITIES;
]>
<chapter id="migration">
<title>Migration from Envers standalone</title>
@ -39,7 +42,7 @@
with Oracle and other databases, which don't allow tables and field names to start with "_".
</para>
<sect1 id="migrations-code">
<section id="migrations-code">
<title>Changes to code</title>
@ -54,9 +57,9 @@
projections and order. Please refer to the Javadoc for further details.
</para>
</sect1>
</section>
<sect1 id="migrations-configuration">
<section id="migrations-configuration">
<title>Changes to configuration</title>
@ -111,9 +114,9 @@
See <xref linkend="configuration"/> for details on the configuration and a description of the
configuration options.
</para>
</sect1>
</section>
<sect1 id="migrations-revisionlog">
<section id="migrations-revisionlog">
<title>Changes to the revision entity</title>
@ -153,5 +156,5 @@ public class ExampleRevEntity {
// Getters, setters, equals, hashCode ...
}]]></programlisting>
</sect1>
</section>
</chapter>

7
documentation/envers/src/main/docbook/en-US/content/preface.xml
View File

@ -23,7 +23,10 @@
~ Boston, MA 02110-1301 USA
-->
<!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "../Hibernate_Envers_-_Easy_Entity_Auditing.ent">
%BOOK_ENTITIES;
]>
<preface id="preface">
<title>Preface</title>
@ -80,4 +83,4 @@
</para>
</listitem>
</orderedlist>
</preface>
</preface>

21
documentation/envers/src/main/docbook/en-US/content/queries.xml
View File

@ -23,7 +23,10 @@
~ 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">
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "../Hibernate_Envers_-_Easy_Entity_Auditing.ent">
%BOOK_ENTITIES;
]>
<chapter id="queries">
@ -55,7 +58,7 @@
than corresponding queries on "live" data, as they involve correlated subselects.
</para>
<sect1 id="entities-at-revision">
<section id="entities-at-revision">
<title>Querying for entities of a class at a given revision</title>
@ -101,9 +104,9 @@ query.add(AuditEntity.relatedId("address").eq(relatedEntityId));]]></programlist
.setMaxResults(2)
.getResultList();]]></programlisting>
</sect1>
</section>
<sect1 id="revisions-of-entity">
<section id="revisions-of-entity">
<title>Querying for revisions, at which entities of a given class changed</title>
@ -121,17 +124,23 @@ query.add(AuditEntity.relatedId("address").eq(relatedEntityId));]]></programlist
<orderedlist>
<listitem>
<para>
using <literal>AuditEntity.revisionNumber()</literal> you can specify constraints, projections
and order on the revision number, in which the audited entity was modified
</para>
</listitem>
<listitem>
<para>
similarly, using <literal>AuditEntity.revisionProperty(propertyName)</literal> you can specify constraints,
projections and order on a property of the revision entity, corresponding to the revision
in which the audited entity was modified
</para>
</listitem>
<listitem>
<para>
<literal>AuditEntity.revisionType()</literal> gives you access as above to the type of
the revision (ADD, MOD, DEL).
</para>
</listitem>
</orderedlist>
@ -198,6 +207,6 @@ query.add(AuditEntity.relatedId("address").eq(relatedEntityId));]]></programlist
<literal>null</literal>.
</para>
</sect1>
</section>
</chapter>
</chapter>

5
documentation/envers/src/main/docbook/en-US/content/quickstart.xml
View File

@ -23,7 +23,10 @@
~ 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">
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "../Hibernate_Envers_-_Easy_Entity_Auditing.ent">
%BOOK_ENTITIES;
]>
<chapter id="quickstart">
<title>Quickstart</title>

5
documentation/envers/src/main/docbook/en-US/content/revisionlog.xml
View File

@ -23,7 +23,10 @@
~ 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">
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "../Hibernate_Envers_-_Easy_Entity_Auditing.ent">
%BOOK_ENTITIES;
]>
<chapter id="revisionlog">

5
documentation/envers/src/main/docbook/en-US/content/schema.xml
View File

@ -23,7 +23,10 @@
~ 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">
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "../Hibernate_Envers_-_Easy_Entity_Auditing.ent">
%BOOK_ENTITIES;
]>
<chapter id="schema">
<title>Generating schema with Ant</title>

4
documentation/envers/src/main/docbook/en-US/content/source.xml
View File

@ -23,7 +23,9 @@
~ 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">
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "../Hibernate_Envers_-_Easy_Entity_Auditing.ent">
]>
<chapter id="source">
<title>Building from source and testing</title>

5
documentation/envers/src/main/docbook/en-US/content/tables.xml
View File

@ -23,7 +23,10 @@
~ 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">
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "../Hibernate_Envers_-_Easy_Entity_Auditing.ent">
%BOOK_ENTITIES;
]>
<chapter id="tables">
<title>Generated tables and their content</title>

5
documentation/envers/src/main/docbook/en-US/legal_notice.xml
View File

@ -22,7 +22,10 @@
~ 51 Franklin Street, Fifth Floor
~ Boston, MA 02110-1301 USA
-->
<!DOCTYPE legalnotice PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "Hibernate_Envers_-_Easy_Entity_Auditing.ent">
%BOOK_ENTITIES;
]>
<legalnotice id="Legal_Notice">
<title>Legal Notice</title>

6
documentation/envers/src/main/docbook/publican.cfg Normal file
View File

@ -0,0 +1,6 @@
# Config::Simple 4.59
# Wed Dec 9 09:53:51 2009
debug: 1
xml_lang: en-US
brand: jboss-community-hibernate