[jbosstools-commits] JBoss Tools SVN: r6503 - trunk/hibernatetools/docs/reference/en/modules.

Author: ochikvina Date: 2008-02-21 10:32:12 -0500 (Thu, 21 Feb 2008) New Revision: 6503 Modified: trunk/hibernatetools/docs/reference/en/modules/codegenarchitecture.xml trunk/hibernatetools/docs/reference/en/modules/plugins.xml trunk/hibernatetools/docs/reference/en/modules/setup.xml Log: http://jira.jboss.com/jira/browse/JBDS-238 - adding several link to download sites and docs; mistakes correction; Modified: trunk/hibernatetools/docs/reference/en/modules/codegenarchitecture.xml =================================================================== --- trunk/hibernatetools/docs/reference/en/modules/codegenarchitecture.xml 2008-02-21 15:04:33 UTC (rev 6502) +++ trunk/hibernatetools/docs/reference/en/modules/codegenarchitecture.xml 2008-02-21 15:32:12 UTC (rev 6503) @@ -26,8 +26,10 @@ </emphasis> files, requires a <emphasis> <property>hibernate.cfg.xml</property> </emphasis>. Named core in Eclipse and <emphasis> - <property><literal>&lt;configuration&gt;</literal></property></emphasis> - in ant.</para> + <property> + <literal>&lt;configuration&gt;</literal> + </property> + </emphasis> in ant.</para> </listitem> <listitem> @@ -35,9 +37,11 @@ <property>hbm.xml</property> </emphasis> and annotated classes, requires a <emphasis> <property>hibernate.cfg.xml</property> - </emphasis>. Named annotations in Eclipse and - <emphasis> - <property><literal>&lt;annotationconfiguration&gt;</literal></property></emphasis> in ant.</para> + </emphasis>. Named annotations in Eclipse and <emphasis> + <property> + <literal>&lt;annotationconfiguration&gt;</literal> + </property> + </emphasis> in ant.</para> </listitem> <listitem> @@ -45,17 +49,22 @@ <property>hbm.xml</property> </emphasis> and annotated classes requires that the project has a <emphasis> <property>META-INF/persistence.xml</property> - </emphasis> in its classpath. Named JPA in Eclipse and - <emphasis> - <property><literal>&lt;jpaconfiguration&gt;</literal></property></emphasis> in ant.</para> + </emphasis> in its classpath. Named JPA in Eclipse and <emphasis> + <property> + <literal>&lt;jpaconfiguration&gt;</literal> + </property> + </emphasis> in ant.</para> </listitem> <listitem> - <para>A JDBC configuration uses <property>Hibernate Tools</property> 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 - <emphasis> - <property><literal>&lt;jdbcconfiguration&gt;</literal></property></emphasis> in ant.</para> + <para>A JDBC configuration uses <property>Hibernate Tools</property> 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 <emphasis> + <property> + <literal>&lt;jdbcconfiguration&gt;</literal> + </property> + </emphasis> in ant.</para> </listitem> </itemizedlist> </para> @@ -63,26 +72,28 @@ <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 <property>Hibernate Tools</property>. </para> - - <note><para>No matter which Hibernate - Configuration type you are using <property>Hibernate Tools</property> supports them.</para></note> + <note> + <para>No matter which Hibernate Configuration type you are using <property>Hibernate + Tools</property> supports them.</para> + </note> + <para>The following drawing illustrates the core concepts:</para> <para> <figure> <title>Hibernate Core Concepts</title> - <mediaobject> - <imageobject role="fo"> - <imagedata fileref="images/architecture.png" format="PNG"/> - </imageobject> + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="images/architecture.png" format="PNG"/> + </imageobject> - <imageobject role="html"> - - <imagedata align="center" fileref="images/architecture.png" format="PNG"/> - </imageobject> - </mediaobject> - </figure> + <imageobject role="html"> + + <imagedata align="center" fileref="images/architecture.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> </para> <para>The code generation is done based on the Configuration model no matter which type of @@ -98,7 +109,8 @@ the job of the exporter to generate a set of code artifacts.</para> <para>The tools provides a default set of Exporter's which can be used in both Ant and the - Eclipse UI. Documentation for these Exporters is in the Ant and Eclipse sections.</para> + Eclipse UI. Documentation for these Exporters is in the <link linkend="ant">Ant Tools</link> + and <link linkend="plugins">Eclipse Plugins</link> chapters.</para> <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 Modified: trunk/hibernatetools/docs/reference/en/modules/plugins.xml =================================================================== --- trunk/hibernatetools/docs/reference/en/modules/plugins.xml 2008-02-21 15:04:33 UTC (rev 6502) +++ trunk/hibernatetools/docs/reference/en/modules/plugins.xml 2008-02-21 15:32:12 UTC (rev 6503) @@ -2,11 +2,13 @@ <chapter id="plugins"> <title>Eclipse Plugins</title> + <para>This chapter will introduce you to the functionality that <property>Hibernate + Tools</property> provide within Eclipse. That is a set of wizards and editors for simplifying + the work with <property>Hibernate</property>.</para> + <section> <title>Introduction</title> - <para/> - <para>The following features are available in the <property>Hibernate Tools</property> Eclipse plugins:</para> @@ -33,11 +35,14 @@ Tools</property> 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 - <property>Hibernate</property>. The tools make working with <property>Hibernate</property> - easier, but you are still encouraged/required to read the documentation for Hibernate to fully - utilize <property>Hibernate Tools</property> and especially <property>Hibernate</property> it - self.</para> + <note> + <para>Please note that these tools do not try to hide any functionality of + <property>Hibernate</property>. The tools make working with <property>Hibernate</property> + easier, but you are still encouraged/required to read the <ulink + url="http://www.hibernate.org/5.html">Hibernate Documentation</ulink> to fully utilize + <property>Hibernate Tools</property> and especially <property>Hibernate</property> it + self.</para> + </note> </section> <section> @@ -319,7 +324,6 @@ </mediaobject> </figure> - <para> <table> <title>Hibernate Console Configuration Classpath</title> @@ -361,7 +365,7 @@ </entry> <entry> - <para>empty</para> + <para>Empty</para> </entry> </row> @@ -382,7 +386,6 @@ </tbody> </tgroup> </table> - </para> <para> <figure> @@ -398,7 +401,7 @@ </mediaobject> </figure> - + <para>Parameters of the Mappings tab in the <property>Hibernate Console Configuration wizard</property> are explained below:</para> <table> <title>Hibernate Console Configuration Mappings</title> @@ -587,7 +590,7 @@ </entry> <entry> - <para>Path to a directory into where all output will be written by default. Be aware + <para>Path to a directory where all output will be written by default. Be aware that existing files will be overwritten, so be sure to specify the correct directory.</para> </entry> @@ -599,9 +602,9 @@ </entry> <entry> - <para>If enabled the tools will reverse engineer the database available via the + <para>If enabled, the tools will reverse engineer the database available via the connection information in the selected Hibernate Console Configuration and - generate code based on the database schema. If not enabled the code generation + generate code based on the database schema. If not enabled, the code generation will just be based on the mappings already specified in the Hibernate Console configuration.</para> </entry> @@ -806,7 +809,7 @@ </entry> <entry> - <para>Generates set of html pages that documents the database schema and some of the + <para>Generates a set of html pages that documents the database schema and some of the mappings.</para> </entry> </row> @@ -1218,7 +1221,7 @@ <section> <title>Hibernate Console Perspective</title> - <para>The <property>Hibernate Console Perspective</property> combines a set of views which allow + <para>The <property>Hibernate Console Perspective</property> combines a set of views which allow you to see the structure of your mapped entities/classes, edit HQL queries, execute the queries, and see the results. To use this perspective you need to create a <link linkend="console_conf">Console configuration</link>.</para> Modified: trunk/hibernatetools/docs/reference/en/modules/setup.xml =================================================================== --- trunk/hibernatetools/docs/reference/en/modules/setup.xml 2008-02-21 15:04:33 UTC (rev 6502) +++ trunk/hibernatetools/docs/reference/en/modules/setup.xml 2008-02-21 15:32:12 UTC (rev 6503) @@ -11,9 +11,12 @@ <title>JBoss Tools</title> <para><property>JBoss Tools 2.x</property> includes <property>Hibernate Tools</property> and - thus nothing is required besides downloading and installing <property>JBoss Tools</property>. - If you need to update to a newer version of the <property>Hibernate Tools</property> just - follow the instructions in the Eclipse IDE section.</para> + thus nothing is required besides <ulink url="http://labs.jboss.com/tools/download/index.html" + >downloading</ulink> and <ulink + url="http://www.redhat.com/developer_studio/guides/GettingStartedGui... + >installing JBoss Tools</ulink>. If you need to update to a newer version of the + <property>Hibernate Tools</property> just follow the instructions in the Eclipse IDE + section.</para> </section> <section> @@ -21,9 +24,10 @@ <para>To install into any <property>Eclipse 3.3.x</property> based Eclipse IDE you can either download the <property>Hibernate Tools</property> distribution from the <ulink - url="http://tools.hibernate.org">Hibernate website</ulink> or use the <property>JBoss - Tools</property> update site (see also <ulink url="http://tools.hibernate.org" - >http://tools.hibernate.org</ulink> for links to the update site).</para> + url="http://www.hibernate.org/6.html">Hibernate website</ulink> or use the <ulink + url="http://download.jboss.org/jbosstools/updates/stable/">J... Tools Update Site</ulink> + (see also <ulink url="http://tools.hibernate.org">http://tools.hibernate.org</ulink> for links + to the update site).</para> <para>If you download the <property>Hibernate Tools</property> distribution you need to place the <emphasis> @@ -40,8 +44,8 @@ then check out <ulink url="https://eclipse-tutorial.dev.java.net/" url="https://eclipse-tutorial.dev.java.net/visual-tutorials/updatema... - >https://eclipse-tutorial.dev.java.net/visual-tutorials/updatemanager.html</ulink> which covers - using the update manager.</para> + >https://eclipse-tutorial.dev.java.net/visual-tutorials/updatemanager.html</ulink> which + covers using the update manager.</para> </note> <section> @@ -51,13 +55,11 @@ 2.x</property> which at this time is the latest stable release from the Eclipse Webtools project.</para> - <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 that if you have issues with WTP provided features to - try and install the plugins on a clean install of eclipse to ensure there are no version - collisions.</para> + <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 that if you have issues with WTP provided features to try and install the + plugins on a clean install of eclipse to ensure there are no version collisions.</para> </section> </section> @@ -69,7 +71,9 @@ <property>hibernate-tools.jar</property> </emphasis> and 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 /plugins/org.hibernate.eclipse.x.x.x/lib/tools/. These libraries are 100% independent from the eclipse platform. How to use these - via ant tasks are described in the <link linkend="ant">Ant Tools</link> chapter.</para> + directory at <emphasis> + <property>/plugins/org.hibernate.eclipse.x.x.x/lib/tools/</property></emphasis>. These libraries are 100% + independent from the eclipse platform. How to use these via ant tasks are described in the + <link linkend="ant">Ant Tools</link> chapter.</para> </section> </chapter>