Author: afedosik Date: 2008-01-03 07:41:58 -0500 (Thu, 03 Jan 2008) New Revision: 5487 Modified: trunk/hibernatetools/docs/reference/en/modules/ant.xml trunk/hibernatetools/docs/reference/en/modules/codegen.xml trunk/hibernatetools/docs/reference/en/modules/codegenarchitecture.xml trunk/hibernatetools/docs/reference/en/modules/plugins.xml trunk/hibernatetools/docs/reference/en/modules/reverseengineering.xml Log: http://jira.jboss.com/jira/browse/JBDS-239 - Spelling and grammer in Guide are corrected. Modified: trunk/hibernatetools/docs/reference/en/modules/ant.xml =================================================================== --- trunk/hibernatetools/docs/reference/en/modules/ant.xml 2007-12-29 15:10:27 UTC (rev 5486) +++ trunk/hibernatetools/docs/reference/en/modules/ant.xml 2008-01-03 12:41:58 UTC (rev 5487) @@ -201,10 +201,10 @@ <para>Each have in common that they are able to build up a Hibernate <literal>Configuration</literal> object from which a set of exporters can be run to generate - various output. Note: output can be anything, e.g. specific files, statments execution against + various output. Note: 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> - <para>The following section decribes what the the various configuration can do, plus list the + <para>The following section describes what the various configuration can do, plus list the individual settings they have.</para> <section> @@ -265,7 +265,7 @@ </callout> <callout arearefs="cfg5"> - <para>A standard Ant fileset. Used to include hibernate mapping files.Remember that if + <para>A standard Ant fileset. Used to include hibernate mapping files. Remember that if mappings are already specified in the hibernate.cfg.xml then it should not be included via the fileset as it will result in duplicate import exceptions.</para> </callout> @@ -461,8 +461,8 @@ tables and has no other columns.</para> </callout> <callout arearefs="xcfg5"> - <para>detectOptimisticLock (efault:true): If true columns named VERSION or TIMESTAMP - with appropriate types will be mapped with the apropriate optimistic locking + <para>detectOptimisticLock (default:true): If true columns named VERSION or TIMESTAMP + with appropriate types will be mapped with the appropriate optimistic locking corresponding to <literal>&lt;version&gt;</literal> or <literal>&lt;timestamp&gt;</literal></para> </callout> @@ -493,7 +493,7 @@ <section> <title>Exporters</title> - <para>Exporters is the parts that does the actual job of converting the hibernate metamodel into + <para>Exporters are the parts that does the actual job of converting the hibernate metamodel into various artifacts, mainly code. The following section describes the current supported set of exporters in the <property>Hibernate Tool</property> distribution. It is also possible for userdefined exporters, that is done through the <emphasis> @@ -568,7 +568,7 @@ </callout> <callout arearefs="ycfg6"> - <para>delimiter (default: ";"): What delimter to use to separate statements</para> + <para>delimiter (default: ";"): What delimiter to use to separate statements</para> </callout> <callout arearefs="ycfg7"> @@ -602,8 +602,8 @@ <title>POJO java code exporter (<literal>&lt;hbm2java&gt;</literal>)</title> <para><emphasis> - <property>&lt;hbm2java&gt;</property></emphasis> is a java codegenerator. Options for controlling wether JDK 5 - syntax can be used and wether the POJO should be annotated with EJB3/Hibernate Annotations.</para> + <property>&lt;hbm2java&gt;</property></emphasis> is a java codegenerator. Options for controlling whether JDK 5 + syntax can be used and whether the POJO should be annotated with EJB3/Hibernate Annotations.</para> <para> <programlistingco> @@ -837,7 +837,7 @@ <section> <title>Using properties to configure Exporters</title> - <para>Exporters can be controlled by user properties. The user properties is specificed via + <para>Exporters can be controlled by user properties. The user properties are specified via <emphasis> <property>&lt;property&gt;</property></emphasis> or <emphasis> @@ -860,7 +860,7 @@ <property><literal>&lt;property&gt;</literal></property></emphasis> is enough for specifying the properties needed for the exporters. Still the ant tools supports the notion of <emphasis> - <property><literal>&lt;propertyset&gt;</literal></property></emphasis>. The functionallity of + <property><literal>&lt;propertyset&gt;</literal></property></emphasis>. The functionality of <emphasis> <property><literal>&lt;propertyset&gt;</literal></property></emphasis> is explained in detail in the Ant task manual.</para> @@ -881,7 +881,7 @@ <emphasis> <property><literal>&lt;hibernatetool&gt;</literal></property></emphasis> or inside any exporter will automatically create an instance of <literal>x.y.z.NameOfToolClass</literal> and it will be available in - the templates as <literal>$sometool</literal>. This is usefull to delegate logic and code + the templates as <literal>$sometool</literal>. This is useful to delegate logic and code generation to java code instead of placing such logic in the templates.</para> <section> Modified: trunk/hibernatetools/docs/reference/en/modules/codegen.xml =================================================================== --- trunk/hibernatetools/docs/reference/en/modules/codegen.xml 2007-12-29 15:10:27 UTC (rev 5486) +++ trunk/hibernatetools/docs/reference/en/modules/codegen.xml 2008-01-03 12:41:58 UTC (rev 5487) @@ -177,7 +177,7 @@ <row> <entry><literal>default-value</literal></entry> - <entry>default initializatioin value for a field</entry> + <entry>default initialization value for a field</entry> </row> <row> @@ -192,7 +192,7 @@ <entry>include this property in the <literal>equals()</literal> and <literal>hashCode()</literal> method. If no use-in-equals is - specificed, no equals/hashcode will be generated.</entry> + specified, no equals/hashcode will be generated.</entry> </row> <row> @@ -265,7 +265,7 @@ <property>&quot;class-scope&quot;</property></emphasis> to the current class, not the subclasses.</para> <section> - <title>Recomendations</title> + <title>Recommendations</title> <para>The following are some good practices when using <emphasis> @@ -408,7 +408,7 @@ <para>With an <emphasis> &lt;meta attribute="class-code"&gt;</emphasis>, - you can add addional methods on a given class, nevertheless such + you can add additional methods on a given class, nevertheless such <emphasis> <property>&lt;meta&gt;</property></emphasis> attribute can not be used at property scope level and <property>Hibernate Tools</property> does not provide such @@ -416,7 +416,7 @@ <property>&lt;meta&gt;</property></emphasis> attributes.</para> <para>A possibly solution for this is to modify the freemarker - templates responsable for generating the POJO's. If you look inside + templates responsible for generating the POJO's. If you look inside <emphasis> <property>hibernate-tools.jar</property></emphasis>, you can find the template: <emphasis> @@ -474,7 +474,7 @@ contents will be generated into the body of the relevant <literal>set</literal> method.</para> - <para>As an examlpe let us add a pre-condition for property + <para>As an example let us add a pre-condition for property <literal>name</literal> preventing no <literal>Person</literal> can have an empty name. So we have to modify the <emphasis> Modified: trunk/hibernatetools/docs/reference/en/modules/codegenarchitecture.xml =================================================================== --- trunk/hibernatetools/docs/reference/en/modules/codegenarchitecture.xml 2007-12-29 15:10:27 UTC (rev 5486) +++ trunk/hibernatetools/docs/reference/en/modules/codegenarchitecture.xml 2008-01-03 12:41:58 UTC (rev 5487) @@ -70,7 +70,7 @@ <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>. The important thing to note is that no matter which Hibnerate + facilities of <property>Hibernate Tools</property>. The important thing to note is that no matter which Hibernate Configuration type you are using <property>Hibernate Tools</property> supports them.</para> <para>The following drawing illustrates the core concepts:</para> Modified: trunk/hibernatetools/docs/reference/en/modules/plugins.xml =================================================================== --- trunk/hibernatetools/docs/reference/en/modules/plugins.xml 2007-12-29 15:10:27 UTC (rev 5486) +++ trunk/hibernatetools/docs/reference/en/modules/plugins.xml 2008-01-03 12:41:58 UTC (rev 5487) @@ -85,7 +85,7 @@ <para>Press <emphasis> <property>Finish</property> </emphasis> to create the configuration file, after optionally creating a Console - onfiguration, the <emphasis> + configuration, the <emphasis> <property>hibernate.cfg.xml</property> </emphasis> will be automatically opened in an editor. The last option <emphasis> <property>Create Console Configuration</property> @@ -101,7 +101,7 @@ should configure <property>Hibernate</property> 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 + console configurations. Normally you would just need one per project, but more is definitely possible.</para> <para>You create a console configuration by running the Console Configuration wizard, shown in @@ -137,7 +137,7 @@ <property>Classpath</property> </emphasis> for classpath and <emphasis> <property>Mappings</property> - </emphasis> for additional mappings. The two latter ones is normally not required if you + </emphasis> for additional mappings. The two latter ones are normally not required if you specify a project and it has <emphasis> <property> <literal> /hibernate.cfg.xml </literal> @@ -516,7 +516,7 @@ </mediaobject> </figure> - <para>The first time you create a code generation launcher you should give it a meaningfull + <para>The first time you create a code generation launcher you should give it a meaningful name, otherwise the default prefix <emphasis> <property>New_Generation</property> </emphasis> will be used.</para> @@ -633,7 +633,7 @@ <entry> <para>If reveng.xml does not provide enough customization you can provide your own implementation of an ReverseEngineeringStrategy. The class need to be in the - claspath of the Console Configuration, otherwise you will get class not found + classpath of the Console Configuration, otherwise you will get class not found exceptions. See <xref linkend="custom-reveng-strategy"/> for details and an example of a custom strategy.</para> </entry> @@ -778,7 +778,7 @@ </entry> <entry> - <para>Generate a hibernate.cfg.xml file. Used to keep the hibernate.cfg.xml uptodate + <para>Generate a hibernate.cfg.xml file. Used to keep the hibernate.cfg.xml update with any new found mapping files.</para> </entry> </row> @@ -812,7 +812,7 @@ <para>Each Exporter listens to certain properties and these can be setup in the <emphasis> <property>Properties</property> </emphasis> 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> + the exporters. The following table lists the time of writing predefined properties:</para> <para> <table> @@ -937,7 +937,7 @@ <property>hbm.xml </property> </emphasis> and <emphasis> <property>cfg.xml</property> - </emphasis> files. The editor is based on the Eclipse WTP tools and extend its functionallity + </emphasis> files. The editor is based on the Eclipse WTP tools and extend its functionality to provide Hibernate specific code completion.</para> <figure> @@ -968,7 +968,7 @@ </emphasis> files to the relevant class/field in java code.</para> <figure> - <title>Navigation Functionallity</title> + <title>Navigation Functionality</title> <para> <mediaobject> <imageobject role="fo"> @@ -991,7 +991,7 @@ </para> </figure> - <para>This is done via the standard hyperlink navigation functionallity in Eclipse; per + <para>This is done via the standard hyperlink navigation functionality in Eclipse; per default it is done by pressing F3 while the cursor is on a class/field or by pressing <emphasis> <property>Ctrl</property> </emphasis> and the mouse button to perform the same navigation.</para> @@ -1079,7 +1079,7 @@ <para>Note that not all the features of the <emphasis> <property>.reveng.xml</property></emphasis> file is exposed or fully implemented in - the editor, but the main functionallity is there. To understand the full flexibility of the + 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> @@ -1090,7 +1090,7 @@ <property>Ctrl+N</property></emphasis> or via the code generation launcher.</para> - <para>The following screentshot shows the <emphasis> + <para>The following screenshot shows the <emphasis> <property>Overview</property></emphasis> page where the wanted console configuration is selected (auto-detected if Hibernate 3 support is enabled for the project)</para> @@ -1239,7 +1239,7 @@ <para>Errors during creation of the <literal>SessionFactory</literal> or running the queries (e.g. if your configuration or query is incorrect) will be shown in a message dialog or - inlined in the view that detected the error, you may get more information about the error in + inclined in the view that detected the error, you may get more information about the error in the Error Log view on the right pane.</para> <para>Results of a query will be shown in the Query result view and details of possible errors Modified: trunk/hibernatetools/docs/reference/en/modules/reverseengineering.xml =================================================================== --- trunk/hibernatetools/docs/reference/en/modules/reverseengineering.xml 2007-12-29 15:10:27 UTC (rev 5486) +++ trunk/hibernatetools/docs/reference/en/modules/reverseengineering.xml 2008-01-03 12:41:58 UTC (rev 5487) @@ -41,7 +41,7 @@ filtering. This file can be created by hand (its just basic XML) or you can use the Hibernate plugins which have a specialized editor.</para> - <note><para>Many databases is case-sensitive with their names and thus if + <note><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></note> @@ -178,7 +178,7 @@ /> </type-mapping>]]></programlisting> - <para>The number of attributes specificed and the sequence of the + <para>The number of attributes specified and the sequence of the <literal>sql-type</literal>'s is important. Meaning that <property>Hibernate</property> will search for the most specific first, and if no specific match is found it will seek from top to bottom when trying to resolve a type @@ -290,7 +290,7 @@ <entry>char</entry> <entry>Even though there is a generic match for VARCHAR, the - more specifc type-mapping for VARCHAR with not-null="false" is + more specific type-mapping for VARCHAR with not-null="false" is chosen. The first VARCHAR sql-type matches in length but has no value for not-null and thus is not considered.</entry> </row> @@ -356,9 +356,9 @@ <title>Table filters (&lt;table-filter&gt;)</title> <para>The <emphasis> - <property>&lt;table-filter&gt;</property></emphasis> let you specifcy matching rules for + <property>&lt;table-filter&gt;</property></emphasis> let you specify matching rules for performing general filtering/setup for tables, e.g. let you include or - exclude specific tables based on the schema or even a specifc + exclude specific tables based on the schema or even a specific prefix.</para> <programlistingco> @@ -493,7 +493,7 @@ <callout arearefs="pk-generatorclass"> <para>generator/class (Optional): defines which identifier generator should be used. The class name is any hibernate short - hand name or fully quailfied class name for an identifier + hand name or fully qualified class name for an identifier strategy.</para> </callout>