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

HHH-4951 - Correct DTD entities for injecting version and date into docs 

git-svn-id: https://svn.jboss.org/repos/hibernate/core/trunk@18876 1b8cb986-b30d-0410-93ca-fae66ebed9b2
This commit is contained in:
Steve Ebersole 2010-02-25 03:20:01 +00:00
parent 09fe22710e
commit be58b6b386
10 changed files with 55 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
annotations/src/main/docbook/en/master.xml
View File

@ -2,10 +2,10 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ Copyright (c) 2008, Red Hat Middleware LLC or third-party contributors as
~ Copyright (c) 2010, Red Hat Inc. 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.
~ distributed under license by Red Hat Inc.
~
~ 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
@ -23,17 +23,18 @@
~ 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.5.0.GA">
<!ENTITY version "WORKING">
<!ENTITY today "TODAY">
<!ENTITY copyrightYear "2004">
<!ENTITY copyrightHolder "Red Hat Inc. and the various authors">
]>
<book lang="en">
<bookinfo>
<title>Hibernate Annotations</title>
<subtitle>Reference Guide</subtitle>
<releaseinfo>&versionNumber;</releaseinfo>
<releaseinfo>&version;</releaseinfo>
<pubdate>&today;</pubdate>
<mediaobject>
<imageobject>

5
annotations/src/main/docbook/fr/master.xml
View File

@ -6,6 +6,8 @@
<!ENTITY xml-overriding SYSTEM "modules/xml-overriding.xml">
<!ENTITY validator SYSTEM "modules/validator.xml">
<!ENTITY lucene SYSTEM "modules/lucene.xml">
<!ENTITY version "WORKING">
<!ENTITY today "TODAY">
]>
<book lang="fr">
<bookinfo>
@ -13,7 +15,8 @@
<subtitle>Guide de référence</subtitle>
<releaseinfo>3.2.0.GA</releaseinfo>
<releaseinfo>&version;</releaseinfo>
<pubdate>&today;</pubdate>
<mediaobject>
<imageobject>

5
annotations/src/main/docbook/zh_cn/master.xml
View File

@ -6,6 +6,8 @@
<!ENTITY xml-overriding SYSTEM "modules/xml-overriding.xml">
<!ENTITY validator SYSTEM "modules/validator.xml">
<!ENTITY lucene SYSTEM "modules/lucene.xml">
<!ENTITY version "WORKING">
<!ENTITY today "TODAY">
]>
<book lang="zh_cn">
<bookinfo>
@ -13,7 +15,8 @@
<subtitle>参考文档</subtitle>
<releaseinfo>3.2.0 CR1</releaseinfo>
<releaseinfo>&version;</releaseinfo>
<pubdate>&today;</pubdate>
<mediaobject>
<imageobject>

11
documentation/envers/src/main/docbook/en-US/Book_Info.xml
View File

@ -1,4 +1,4 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE bookinfo 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;
]>
@ -7,11 +7,12 @@
<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>
<releaseinfo>&version;</releaseinfo>
<pubdate>&today;</pubdate>
<edition>1.0</edition>
<pubsnumber>1</pubsnumber>
<productname>JBoss Hibernate Envers</productname>
<productnumber>&versionNumber;</productnumber>
<productnumber>&version;</productnumber>
<issuenum>1</issuenum>
<copyright>
<year>&copyrightYear;</year>

4
documentation/envers/src/main/docbook/en-US/Hibernate_Envers_-_Easy_Entity_Auditing.ent
View File

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

6
documentation/manual/src/main/docbook/en-US/Book_Info.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "HIBERNATE_-_Relational_Persistence_for_Idiomatic_Java.ent">
%BOOK_ENTITIES;
]>
@ -7,11 +7,11 @@
<bookinfo id="HIBERNATE_-_Relational_Persistence_for_Idiomatic_Java">
<title>HIBERNATE - Relational Persistence for Idiomatic Java</title>
<subtitle>Hibernate Reference Documentation</subtitle>
<releaseinfo>&versionNumber;</releaseinfo>
<releaseinfo>&version;</releaseinfo>
<edition>1.0</edition>
<pubsnumber>1</pubsnumber>
<productname>JBoss Hibernate Core</productname>
<productnumber>&versionNumber;</productnumber>
<productnumber>&version;</productnumber>
<pubdate>&today;</pubdate>
<issuenum>1</issuenum>
<mediaobject>

