Author: max.andersen(a)jboss.com Date: 2006-12-14 14:10:37 -0500 (Thu, 14 Dec 2006) New Revision: 10994 Added: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consolecfgclasspath.gif branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consolecfgclasspath.png branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consolecfgmappings.gif branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consolecfgmappings.png Modified: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/codegendropdown.gif branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/codegenexporters.gif branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/codegenmaintab.gif branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consolecfgwizard.gif branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consoleoutline-before-reveng.gif branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/hibernatecfgwizard.gif branches/Branch_3_2/HibernateExt/tools/doc/reference/en/master.xml branches/Branch_3_2/HibernateExt/tools/doc/reference/en/modules/codegenarchitecture.xml branches/Branch_3_2/HibernateExt/tools/doc/reference/en/modules/plugins.xml branches/Branch_3_2/HibernateExt/tools/doc/reference/en/modules/setup.xml Log: HBX-838 update docs for simplified ui Modified: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/codegendropdown.gif =================================================================== (Binary files differ) Modified: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/codegenexporters.gif =================================================================== (Binary files differ) Modified: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/codegenmaintab.gif =================================================================== (Binary files differ) Added: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consolecfgclasspath.gif =================================================================== (Binary files differ) Property changes on: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consolecfgclasspath.gif ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consolecfgclasspath.png =================================================================== (Binary files differ) Property changes on: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consolecfgclasspath.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consolecfgmappings.gif =================================================================== (Binary files differ) Property changes on: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consolecfgmappings.gif ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consolecfgmappings.png =================================================================== (Binary files differ) Property changes on: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consolecfgmappings.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consolecfgwizard.gif =================================================================== (Binary files differ) Modified: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consoleoutline-before-reveng.gif =================================================================== (Binary files differ) Modified: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/hibernatecfgwizard.gif =================================================================== (Binary files differ) Modified: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/master.xml =================================================================== --- branches/Branch_3_2/HibernateExt/tools/doc/reference/en/master.xml 2006-12-14 15:06:36 UTC (rev 10993) +++ branches/Branch_3_2/HibernateExt/tools/doc/reference/en/master.xml 2006-12-14 19:10:37 UTC (rev 10994) @@ -14,8 +14,8 @@ <subtitle>Reference Guide</subtitle> - <releaseinfo>3.2.0.beta8</releaseinfo> - + <releaseinfo>3.2.0.beta9</releaseinfo> + <mediaobject> <imageobject> <imagedata fileref="images/hibernate_logo_a.png" format="PNG" /> Modified: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/modules/codegenarchitecture.xml =================================================================== --- branches/Branch_3_2/HibernateExt/tools/doc/reference/en/modules/codegenarchitecture.xml 2006-12-14 15:06:36 UTC (rev 10993) +++ branches/Branch_3_2/HibernateExt/tools/doc/reference/en/modules/codegenarchitecture.xml 2006-12-14 19:10:37 UTC (rev 10994) @@ -1,4 +1,4 @@ -<?xml version="1.0" encoding="ISO-8859-1"?> +<?xml version="1.0" encoding="UTF-8"?> <chapter id="codegenarchitecture"> <title>Code generation architecture</title> @@ -17,12 +17,49 @@ build a session factory.</para> <para>The model represented by the <literal>Configuration</literal> class - can be build in many ways. The best known is by using hbm.xml files to - describe the meta model, other methods are using annotations in java - source code and a third is reading JDBC metadata and build a - configuration. The last method is provided via the reverse engineering - part of the hibernate tools.</para> + can be build in many ways. The following list the currently supported ones + in Hibernate Tools. </para> + <para><itemizedlist> + <listitem> + <para>A <emphasis>Core configuration</emphasis> uses Hibernate Core + and supports reading hbm.xml files, requires a hibernate.cfg.xml. + Named core in Eclipse and <literal>&lt;configuration&gt;</literal> + in ant.</para> + </listitem> + + <listitem> + <para>A <emphasis>Annotation configuration</emphasis> uses Hibernate + Annotations and supports hbm.xml and annotated classes, requires a + hibernate.cfg.xml. Named annotations in Eclipse and + <literal>&lt;annotationconfiguration&gt;</literal> in ant.</para> + </listitem> + + <listitem> + <para>A <emphasis>JPA configuration</emphasis> uses a Hibernate + EntityManager and supports hbm.xml and annotated classes requires + that the project has a META-INF/persistence.xml in its classpath. + Named JPA in Eclipse and <literal>&lt;jpaconfiguration&gt;</literal> + in ant.</para> + </listitem> + + <listitem> + <para>A <emphasis>JDBC configuration</emphasis> uses Hibernate Tools + reverse engineering and reads its mappings via JDBC metadata + + additional reverse engineering files (reveng.xml). Automatically + used in Eclipse when doing reverse engineering from JDBC and named + <literal>&lt;jdbcconfiguration&gt;</literal> in ant.</para> + </listitem> + </itemizedlist></para> + + <para>In most projects you will normally use only one of the Core, + Annotation or JPA configuration and possibly the JDBC configuration if you + are using the reverse engineering facilities of Hibernate Tools. The + important thing to note is that no matter which Hibnerate Configuration + type you are using Hibernate Tools supports them.</para> + + <para>The following drawing illustrates the core concepts:</para> + <para><mediaobject> <imageobject role="fo"> <imagedata fileref="images/architecture.png" format="PNG" /> @@ -34,10 +71,10 @@ </imageobject> </mediaobject></para> - <para>The code generation is done based on this model no matter which - method have been used to create the meta model, and thus the code - generation is independent on the source of the meta model and represented - via Exporters.</para> + <para>The code generation is done based on the Configuration model no + matter which type of configuration have been used to create the meta + model, and thus the code generation is independent on the source of the + meta model and represented via Exporters.</para> </section> <section> @@ -54,9 +91,6 @@ <para>Users can provide their own customer Exporter's, either by custom classes implementing the Exporter interface or simply be providing custom - templates. This is documented at <xref linkend="hbmtemplate"/></para> - - <para>NOTICE: This release uses Velocity for the templates. The next - release might move to an alternative template engine.</para> + templates. This is documented at <xref linkend="hbmtemplate" /></para> </section> </chapter> \ No newline at end of file Modified: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/modules/plugins.xml =================================================================== --- branches/Branch_3_2/HibernateExt/tools/doc/reference/en/modules/plugins.xml 2006-12-14 15:06:36 UTC (rev 10993) +++ branches/Branch_3_2/HibernateExt/tools/doc/reference/en/modules/plugins.xml 2006-12-14 19:10:37 UTC (rev 10994) @@ -1,4 +1,4 @@ -<?xml version="1.0" encoding="ISO-8859-1"?> +<?xml version="1.0" encoding="UTF-8"?> <chapter id="plugins"> <title>Eclipse Plugins</title> @@ -16,9 +16,9 @@ and property/field names, making it much more versatile than a normal XML editor.</para> - <para><emphasis role="bold">Hibernate Console:</emphasis> The console is a - new perspetive in Eclipse. It provides an overview of your Hibernate - Console configurations, were also get an interactive view of your + <para><emphasis role="bold">Hibernate Console</emphasis>: The console is a + new perspective in Eclipse. It provides an overview of your Hibernate + Console configurations, were you also can get an interactive view of your persistent classes and their relationships. The console allows you to execute HQL queries against your database and browse the result directly in Eclipse.</para> @@ -31,6 +31,12 @@ engineer an existing database schema and use the code generation to generate POJO source files and Hibernate mapping files.</para> + <para><emphasis role="bold">Eclipse JDT integration</emphasis>: Hibernate + Tools integrates into the Java code completion and build support of Java + in Eclipse. This gives you codecompletion of HQL inside Java code plus + Hibernate Tools will add problem markers if your queries are not valid + against the console configuration associated with the project.</para> + <para>Please note that these tools do not try to hide any functionality of Hibernate. The tools make working with Hibernate easier, but you are still encouraged/required to read the documentation for Hibernate to fully @@ -41,8 +47,8 @@ <title>Creating a Hibernate configuration file</title> <para>To be able to reverse engineer, prototype queries, and of course to - simply use Hibernate a hibernate.properties or hibernate.cfg.xml file is - needed. The Hibernate Tools provide a wizard for generating the + simply use Hibernate Core a hibernate.properties or hibernate.cfg.xml file + is needed. The Hibernate Tools provide a wizard for generating the hibernate.cfg.xml file if you do not already have such file.</para> <para>Start the wizard by clicking "New Wizard" (Ctrl+N), select the @@ -52,7 +58,8 @@ <mediaobject> <imageobject role="fo"> - <imagedata fileref="images/hibernatecfgwizard.gif" format="GIF" contentwidth="5cm" /> + <imagedata contentwidth="5cm" fileref="images/hibernatecfgwizard.gif" + format="GIF" /> </imageobject> <imageobject role="html"> @@ -81,17 +88,26 @@ <section> <title>Creating a Hibernate Console configuration</title> - <para>A Console Configuration describes to the Hibernate plugin which configuration files should be used to configure hibernate, including which classpath is needed to load the POJO's, JDBC drivers etc. It is required to make usage of query prototyping, reverse engineering and code generation. You can have multiple named console configurations. Normally you would just need one per project, but more (or less) is definitly possible. </para> + <para>A Console Configuration describes to the Hibernate plugin how it + should configure Hibernate and what configuration files, including which + classpath is needed to load the POJO's, JDBC drivers etc. It is required + to make usage of query prototyping, reverse engineering and code + generation. You can have multiple named console configurations. Normally + you would just need one per project, but more is definitly + possible.</para> <para>You create a console configuration by running the Console Configuration wizard, shown in the following screenshot. The same wizard will also be used if you are coming from the hibernate.cfg.xml wizard and had enabled "Create Console Configuration".</para> - + <para>Tip: the wizard will look at the current selection in the IDE and + try and auto-detect the settings which you then can just approve or modify + to suit your needs.</para> + <para></para> + <mediaobject> - <imageobject role="fo"> <imagedata fileref="images/consolecfgwizard.gif" format="GIF" /> </imageobject> @@ -101,17 +117,21 @@ fileref="../shared/images/consolecfgwizard.gif" format="GIF" /> </imageobject> - <caption>Creating a Hibernate Console configuration</caption> + + <caption>Creating a Hibernate Console configuration</caption> </mediaobject> - + <para>The dialog consists of three tabs, "General" for the basic/required + settings, "Classpath" for classpath and "Mappings" for additional + mappings. The two latter ones is normally not required if you specify a + project and it has <literal> /hibernate.cfg.xml </literal>or + <literal>/META-INF/persistence.xml</literal> in its project + classpath.</para> <para>The following table describes the available settings. The wizard can automatically detect default values for most of these if you started the - Wizard with the relevant java project selected</para> + Wizard with the relevant java project or resource selected</para> - - <table> <title>Hibernate Console Configuration Parameters</title> @@ -124,150 +144,211 @@ <thead> <row> - <entry align="center"> - <para>Parameter</para> - </entry> + <entry align="center"><para>Parameter</para></entry> - <entry align="center"> - <para>Description</para> - </entry> + <entry align="center"><para>Description</para></entry> - <entry align="center"> - <para>Auto detected value</para> - </entry> + <entry align="center"><para>Auto detected value</para></entry> </row> </thead> <tbody> <row> - <entry> - <para>Name</para> - </entry> + <entry><para>Name</para></entry> - <entry> - <para>The unique name of the configuration</para> - </entry> + <entry><para>The unique name of the console + configuration</para></entry> - <entry> - <para>Name of the selected project</para> - </entry> + <entry><para>Name of the selected project</para></entry> </row> <row> - <entry> - <para>Property file</para> - </entry> + <entry>Project</entry> - <entry> - <para>Path to a hibernate.properties file</para> - </entry> + <entry>The name of a java project which classpath should be used + in the console configuration</entry> - <entry> - <para>First hibernate.properties file found in the selected - project</para> - </entry> + <entry>Name of the selected project</entry> </row> <row> - <entry> - <para>Configuration file</para> - </entry> + <entry>Type</entry> - <entry> - <para>Path to a hibernate.cfg.xml file</para> - </entry> + <entry>Choose between "Core", "Annotations" and "JPA". Note that + the two latter requires running Eclipse IDE with a JDK 5 runtime, + otherwise you will get classloading and/or version errors.</entry> - <entry> - <para>First hibernate.cfg.xml file found in the selected - project</para> - </entry> + <entry>No default value</entry> </row> <row> - <entry> - <para>Entity resolver</para> - </entry> + <entry><para>Property file</para></entry> - <entry> - <para>Fully qualified classname of a custom EntityResolver. Only - required if you have special xml entity includes in your mapping - files.</para> - </entry> + <entry><para>Path to a hibernate.properties file</para></entry> - <entry> - <para>No default value</para> - </entry> + <entry><para>First hibernate.properties file found in the selected + project</para></entry> </row> <row> - <entry> - <para>Enable Hibernate ejb3/annotations</para> - </entry> + <entry><para>Configuration file</para></entry> - <entry> - <para>Selecting this option enables usage of annotated classes. - hbm.xml files are of course still possible to use too. This - feature requires running the Eclipse IDE with a JDK 5 runtime, - otherwise you will get classloading and/or version - errors.</para> - </entry> + <entry><para>Path to a hibernate.cfg.xml file</para></entry> - <entry> - <para>Not enabled</para> - </entry> + <entry><para>First hibernate.cfg.xml file found in the selected + project</para></entry> </row> <row> - <entry> - <para>Mapping files</para> - </entry> + <entry>Persistence unit</entry> - <entry> - <para>List of additional mapping files that should be loaded. - Note: A hibernate.cfg.xml can also contain mappings. Thus if - these a duplicated here, you will get "Duplicate mapping" errors - when using the console configuration.</para> - </entry> + <entry>Name of the persistence unit to use</entry> - <entry> - <para>If no hibernate.cfg.xml file is found, all hbm.xml files - found in the selected project</para> - </entry> + <entry>No default value (lets Hibernate Entity Manager find the + persistence unit)</entry> </row> <row> - <entry> - <para>Classpath</para> - </entry> + <entry>Naming strategy</entry> - <entry> - <para>The classpath for loading POJO and JDBC drivers. Do not - add Hibernate core libraries or dependencies, they are already - included. If you get ClassNotFound errors then check this list - for possible missing or redundant directories/jars.</para> - </entry> + <entry>Fully qualified classname of a custom NamingStrategy. Only + required if you use a special naming strategy.</entry> - <entry> - <para>The default build output directory and any JARs with a - class implementing java.sql.Driver in the selected - project</para> - </entry> + <entry>No default value</entry> </row> + + <row> + <entry><para>Entity resolver</para></entry> + + <entry><para>Fully qualified classname of a custom EntityResolver. + Only required if you have special xml entity includes in your + mapping files.</para></entry> + + <entry><para>No default value</para></entry> + </row> </tbody> </tgroup> </table> - + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/consolecfgclasspath.gif" + format="GIF" /> + </imageobject> + <imageobject role="html"> + <imagedata align="center" + fileref="../shared/images/consolecfgclasspath.gif" + format="GIF" /> + </imageobject> + + <caption>Specifying classpath in a Hibernate Console + configuration</caption> + </mediaobject> + + <para><table> + <title>Hibernate Console Configuration Classpath</title> + + <tgroup cols="3"> + <colspec colnum="1" colwidth="1*" /> + + <colspec colnum="2" colwidth="3*" /> + + <colspec colnum="3" colwidth="1*" /> + + <thead> + <row> + <entry align="center"><para>Parameter</para></entry> + + <entry align="center"><para>Description</para></entry> + + <entry align="center"><para>Auto detected value</para></entry> + </row> + </thead> + + <tbody> + <row> + <entry><para>Classpath</para></entry> + + <entry><para>The classpath for loading POJO and JDBC drivers; + only needed if the default classpath of the Project does not + contain the required classes. Do not add Hibernate core + libraries or dependencies, they are already included. If you get + ClassNotFound errors then check this list for possible missing + or redundant directories/jars.</para></entry> + + <entry><para>empty</para></entry> + </row> + + <row> + <entry><para>Include default classpath from + project</para></entry> + + <entry><para>When enabled the project classpath will be appended + to the classpath specified above.</para></entry> + + <entry><para>Enabled</para></entry> + </row> + </tbody> + </tgroup> + </table></para> + + <para><mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/consolecfgmappings.gif" + format="GIF" /> + </imageobject> + + <imageobject role="html"> + <imagedata align="center" + fileref="../shared/images/consolecfgmappings.gif" + format="GIF" /> + </imageobject> + + <caption>Specifying additional mappings in a Hibernate console + configuration</caption> + </mediaobject><table> + <title>Hibernate Console Configuration Mappings</title> + + <tgroup cols="3"> + <colspec colnum="1" colwidth="1*" /> + + <colspec colnum="2" colwidth="3*" /> + + <colspec colnum="3" colwidth="1*" /> + + <thead> + <row> + <entry align="center"><para>Parameter</para></entry> + + <entry align="center"><para>Description</para></entry> + + <entry align="center"><para>Auto detected value</para></entry> + </row> + </thead> + + <tbody> + <row> + <entry><para>Mapping files </para></entry> + + <entry><para>List of additional mapping files that should be + loaded. Note: A hibernate.cfg.xml or persistence.xml can also + contain mappings. Thus if these are duplicated here, you will + get "Duplicate mapping" errors when using the console + configuration.</para></entry> + + <entry><para>empty</para></entry> + </row> + </tbody> + </tgroup> + </table></para> + <para>Clicking "Finish" creates the configuration and shows it in the "Hibernate Configurations" view</para> - - - <mediaobject> - + <mediaobject> <imageobject role="fo"> - <imagedata align="center" + <imagedata align="center" fileref="images/consoleoutline-before-reveng.gif" format="GIF" /> </imageobject> @@ -277,23 +358,20 @@ fileref="../shared/images/consoleoutline-before-reveng.gif" format="GIF" /> </imageobject> - - <caption>Console overview</caption> + + <caption>Console overview</caption> </mediaobject> - - </section> <section> <title>Reverse engineering and code generation</title> - <para>A very simple "click-and-generate" reverse engineering and code - generation facility is also available. This facility allows you to - generate a range of artifacts based on database or an already existing - Hibernate configuration, be that mapping files or annotations. Some of - these are POJO Java source file, Hibernate *.hbm.xml, hibernate.cfg.xml - generation and even the option for generating the skeleton for a full Seam - CRUD application.</para> + <para>A "click-and-generate" reverse engineering and code generation + facility is available. This facility allows you to generate a range of + artifacts based on database or an already existing Hibernate + configuration, be that mapping files or annotated classes. Some of these + are POJO Java source file, Hibernate *.hbm.xml, hibernate.cfg.xml + generation and schema documentation.</para> <para>To start working with this process, start the "Hibernate Code Generation" which is available in the toolbar via the Hibernate icon or @@ -318,10 +396,7 @@ </imageobject> </mediaobject> - <para>The dialog has the standard tabs "Refresh" and "Common" that can - be used to configure which directories should be automatically refreshed - and various general settings launchers, such as saving them in a project - for sharing the launcher within a team.</para> + <para></para> <mediaobject> <imageobject role="fo"> @@ -344,8 +419,13 @@ exporter on the Exporter tab. When an exporter has been selected the warning will disappear.</para> - <para>On the "Main" tab you the following fields:</para> + <para>The dialog also have the standard tabs "Refresh" and "Common" that + can be used to configure which directories should be automatically + refreshed and various general settings launchers, such as saving them in + a project for sharing the launcher within a team.</para> + <para>On the "Main" tab you see the following fields:</para> + <table> <title>Code generation "Main" tab fields</title> @@ -438,18 +518,34 @@ </row> <row> + <entry>Detect optimistic lock columns</entry> + + <entry>Automatically detect optimistic lock columns. + Controllable via reveng. strategy; the current default is to use + columns named VERSION or TIMESTAMP.</entry> + </row> + + <row> + <entry>Detect many-to-many tables</entry> + + <entry>Automatically detect many-to-many tables. Controllable + via reveng. strategy.</entry> + </row> + + <row> <entry><para>Use custom templates</para></entry> <entry><para>If enabled, the Template directory will be searched - first when looking up the templates, allowing you to - redefine how the individual templates process the hibernate - mapping model.</para></entry> + first when looking up the templates, allowing you to redefine + how the individual templates process the hibernate mapping + model.</para></entry> </row> <row> <entry><para>Template directory</para></entry> - <entry><para>A path to a directory with custom templates.</para></entry> + <entry><para>A path to a directory with custom + templates.</para></entry> </row> </tbody> </tgroup> @@ -486,8 +582,6 @@ <colspec colnum="2" colwidth="3*" /> - <colspec colnum="3" colwidth="0.5*" /> - <thead> <row> <entry align="center"><para>Field</para></entry> @@ -506,20 +600,6 @@ </row> <row> - <entry><para>JDK 1.5 constructs</para></entry> - - <entry><para>When enabled the POJO's will use JDK 1.5 - constructs.</para></entry> - </row> - - <row> - <entry><para>EJB3/JSR-220 annotations</para></entry> - - <entry><para>When enabled the POJO's will be annotated according - to the EJB3/JSR-220 persistency specification.</para></entry> - </row> - - <row> <entry><para>DAO code</para></entry> <entry><para>Generates a set of DAO's for each entity @@ -549,7 +629,7 @@ </row> <row> - <entry><para>Generate JBoss Seam skeleton app [Beta]</para></entry> + <entry><para>JBoss Seam skeleton app [Beta]</para></entry> <entry><para>Generates a complete JBoss Seam skeleton app. The generation will include annotated POJO's, Seam controller beans @@ -557,11 +637,58 @@ readme.txt for how to use it. </para><para>Note: this exporter generates a full application, including a build.xml thus you will get the best results if you use an output directory which - is the root of your project.</para></entry> + is the root of your project.</para><para>Currently this + generation is the old style of CRUD generation for Seam 1.0. If + you use Seam 1.1 seam-gen is more apropriate and + uptodate.</para></entry> </row> </tbody> </tgroup> </table> + + <para>Each exporter listens to certain properties and these can be setup + in the "Properties" section where you can add/remove predefined or + customer properties for each of the exporters. The following table lists + the time of writing pre-defined properties:</para> + + <para><table> + <title>Exporter Properties</title> + + <tgroup cols="2"> + <colspec colnum="1" colwidth="1*" /> + + <colspec colnum="2" colwidth="3*" /> + + <thead> + <row> + <entry align="center"><para>Name</para></entry> + + <entry align="center"><para>Description</para></entry> + </row> + </thead> + + <tbody> + <row> + <entry><para>jdk5</para></entry> + + <entry><para>Generate Java 5 syntax</para></entry> + </row> + + <row> + <entry><para>ejb3</para></entry> + + <entry><para>Generate EJB 3 annotations</para></entry> + </row> + + <row> + <entry><para>dot.executable</para></entry> + + <entry><para>executable to run GraphViz (only relevant, but + optional for Schema documentation)</para></entry> + </row> + </tbody> + </tgroup> + </table></para> </section> </section> @@ -696,7 +823,7 @@ <para>Note that not all the features of the .reveng.xml file is exposed or fully implemented in the editor, but the main functionallity is there. To understand the full flexibility of the reveng.xml, please see <xref - linkend="hibernaterevengxmlfile"/></para> + linkend="hibernaterevengxmlfile" /></para> <para>The editor is activated as soon as an .reveng.xml file is opened. To get an initial reveng.xml file the reveng.xml wizard can be started via @@ -776,39 +903,32 @@ you need to create a console configuration.</para> <section> - - <title>Viewing the entity structure</title> <para>To view your new configuration and entity/class structure, expand the Hibernate Console configuration by clicking on the + icon.</para> - - <para>Clicking on the small <literal>+</literal> symbol allows you to browse the class/entity structure and see the relationships.</para> - -<para> - <mediaobject> - <imageobject role="fo"> - <imagedata fileref="images/queryconsole.png" /> - </imageobject> + <para><mediaobject> + <imageobject role="fo"> + <imagedata fileref="images/queryconsole.png" /> + </imageobject> - <imageobject role="html"> - <imagedata align="center" - fileref="../shared/images/queryconsole.png" /> - </imageobject> - </mediaobject> + <imageobject role="html"> + <imagedata align="center" + fileref="../shared/images/queryconsole.png" /> + </imageobject> + </mediaobject> Hibernate Console perspective showing entity structure, + query editor and result</para> - Hibernate Console perspective showing entity structure, query editor and result -</para> <section> <title>Class Diagram</title> <para>A class diagram is available in the view named "Hibernate Entity - Model". It will show the model when the Configuration node in a Hibernate Console - Configuration is selected.</para> + Model". It will show the model when the Configuration node in a + Hibernate Console Configuration is selected.</para> <mediaobject> <imageobject role="fo"> @@ -821,11 +941,10 @@ </imageobject> </mediaobject> - <para>This view supports zoom in/out and can also be printed. Zooming is done via the toolbar buttons in the view - and printing is done by selecting the view and choose File/Print or use the Print Icon.</para> + <para>This view supports zoom in/out and can also be printed. Zooming + is done via the toolbar buttons in the view and printing is done by + selecting the view and choose File/Print or use the Print Icon.</para> </section> - - </section> <section> Modified: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/modules/setup.xml =================================================================== --- branches/Branch_3_2/HibernateExt/tools/doc/reference/en/modules/setup.xml 2006-12-14 15:06:36 UTC (rev 10993) +++ branches/Branch_3_2/HibernateExt/tools/doc/reference/en/modules/setup.xml 2006-12-14 19:10:37 UTC (rev 10994) @@ -3,14 +3,14 @@ <title>Download and install Hibernate Tools</title> <para>Hibernate tools can be used "standalone" via Ant 1.6.x or fully - integrated into a Eclipse 3.1.x based IDE, such as JBoss Eclipse IDE or a - default Eclipse 3.1.x installation. The following describes the install + integrated into a Eclipse 3.2.x based IDE, such as JBoss Eclipse IDE or a + default Eclipse 3.2.x installation. The following describes the install steps in these environments.</para> <section> <title>JBoss Eclipse IDE</title> - <para>JBoss Eclipse IDE 1.5.x includes Hibernate Tools and thus nothing is + <para>JBoss Eclipse IDE 2.x includes Hibernate Tools and thus nothing is required besides downloading and installing JBoss Eclipse IDE. If you need to update to a newer version of the Hibernate Tools just follow the instructions in the Eclipse IDE section.</para> @@ -19,10 +19,10 @@ <section> <title>Eclipse IDE</title> - <para>To install into any Eclipse 3.1.x based Eclipse IDE you can either + <para>To install into any Eclipse 3.2.x based Eclipse IDE you can either download the Hibernate Tools distribution from the Hibernate website or - use the Eclipse updatesite (see http://tools.hibernate.org for download - links).</para> + use the JBoss IDE Eclipse update site (see http://tools.hibernate.org for + links to the update site).</para> <para>If you download the Hibernate Tools distribution you need to place the /plugins and /feature directory into your eclipse directory or eclipse @@ -41,11 +41,11 @@ <section> <title>Usage of Eclipse WTP</title> - <para>The Hibernate tools plugins currently uses WTP 1.0 which at this + <para>The Hibernate tools plugins currently uses WTP 1.5.x which at this time is the latest stable release from the Eclipse Webtools project.</para> - <para>Because the WTP project have not proper versioned their plugins + <para>Because the WTP project not always have had proper versioning of their plugins there might exist WTP plugins in your existing eclipse directory from other Eclipse based projects that are from an earlier WTP release but has either the same version number or higher. It is thus recommended @@ -53,9 +53,9 @@ the plugins on a clean install of eclipse to ensure there are no version-collisions.</para> - <para>The tools only include a subset of the WTP 1.0 plugins, thus if - you want full access to the WTP functionallity the full WTP 1.0 SDK can - be installed on top of the plugins without any problems.</para> + <para>The tools only include a subset of the WTP 1.5.x plugins, thus if + you want full access to the WTP functionallity the full WTP 1.5.x SDK should + be able to instal on top of the plugins without any problems.</para> </section> </section> @@ -66,7 +66,7 @@ associated libraries. The libraries are included in the distribution from the Hibernate website and the Eclipse updatesite. The libraries are located in the eclipse plugins directory at - <literal>/plugins/org.hibernate.eclipse.x.x.x/lib/tools/. </literal>These + <literal>/plugins/org.hibernate.eclipse.x.x.x/lib/tools/.</literal>These libraries are 100% independent from the eclipse platform. How to use these via ant tasks are described in the Ant chapter.</para> </section>