Author: smukhina Date: 2008-05-26 11:45:10 -0400 (Mon, 26 May 2008) New Revision: 8326 Modified: branches/jbosstools-2.1.x/hibernatetools/docs/ branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/master.xml branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/modules/ant.xml branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/modules/codegen.xml branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/modules/codegenarchitecture.xml branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/modules/plugins.xml branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/modules/reverseengineering.xml branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/modules/setup.xml Log: http://jira.jboss.com/jira/browse/JBDS-324 Merged revisions 8290,8319 via svnmerge from https://svn.jboss.org/repos/jbosstools/trunk/hibernatetools/docs ........ r8290 | afedosik | 2008-05-22 18:00:32 +0300 (Thu, 22 May 2008) | 1 line http://jira.jboss.com/jira/browse/JBDS-292 Docs version update according to GA release ........ r8319 | tromanovich | 2008-05-26 17:54:15 +0300 (Mon, 26 May 2008) | 2 lines http://jira.jboss.com/jira/browse/JBDS-224 - Special text paragraphs framing Verified and updated <note>, <important>, and <tip> boxes for all guides (titles were added, some titles were changed). ........ Property changes on: branches/jbosstools-2.1.x/hibernatetools/docs ___________________________________________________________________ Name: svnmerge-integrated - /trunk/hibernatetools/docs:1-7998,8060-8147 + /trunk/hibernatetools/docs:1-7998,8060-8147,8290-8319 Modified: branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/master.xml =================================================================== --- branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/master.xml 2008-05-26 15:39:50 UTC (rev 8325) +++ branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/master.xml 2008-05-26 15:45:10 UTC (rev 8326) @@ -39,7 +39,7 @@ </copyright> <releaseinfo> - Version: 3.2.1.CR1 + Version: 3.2.1.GA </releaseinfo> Modified: branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/modules/ant.xml =================================================================== --- branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/modules/ant.xml 2008-05-26 15:39:50 UTC (rev 8325) +++ branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/modules/ant.xml 2008-05-26 15:45:10 UTC (rev 8326) @@ -20,6 +20,7 @@ of eclipse.</para> <note> + <title>Note:</title> <para>There might be incompatibilities with respect to the Hibernate3.jar bundled with the tools and your own jar. Thus to avoid any confusion it is recommended to use the hibernate3.jar and hibernate-annotations.jar bundled with the tools when you want to use the @@ -270,6 +271,7 @@ which a set of exporters can be run to generate various output. </para> <note> + <title>Note:</title> <para>Output can be anything, e.g. specific files, statements execution against a database, error reporting or anything else that can be done in java code.</para> </note> @@ -413,7 +415,7 @@ </emphasis> and fileset is used instead. </para> <note> - <title>Tip:</title> + <title>Note:</title> <para> Hibernate will still read any global <emphasis> <property>hibernate.properties</property> </emphasis> available in the classpath, but the specified properties file here will @@ -443,13 +445,13 @@ </emphasis> is used when you want to read the metamodel from EJB3/Hibernate Annotations based POJO's.</para> - <note> - <title>Tip:</title> + <important> + <title>Important:</title> <para>To use it remember to put the jar files needed for using hibernate annotations in the classpath of the <emphasis> <property>&lt;taskdef&gt;</property>, </emphasis> i. e. hibernate-annotations.jar and hibernate-commons-annotations.jar.</para> - </note> + </important> <para>The <emphasis> <property>&lt;annotationconfiguration&gt;</property> @@ -533,6 +535,7 @@ <note> + <title>Note:</title> <para>ejb3configuration was the name used in previous versions. It still works but will emit a warning telling you to use <literal>jpaconfiguration</literal> instead.</para> </note> @@ -996,6 +999,7 @@ <property>hbm.xml</property>. </emphasis></para> <note> + <title>Note:</title> <para>Not every possible mapping transformation is possible/implemented (contributions welcome) so some hand editing might be necessary.</para> </note> @@ -1024,6 +1028,7 @@ </emphasis>.</para> <note> + <title>Note:</title> <para>Not all conversions are implemented (contributions welcome), so some hand editing might be necessary.</para> </note> @@ -1148,7 +1153,7 @@ <property>queryresult.txt</property>. </emphasis></para> <note> - <title>Tip:</title> + <title>Note:</title> <para> Currently the dump is simply a call to toString on each element.</para> </note> @@ -1174,6 +1179,7 @@ />]]></programlisting> <note> + <title>Note:</title> <para>Previous versions of the tools used Velocity. We are now using Freemarker which provides us much better exception and error handling.</para> </note> @@ -1296,7 +1302,7 @@ <property>&lt;property&gt;</property> </emphasis> which will be available to the templates/exporter. </para> <note> - <title>Tip:</title> + <title>Note:</title> <para> This example actually simulates what &lt;hbm2java&gt; actually does.</para> </note> Modified: branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/modules/codegen.xml =================================================================== --- branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/modules/codegen.xml 2008-05-26 15:39:50 UTC (rev 8325) +++ branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/modules/codegen.xml 2008-05-26 15:45:10 UTC (rev 8326) @@ -277,6 +277,7 @@ </emphasis> file will implement <literal>IAuditable</literal>!</para> <note> + <title>Note:</title> <para>This applies to <emphasis>all</emphasis> <literal>&lt;meta&gt;</literal>-tags. Thus it can also e.g. be used to specify that all fields should be declare protected, instead of the default private. This is done by @@ -530,6 +531,7 @@ </hibernate-mapping>]]></programlisting> <note> + <title>Note:</title> <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 Modified: branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/modules/codegenarchitecture.xml =================================================================== --- branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/modules/codegenarchitecture.xml 2008-05-26 15:39:50 UTC (rev 8325) +++ branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/modules/codegenarchitecture.xml 2008-05-26 15:45:10 UTC (rev 8326) @@ -74,6 +74,7 @@ facilities of <property>Hibernate Tools</property>. </para> <note> + <title>Note:</title> <para>No matter which Hibernate Configuration type you are using <property>Hibernate Tools</property> supports them.</para> </note> Modified: branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/modules/plugins.xml =================================================================== --- branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/modules/plugins.xml 2008-05-26 15:39:50 UTC (rev 8325) +++ branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/modules/plugins.xml 2008-05-26 15:45:10 UTC (rev 8326) @@ -17,6 +17,7 @@ can take advantage of while using the tools within Eclipse.</para> <note> + <title>Note:</title> <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 @@ -113,6 +114,7 @@ </figure> <note> + <title>Note:</title> <para>The contents in the combo boxes for the JDBC driver class and JDBC URL change automatically, depending on the Dialect and actual driver you have chosen.</para> </note> @@ -153,6 +155,7 @@ </emphasis>.</para> <note> + <title>Note:</title> <para>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> </note> @@ -565,12 +568,12 @@ <property>New_Generation</property> </emphasis> will be used.</para> - <note> + <tip> <title>Tip:</title> <para>The &quot;At least one exporter option must be selected&quot; is just a warning stating that for this launch to work you need to select an exporter on the Exporter tab. When an exporter has been selected the warning will disappear.</para> - </note> + </tip> <para>The dialog also have the standard tabs <emphasis> <property>Refresh</property> @@ -1046,6 +1049,7 @@ <para>For java completion and navigation to work the file needs to reside inside an Eclipse Java project, otherwise no completion will occur.</para> <note> + <title>Note:</title> <para>Java completion does not require a Hibernate console configuration to be used.</para> </note> </section> @@ -1070,6 +1074,7 @@ </figure> <important> + <title>Important:</title> <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> @@ -1083,6 +1088,7 @@ table/column names in the background.</para> <note> + <title>Note:</title> <para>Currently it is not recommended to use this feature on large databases since it does not fetch the information iteratively. It will be improved in future versions.</para> </note> @@ -1165,6 +1171,7 @@ default naming rules are not applicable.</para> <note> + <title>Note:</title> <para> Not all the features of the <emphasis> <property>.reveng.xml </property> </emphasis> file are exposed or fully implemented in the editor, but the main functionality @@ -1520,6 +1527,7 @@ <note> + <title>Note:</title> <para>HQL queries are executed by default using <literal>list()</literal> thus without any limit of the size of the output the query could return a large result set. You might run out of memory. To avoid this you can put a value in the Max results field to reduce the Modified: branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/modules/reverseengineering.xml =================================================================== --- branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/modules/reverseengineering.xml 2008-05-26 15:39:50 UTC (rev 8325) +++ branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/modules/reverseengineering.xml 2008-05-26 15:45:10 UTC (rev 8326) @@ -44,6 +44,7 @@ specialized editor.</para> <note> + <title>Note:</title> <para>Many databases are case-sensitive with their names and thus if you cannot make some table match and you are sure it is not excluded by a &lt;table-filter&gt; then check if the case matches; most databases stores table names in uppercase.</para> @@ -121,6 +122,7 @@ </emphasis> is still used to then decide which tables will be included/excluded.</para> <note> + <title>Note:</title> <para>If no <literal>&lt;schema-selection&gt;</literal> is specified, the reverse engineering works as if all schemas should be processed. This is equal to: <![CDATA[<schema-selection/>]]>. Which in turn is equal to: @@ -694,10 +696,8 @@ </emphasis> has two purposes. One for allowing to define foreign-keys in databases that does not support them or does not have them defined in their schema. Secondly, to allow defining the name of the resulting properties (many-to-one and one-to-many's).</para> - - <para>Note:</para> - - <programlisting role="XML"><![CDATA[<foreign-key + + <para><programlisting role="XML"><![CDATA[<foreign-key constraint-name="foreignKeyName" foreign-catalog="catalogName" foreign-schema="schemaName" @@ -710,8 +710,7 @@ <set property="aCollectionName" exclude="true|false"/> - </foreign-key>]]></programlisting> - + </foreign-key>]]></programlisting></para> <table frame="topbot"> <title>Foreign-key attributes</title> Modified: branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/modules/setup.xml =================================================================== --- branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/modules/setup.xml 2008-05-26 15:39:50 UTC (rev 8325) +++ branches/jbosstools-2.1.x/hibernatetools/docs/reference/en/modules/setup.xml 2008-05-26 15:45:10 UTC (rev 8326) @@ -42,6 +42,7 @@ -clean</property>.</emphasis> Using the updatesite does not require any additional steps.</para> <note> + <title>Note:</title> <para>If you need more basic instructions on installing plugins and general usage of eclipse then check out <ulink url="https://eclipse-tutorial.dev.java.net/"