Author: mcaspers Date: 2011-01-20 01:22:06 -0500 (Thu, 20 Jan 2011) New Revision: 28430 Modified: trunk/hibernatetools/docs/reference/en-US/introduction.xml Log: General Updates Modified: trunk/hibernatetools/docs/reference/en-US/introduction.xml =================================================================== --- trunk/hibernatetools/docs/reference/en-US/introduction.xml 2011-01-20 06:14:39 UTC (rev 28429) +++ trunk/hibernatetools/docs/reference/en-US/introduction.xml 2011-01-20 06:22:06 UTC (rev 28430) @@ -1,163 +1,166 @@ <?xml version="1.0" encoding="UTF-8"?> <chapter id="introduction"> - <title>Introduction</title> + <title>Introduction</title> - <para><property>Hibernate Tools</property> is a toolset for <ulink - url="http://www.hibernate.org/6.html">Hibernate 3</ulink> and <ulink - url="http://www.hibernate.org/27.html">related projects</ulink>. The tools provide Ant + <para> + <property>Hibernate Tools</property> is a toolset for <ulink url="http://www.hibernate.org/6.html">Hibernate 3</ulink> and <ulink url="http://www.hibernate.org/27.html">related projects</ulink>. The tools provide Ant tasks and Eclipse plugins for performing reverse engineering, code generation, visualization and interaction with Hibernate.</para> - <section id="hibernate_key_features"> - <title>Key Features</title> + <section id="hibernate_key_features"> + <title>Key Features</title> - <para>First, we propose to look through the list of key features that you can benefit from - if you start using <property>Hibernate Tools</property>.</para> + <para>The table below lists the key features of <property>Hibernate Tools</property>.</para> - <table> - <title>Key Functionality for Hibernate Tools</title> - <tgroup cols="3"> - - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" colwidth="5*"/> - <colspec colnum="3" align="left" colwidth="1*"/> - - <thead> - <row> - <entry>Feature</entry> - <entry>Benefit</entry> - <entry>Chapter</entry> - </row> - </thead> + <table> + <title>Key Functionality for Hibernate Tools</title> + <tgroup cols="3"> - <tbody> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="5*"/> + <colspec colnum="3" align="left" colwidth="1*"/> - <row> - <entry> - <para>Code Generation through Ant Task</para> - </entry> - <entry> - <para>Allows to execute mapping or Java code generation from reverse - engineering, schema generation and generation of other artifacts - during the build process.</para> - </entry> - <entry><xref linkend="ant"/></entry> - </row> + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> - <row> - <entry> - <para>Wizards for creation - purposes and code - generation</para> - </entry> - <entry> - <para> A set of wizards are provided with the Hibernate Eclipse tools to - quickly create common Hibernate files such as configuration - (cfg.xml) files, mapping files and revenge.xml as well. Code - Generation wizard helps to generate a series of various artifacts, - there is even support for completely reverse engineer an existing - database schema.</para> - </entry> - <entry> <xref linkend="map_file_wizard"/> - <xref linkend="hib_config_file"/> - <xref linkend="code_gen"/> - </entry> - </row> + <tbody> + <row> + <entry> + <para>Code Generation through Ant Task</para> + </entry> + <entry> + <para> + Allows to execute mapping or Java code generation from reverse engineering, schema generation and generation of other artifacts during the build process. + </para> + </entry> + <entry> + <xref linkend="ant"/> + </entry> + </row> - <row> - <entry> - <para> - Mapping and Configuration files - Editors - </para> - </entry> - <entry> - <para>Support auto-completion and syntax highlighting. Editors also - support semantic auto-completion for class names and property/field - names, making it much more versatile than a normal XML - editor.</para> - </entry> - <entry> <xref linkend="map_config_editor"/></entry> - </row> + <row> + <entry> + <para>Wizards for creation purposes and code generation</para> + </entry> + <entry> + <para> + A set of wizards are provided with the Hibernate Eclipse tools to quickly create common Hibernate files such as configuration (<filename>cfg.xml</filename>) files, mapping files and <filename>revenge.xml</filename> as well. Code Generation wizard helps to generate a series of various artifacts, there is even support for completely reverse engineer an existing database schema. + </para> + </entry> + <entry> + <xref linkend="map_file_wizard"/> + <xref linkend="hib_config_file"/> + <xref linkend="code_gen"/> + </entry> + </row> - <row> - <entry> - <para>Tools for organizing and controlling Reverse Engineering</para> - </entry> - <entry> - <para>Code Generation wizard provides powerful functionality for - generating a series of various artifacts like domain model classes, - mapping files, annotated EJB3 entity beans, etc. and reveng.xml file - editor allows to control this processes.</para> - </entry> - <entry><xref linkend="code_gen"/> - <xref linkend="rev_xml_editor"/></entry> - </row> - <row> - <entry> - <para>Hibernate Console</para> - </entry> - <entry> - <para>It is a new perspective in Eclipse which 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> - </entry> - <entry><xref linkend="hib_console"/></entry> - </row> + <row> + <entry> + <para>Mapping and Configuration files Editors</para> + </entry> + <entry> + <para> + Support auto-completion and syntax highlighting. Editors also support semantic auto-completion for class names and property/field names, making it much more versatile than a normal XML editor. + </para> + </entry> + <entry> + <xref linkend="map_config_editor"/> + </entry> + </row> + + <row> + <entry> + <para>Tools for organizing and controlling Reverse Engineering</para> + </entry> + <entry> + <para> + Code Generation wizard provides powerful functionality for generating a series of various artifacts like domain model classes, mapping files, annotated EJB3 entity beans, etc. and <filename>reveng.xml</filename> file editor allows to control this processes. + </para> + </entry> + <entry> + <xref linkend="code_gen"/> + <xref linkend="rev_xml_editor"/> + </entry> + </row> + + <row> + <entry> + <para>Hibernate Console</para> + </entry> + <entry> + <para> + It is a new perspective in Eclipse which 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> + </entry> + <entry> + <xref linkend="hib_console"/> + </entry> + </row> - <row> - <entry> - <para>HQL Editor and Hibernate Criteria Editor</para> - </entry> - <entry> - <para>The editors are intended for writing, editing and executing HQL queries and criterias. They also support the functionality for generating - simple queries.</para> - </entry> - <entry><xref linkend="hql_and_criteria_editors"/></entry> - </row> + <row> + <entry> + <para>HQL Editor and Hibernate Criteria Editor</para> + </entry> + <entry> + <para> + The editors are intended for writing, editing and executing HQL queries and criterias. They also support the functionality for generating simple queries. + </para> + </entry> + <entry> + <xref linkend="hql_and_criteria_editors"/> + </entry> + </row> - <row> - <entry> - <para>Functional Mapping Diagram</para> - </entry> - <entry> - <para>Makes possible to visualize structure of entities and - relationships between them.</para> - </entry> - <entry><xref linkend="map_diagram"/></entry> - </row> + <row> + <entry> + <para>Functional Mapping Diagram</para> + </entry> + <entry> + <para>Makes possible to visualize structure of entities and relationships between them.</para> + </entry> + <entry> + <xref linkend="map_diagram"/> + </entry> + </row> - <row> - <entry> - <para>Eclipse JDT integration</para> - </entry> - <entry> - <para>Hibernate Tools integrates into the Java code completion and build - support of Java in Eclipse. This gives you code completion of HQL - inside Java code. Additionally, Hibernate Tools will add problem - markers if your queries are not valid against the console - configuration associated with the project.</para> - </entry> - </row> + <row> + <entry> + <para>Eclipse JDT integration</para> + </entry> + <entry> + <para> + Hibernate Tools integrates into the Java code completion and build support of Java in Eclipse. This gives you code completion of HQL inside Java code. Additionally, Hibernate Tools will add problem markers if your queries are not valid against the console configuration associated with the project. + </para> + </entry> + </row> - </tbody> - </tgroup> - </table> - </section> - - <section> - <title>Other relevant resources on the topic</title> + </tbody> + </tgroup> + </table> + </section> + + <section> + <title>Other relevant resources on the topic</title> <!--para>Hibernate Tools page on the <ulink url="http://www.hibernate.org/255.html">hibernate.org</ul... - <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at<ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/too... in the corresponding release directory.</para> - <para>There is some extra information about Hidernate on <ulink url="http://www.jboss.org/community/wiki/JBossHibernate3">JBoss Wiki page. </ulink></para> - <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">htt... - </section> + <para> + All JBoss Developer Studio/JBoss Tools release documentation you can find at<ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/too... in the corresponding release directory. + </para> + <para> + There is some extra information about Hidernate on <ulink url="http://www.jboss.org/community/wiki/JBossHibernate3">JBoss Wiki page. </ulink> + </para> + <para> + The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">htt...;. + </para> + </section> </chapter>