2
documentation/manual/src/main/docbook/en-US/HIBERNATE_-_Relational_Persistence_for_Idiomatic_Java.ent
View File

@ -1,4 +1,4 @@
<!ENTITY versionNumber "WORKING">
<!ENTITY version "WORKING">
<!ENTITY today "TODAY">
<!ENTITY copyrightYear "2004">
<!ENTITY copyrightHolder "Red Hat, Inc.">

7
entitymanager/src/main/docbook/en/master.xml
View File

@ -23,7 +23,8 @@
~ 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 "WORKING">
<!ENTITY version "WORKING">
<!ENTITY today "TODAY">
]>
<book>
@ -31,11 +32,11 @@
<bookinfo>
<title>Hibernate EntityManager</title>
<subtitle>User guide</subtitle>
<releaseinfo>&versionNumber;</releaseinfo>
<releaseinfo>&version;</releaseinfo>
<edition>1.0</edition>
<pubsnumber>1</pubsnumber>
<pubdate>&today;</pubdate>
<productnumber>&versionNumber;</productnumber>
<productnumber>&version;</productnumber>
<issuenum>1</issuenum>
<mediaobject>
<imageobject>

35
entitymanager/src/main/docbook/en/modules/metamodel.xml
View File

@ -23,10 +23,7 @@
~ 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" [
<!ENTITY jpa2Ref '<xref linkend="JPA2"/>'>
<!ENTITY jpa2Cite '<citation>&jpa2Ref;</citation>'>
<!ENTITY criteriaRef '<xref linkend="querycriteria"/>'>
<!ENTITY apt '<ulink url="http://java.sun.com/javase/6/docs/technotes/tools/solaris/javac.html#processing">annotation processor</ulink>'>
<!ENTITY aptUrl 'http://java.sun.com/javase/6/docs/technotes/tools/solaris/javac.html#processing'>
]>
<chapter id="metamodel">
@ -35,8 +32,9 @@
<note>
<para>
The Metamodel itself is described in <citetitle pubwork="chapter">Chapter 5 Metamodel API</citetitle>
of the &jpa2Cite;. <citetitle pubwork="chapter">Chapter 6 Criteria API</citetitle> of the &jpa2Cite;
describes and shows uses of the metamodel in criteria queries, as does &criteriaRef;.
of the <citation><xref linkend="JPA2"/></citation>. <citetitle pubwork="chapter">Chapter 6 Criteria API</citetitle>
of the <citation><xref linkend="JPA2"/></citation> describes and shows uses of the metamodel in criteria
queries, as does <xref linkend="querycriteria"/>.
</para>
</note>
@ -68,11 +66,12 @@
<para>
Second, from an application writer's perspective, it allows very fluent expression of completely type-safe
criteria queries, especially the <emphasis>Static Metamodel</emphasis> approach. The &jpa2Cite; defines a
number of ways the metamodel can be accessed and used, including the <emphasis>Static Metamodel</emphasis>
approach, which we will look at later. The <emphasis>Static Metamodel</emphasis> approach is wonderful
when the code has <ulink url="http://en.wikipedia.org/wiki/A_priori_and_a_posteriori">a priori knowledge</ulink>
of the domain model. &criteriaRef; uses this approach exclusively in its examples.
criteria queries, especially the <emphasis>Static Metamodel</emphasis> approach. The
<citation><xref linkend="JPA2"/></citation> defines a number of ways the metamodel can be accessed and used,
including the <emphasis>Static Metamodel</emphasis> approach, which we will look at later.
The <emphasis>Static Metamodel</emphasis> approach is wonderful when the code has
<ulink url="http://en.wikipedia.org/wiki/A_priori_and_a_posteriori">a priori knowledge</ulink> of the domain
model. <xref linkend="querycriteria"/> uses this approach exclusively in its examples.
</para>
<section id="metamodel-static">
@ -80,12 +79,13 @@
<para>
A <emphasis>static metamodel</emphasis> is a series of classes that "mirror" the entities and embeddables
in the domain model and provide static access to the metadata about the mirrored class's attributes. We
will exclusively discuss what the &jpa2Cite; terms a <emphasis>Canonical Metamodel</emphasis>:
will exclusively discuss what the <citation><xref linkend="JPA2"/></citation> terms a
<emphasis>Canonical Metamodel</emphasis>:
</para>
<blockquote>
<attribution>
<citation>&jpa2Ref;, section 6.2.1.1, pp 198-199</citation>
<citation><xref linkend="JPA2"/>, section 6.2.1.1, pp 198-199</citation>
</attribution>
<para>
<itemizedlist>
@ -222,9 +222,10 @@ public class Person_ {
<note>
<para>
These canonical metamodel classes can be generated manually if you wish though it is expected
that most developers will prefer use of an &apt;. Although annotation processors themselves are
beyond the scope of this document, the Hibernate team does develop an annotation processor tool for
generating a canonical metamodel. See <citetitle>Hibernate Metamodel Generator</citetitle>.
that most developers will prefer use of an <ulink url="&aptUrl;">annotation processor</ulink>.
Annotation processors themselves are beyond the scope of this document. However, the Hibernate team
does develop an annotation processor tool for generating a canonical metamodel.
See <citetitle>Hibernate Metamodel Generator</citetitle>.
</para>
</note>
@ -232,7 +233,7 @@ public class Person_ {
When the Hibernate <interfacename>EntityManagerFactory</interfacename> is being built, it will
look for a canonical metamodel class for each of the managed typed is knows about and if it finds
any it will inject the appropriate metamodel information into them, as outlined in
<citation>&jpa2Ref;, section 6.2.2, pg 200</citation>
<citation><xref linkend="JPA2"/>, section 6.2.2, pg 200</citation>
</para>
</section>

18
entitymanager/src/main/docbook/en/modules/query_criteria.xml
View File

@ -22,11 +22,7 @@
~ 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" [
<!ENTITY jpa2Ref '<xref linkend="JPA2"/>'>
<!ENTITY jpa2Cite '<citation>&jpa2Ref;</citation>'>
<!ENTITY staticMetamodelRef '<xref linkend="metamodel-static"/>'>
]>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" []>
<chapter id="querycriteria">
<title>Criteria Queries</title>
@ -70,10 +66,10 @@
<note>
<para>
<citetitle pubwork="chapter">Chapter 6 Criteria API</citetitle> of the &jpa2Cite; already contains a
decent amount of reference material pertaining to the various parts of a criteria query. So rather
than duplicate all that content here, lets instead look at some of the more widely anticipated usages
of the API.
<citetitle pubwork="chapter">Chapter 6 Criteria API</citetitle> of the <citation><xref linkend="JPA2"/></citation>
already contains a decent amount of reference material pertaining to the various parts of a criteria query.
So rather than duplicate all that content here, lets instead look at some of the more widely anticipated
usages of the API.
</para>
</note>
@ -129,7 +125,7 @@ for ( Person person : people ) { ... }]]></programlisting>
<para>
<emphasis>Person_.eyeColor</emphasis> is an example of the static form of metamodel
reference. We will use that form exclusively in this chapter.
See &staticMetamodelRef; for details.
See <xref linkend="metamodel-static"/> for details.
</para>
</callout>
</calloutlist>
@ -491,7 +487,7 @@ for ( Tuple tuple : valueArray ) {
<title>FROM clause</title>
<blockquote>
<attribution>
<citation>&jpa2Ref;, section 6.5.2 Query Roots, pg 262</citation>
<citation><xref linkend="JPA2"/>, section 6.5.2 Query Roots, pg 262</citation>
</attribution>
<para>
A CriteriaQuery object defines a query over one or more entity, embeddable, or basic abstract