Author: ochikvina Date: 2008-02-28 10:58:34 -0500 (Thu, 28 Feb 2008) New Revision: 6642 Modified: trunk/hibernatetools/docs/reference/en/modules/ant.xml trunk/hibernatetools/docs/reference/en/modules/codegen.xml trunk/hibernatetools/docs/reference/en/modules/plugins.xml trunk/hibernatetools/docs/reference/en/modules/reverseengineering.xml trunk/hibernatetools/docs/reference/en/modules/setup.xml Log: http://jira.jboss.com/jira/browse/JBDS-238 - fixing some spelling mistakes & making some small corrections Modified: trunk/hibernatetools/docs/reference/en/modules/ant.xml =================================================================== --- trunk/hibernatetools/docs/reference/en/modules/ant.xml 2008-02-28 15:22:31 UTC (rev 6641) +++ trunk/hibernatetools/docs/reference/en/modules/ant.xml 2008-02-28 15:58:34 UTC (rev 6642) @@ -604,7 +604,7 @@ </entry> <entry> - <para>The default package name to use when mappings for classes are created.</para> + <para>The default package name to use when mappings for classes are created</para> </entry> <entry> @@ -618,7 +618,7 @@ </entry> <entry> - <para>The name of a property file, e.g. "hibernate.properties".</para> + <para>The name of a property file, e.g. "hibernate.properties"</para> </entry> <entry> @@ -942,7 +942,7 @@ </entry> <entry> - <para>Code will contain JDK 5 constructs such as generics and static imports.</para> + <para>Code will contain JDK 5 constructs such as generics and static imports</para> </entry> <entry> @@ -957,7 +957,7 @@ <entry> <para>Code will contain EJB 3 features, e.g. using annotations from - javax.persistence and org.hibernate.annotations.</para> + javax.persistence and org.hibernate.annotations</para> </entry> <entry> Modified: trunk/hibernatetools/docs/reference/en/modules/codegen.xml =================================================================== --- trunk/hibernatetools/docs/reference/en/modules/codegen.xml 2008-02-28 15:22:31 UTC (rev 6641) +++ trunk/hibernatetools/docs/reference/en/modules/codegen.xml 2008-02-28 15:58:34 UTC (rev 6642) @@ -5,7 +5,7 @@ <para>When using <emphasis> <property>&lt;hbm2java&gt;</property> </emphasis> or the eclipse plugin to generate POJO java code you have the possibility to control - certain aspects of the code generation. This is primarily done through the <emphasis> + certain aspects of the code generation. This is primarily done with the <emphasis> <property>&lt;meta&gt;</property> </emphasis> tag in the mapping files. The following section describes the possible <emphasis> <property>&lt;meta&gt;</property> @@ -137,7 +137,7 @@ <literal>interface</literal> </entry> - <entry>If true an interface is generated instead of an class.</entry> + <entry>If true, an interface is generated instead of an class.</entry> </row> <row> @@ -153,7 +153,7 @@ <literal>extends</literal> </entry> - <entry>class the class should extend (ignored for subclasses)</entry> + <entry>class that the current class should extend (ignored for subclasses)</entry> </row> <row> @@ -437,7 +437,7 @@ <section> <title>Generate pre/post-conditions for methods</title> - <para>With an <emphasis> &lt;meta attribute="class-code"&gt;</emphasis>, you can add + <para>With a <emphasis> &lt;meta attribute="class-code"&gt;</emphasis>, you can add additional methods on a given class, nevertheless such <emphasis> <property>&lt;meta&gt;</property> </emphasis> attribute can not be used at a property scope level and <property>Hibernate @@ -445,13 +445,13 @@ <property>&lt;meta&gt;</property> </emphasis> attributes.</para> - <para>A possibly solution for this is to modify the freemarker templates responsible for + <para>A possible solution for this is to modify the freemarker templates responsible for generating the POJO's. If you look inside <emphasis> <property>hibernate-tools.jar</property>, </emphasis> you can find the template: <emphasis> <property>pojo/PojoPropertyAccessor.ftl</property> </emphasis></para> - <para>This file is as the named indicates used to generate property accessors for pojo's.</para> + <para>This file is as the name indicates used to generate property accessors for pojo's.</para> <para>Extract the <emphasis> <property>PojoPropertyAccessor.ftl</property> @@ -510,7 +510,7 @@ contents will be generated into the body of the relevant <literal>set</literal> method.</para> <para>As an example let us add a pre-condition for property <literal>name</literal> - preventing no <property>Person</property> can have an empty name. So we have to modify the <emphasis> + preventing no <property>Person</property> can have an empty name. Hence we have to modify the <emphasis> <property>Person.hbm.xml</property> </emphasis> file like this:</para> @@ -530,7 +530,7 @@ </hibernate-mapping>]]></programlisting> <note> - <para>I) To scape the &amp; symbol we put &amp;amp;. You can use + <para>I) To escape the &amp; symbol we put &amp;amp;. You can use &lt;![CDATA[]]&gt; instead.</para> <para>II) Note that we are referring to "firstName" directly and this is the parameter name not the actual field name. If you want to refer the field you have to use Modified: trunk/hibernatetools/docs/reference/en/modules/plugins.xml =================================================================== --- trunk/hibernatetools/docs/reference/en/modules/plugins.xml 2008-02-28 15:22:31 UTC (rev 6641) +++ trunk/hibernatetools/docs/reference/en/modules/plugins.xml 2008-02-28 15:58:34 UTC (rev 6642) @@ -98,7 +98,7 @@ <property>hibernate.cfg.xml</property> </emphasis> will be automatically opened in an editor. The last option <emphasis> <property>Create Console Configuration</property> - </emphasis> is enabled by default and when enabled it will automatically use the <emphasis> + </emphasis> is enabled by default and when enabled, it will automatically use the <emphasis> <property>hibernate.cfg.xml</property> </emphasis> for the basis of a Console configuration.</para> </section> @@ -111,7 +111,7 @@ classpath are 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 definitely - possible.</para> + possible if your project requires this.</para> <para>You create a console configuration by running the <property>Console Configuration Wizard</property>, shown in the following screenshot. The same wizard will also be used if you @@ -323,6 +323,8 @@ </mediaobject> </figure> + + <para>The fallowing table specifies the parameters of the Classpath tab of the wizard.</para> <table> <title>Hibernate Console Configuration Classpath</title> @@ -1037,7 +1039,7 @@ </figure> <important> - <para>Note that it requires a proper configured hibernate console configuration and this + <para>Table/Column completion requires a proper configured hibernate console configuration and this configuration should be the default for the project where the <emphasis> <property>hbm.xml</property> </emphasis> resides.</para> @@ -1093,15 +1095,17 @@ <para>The editor is intended to allow easy definition of type mappings, table include/excludes and specific override settings for columns, e.g. define an explicit name for a column when the - default naming rules is not applicable.</para> + default naming rules are not applicable.</para> - <para>Note that not all the features of the <emphasis> + <note><para> + Not all the features of the <emphasis> <property>.reveng.xml </property> - </emphasis> file is exposed or fully implemented in the editor, but the main functionality is + </emphasis> file are exposed or fully implemented in the editor, but the main functionality is there. To understand the full flexibility of the <emphasis> <property>reveng.xml</property> - </emphasis>, please see <xref linkend="hibernaterevengxmlfile"/></para> - + </emphasis>, please see <xref linkend="hibernaterevengxmlfile"/> </para> + </note> + <para>The editor is activated as soon as an <emphasis> <property>.reveng.xml </property> </emphasis> file is opened. To get an initial <emphasis> @@ -1172,7 +1176,7 @@ <para>The <emphasis> <property>Type Mappings</property> - </emphasis> page is used for specifying type mappings from JBDS types to any Hibernate type + </emphasis> page is used for specifying type mappings from JBDC types to any Hibernate type (including usertypes) if the default rules are not applicable. Here again to see the database tables press <emphasis> <property>Refresh</property> @@ -1195,7 +1199,7 @@ <para>The <emphasis> <property>Table and Columns</property> - </emphasis> page allow the user to explicit set e.g. which hibernatetype and propertyname that + </emphasis> page allows you to explicit set e.g. which hibernatetype and propertyname that should be used in the reverse engineered model. For more details on how to configure the tables while reverse engineering read the <link linkend="tab_and_col">Specific table configuration</link> section.</para> @@ -1259,7 +1263,7 @@ <section> <title>Mapping Diagram</title> - <para>To get a visual feel on how entities are related and view their structure a + <para>In order to get a visual feel on how entities are related as well as view their structures, a <property>Mapping Diagram</property> is provided. It is available by right clicking on the entity you want a mapping diagram for and then choose <emphasis> <property>Open Mapping Diagram</property> @@ -1290,7 +1294,7 @@ Editor</property> or <property>Hibernate Criteria Editor</property>. The editors automatically detect the chosen configuration.</para> - <para>If the menu item is disabled then you need at first to create an <property>Session + <para>If the menu item is disabled then you need at first to create a <property>Session Factory</property>. That is done by simply expanding the <property>Session Factory</property> node.</para> Modified: trunk/hibernatetools/docs/reference/en/modules/reverseengineering.xml =================================================================== --- trunk/hibernatetools/docs/reference/en/modules/reverseengineering.xml 2008-02-28 15:22:31 UTC (rev 6641) +++ trunk/hibernatetools/docs/reference/en/modules/reverseengineering.xml 2008-02-28 15:58:34 UTC (rev 6642) @@ -80,7 +80,7 @@ <table-filter match-catalog="BAD" match-schema="SCHEMA" match-name=".*" exclude="true" /> <!-- table allows you to override/define how reverse engineering - are done for a specific table --> + is done for a specific table --> <table name="ORDERS"> <primary-key> <!-- setting up a specific id generator for a table --> @@ -154,7 +154,7 @@ </section> </section> - <section> + <section id="type_map"> <title>Type mappings (&lt;type-mapping&gt;)</title> <para>The <emphasis> @@ -436,7 +436,7 @@ </section> - <section> + <section id="tab_and_col"> <title>Specific table configuration (&lt;table&gt;)</title> <para><emphasis> @@ -638,7 +638,7 @@ <row> <entry><para>name</para></entry> - <entry><para>Column name.</para></entry> + <entry><para>Column name</para></entry> <entry><para>Required</para></entry> </row> @@ -656,7 +656,7 @@ <row> <entry><para>type</para></entry> - <entry><para>Which hibernate-type to use for this specific column.</para></entry> + <entry><para>Which hibernate-type to use for this specific column</para></entry> <entry><para>Optional</para></entry> </row> @@ -666,7 +666,7 @@ <entry><para>property</para></entry> <entry><para>What property name will be generated for this - column.</para></entry> + column</para></entry> <entry><para>Optional</para></entry> </row> @@ -674,7 +674,7 @@ <row> <entry><para>exclude</para></entry> - <entry><para>Set to true if this column should be ignored.</para></entry> + <entry><para>Set to true if this column should be ignored</para></entry> <entry><para>default: false</para></entry> </row> Modified: trunk/hibernatetools/docs/reference/en/modules/setup.xml =================================================================== --- trunk/hibernatetools/docs/reference/en/modules/setup.xml 2008-02-28 15:22:31 UTC (rev 6641) +++ trunk/hibernatetools/docs/reference/en/modules/setup.xml 2008-02-28 15:58:34 UTC (rev 6642) @@ -36,8 +36,10 @@ <property>/feature</property> </emphasis> directory into your eclipse directory or eclipse extensions directory. Sometimes Eclipse does not automatically detect new plugins and thus the tools will not be activated. To - ensure eclipse sees these changes run eclipse with the -clean option. E.g. <literal>eclipse - -clean</literal> Using the updatesite does not require any additional steps.</para> + ensure eclipse sees these changes just clean up the cached plugin information by running eclipse with the <emphasis> + <property>-clean</property></emphasis> option, e.g. <emphasis> + <property>eclipse + -clean</property>.</emphasis> Using the updatesite does not require any additional steps.</para> <note> <para>If you need more basic instructions on installing plugins and general usage of eclipse