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

Author: afedosik Date: 2008-01-04 06:20:31 -0500 (Fri, 04 Jan 2008) New Revision: 5505 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 trunk/hibernatetools/docs/reference/en/modules/setup.xml Log: Spelling and grammer in Guide are corrected. [ Show ?\194?\187 ] Catherine Luts [03/Jan/08 07:42 AM] Spelling and grammer in Guide are corrected. Modified: trunk/hibernatetools/docs/reference/en/modules/ant.xml =================================================================== --- trunk/hibernatetools/docs/reference/en/modules/ant.xml 2008-01-04 11:01:05 UTC (rev 5504) +++ trunk/hibernatetools/docs/reference/en/modules/ant.xml 2008-01-04 11:20:31 UTC (rev 5505) @@ -12,17 +12,17 @@ from tools.hibernate.org The <emphasis> <property>hibernate-tools.jar</property> </emphasis> is located in your eclipse plugins directory at <emphasis> - <property>/plugins/org.hibernate.eclipse.x.x.x/lib/tools/hibernate-tools.jar. + <property>/plugins/org.hibernate.eclipse.x.x.x/lib/tools/hibernate-tools.jar </property> </emphasis></para> - <para>This jar is 100% independent from the eclipse platform and can thus be used + <para>. This jar is 100% independent from the eclipse platform and can thus be used independently of eclipse.</para> <note> - <para>There might be incompabilities with respect to the Hibernate3.jar bundled with the tools + <para>There might be incapabilities 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 &amp; hibernate-annotations.jar bundled with the tools when you want to use the Ant - tasks. Do not worry about using e.g. Hibernate 3.2 jar's with e.g. an Hibernate 3.1 project + tasks. Do not worry about using e.g. Hibernate 3.2 jar's with e.g. a Hibernate 3.1 project since the output generated will work with previous Hibernate 3 versions. </para> </note> </section> @@ -46,11 +46,11 @@ classpathref="toolslib" /> ]]></programlisting></para> - <para>this <emphasis> + <para>This <emphasis> <property> <literal>&lt;taskdef&gt;</literal> </property> - </emphasis> defines a Ant task called <emphasis> + </emphasis> defines an Ant task called <emphasis> <property> <literal>&lt;hibernatetool&gt;</literal> </property> @@ -101,12 +101,12 @@ <calloutlist> <callout arearefs="ht1"> <para><literal>destdir</literal> (required): destination directory for files generated - with exporters.</para> + with exporters</para> </callout> <callout arearefs="ht2"> <para><literal>templatepath</literal> (optional): A path to be used to look up - user-edited templates.</para> + user-edited templates</para> </callout> <callout arearefs="ht3"> @@ -122,7 +122,7 @@ <callout arearefs="ht5"> <para>One of 4 different ways of configuring the Hibernate Meta Model must be - specified.</para> + specified</para> </callout> <callout arearefs="ht6"> @@ -138,9 +138,9 @@ <para>The following example shows the most basic setup for generating pojo's via <literal>hbm2java</literal> from a normal <emphasis> <property> - <literal>hibernate.cfg.xml.</literal> + <literal>hibernate.cfg.xml</literal> </property> - </emphasis> The output will be put in the <emphasis> + </emphasis>. The output will be put in the <emphasis> <property>${build.dir}/generated</property></emphasis> directory.</para> @@ -188,7 +188,7 @@ <section> <title>Hibernate Configurations</title> - <para><literal>hibernatetool</literal> supports four different Hibernate configurations: A + <para><literal>Hibernatetool</literal> supports four different Hibernate configurations: A standard Hibernate configuration (<emphasis> <property>&lt;configuration&gt;</property> </emphasis>), Annotation based configuration (<emphasis> @@ -315,7 +315,7 @@ <property>&lt;taskdef&gt;</property></emphasis>.</para> <para>The <emphasis> - <property>&lt;annotationconfiguration&gt;</property></emphasis> supports the same attributes as an + <property>&lt;annotationconfiguration&gt;</property></emphasis> supports the same attributes as a <emphasis> <property>&lt;configuration&gt;</property></emphasis> except that the configurationfile attribute is now required as that is from where an <literal>AnnotationConfiguration</literal> gets the list of @@ -338,14 +338,14 @@ <section> <title>JPA based configuration (&lt;jpaconfiguration&gt;)</title> - <para>An <emphasis> + <para>A <emphasis> <property>&lt;jpaconfiguration&gt;</property></emphasis> is used when you want to read the metamodel from JPA/Hibernate Annotation where you want to use the auto-scan configuration as defined in the JPA spec (part of EJB3). In other words, when you do not have a <emphasis> <property>hibernate.cfg.xml</property></emphasis>, but instead have a setup where you use a <emphasis> - <property>persistence.xml</property></emphasis> packaged in an JPA compliant manner.</para> + <property>persistence.xml</property></emphasis> packaged in a JPA compliant manner.</para> <para><literal>&lt;jpaconfiguration&gt;</literal> will simply just try and auto-configure it self based on the available classpath, e.g. look for @@ -354,10 +354,10 @@ <para>The <literal>persistenceunit</literal> attribute can be used to select a specific persistence unit. If no persistenceunit is specified it will automatically search for one - and if a unique one is found use it, but if multiple persistence units are available it will + and if an unique one is found use it, but if multiple persistence units are available it will error.</para> - <para>To use an <emphasis> + <para>To use a <emphasis> <property>&lt;jpaconfiguration&gt;</property></emphasis> you will need to specify some additional jars from Hibernate EntityManager in the <emphasis> <property>&lt;taskdef&gt;</property></emphasis> of the hibernatetool. The @@ -721,7 +721,7 @@ <callout arearefs="qcfg1"> <para>ejb3 (default: false): the generated cfg.xml will have &lt;mapping class=".."/&gt;, opposed to &lt;mapping resource="..."/&gt; for each - mapping.</para> + mapping</para> </callout> </calloutlist> </programlistingco> @@ -792,7 +792,7 @@ <section id="hbmtemplate"> <title>Generic Hibernate metamodel exporter (<literal>&lt;hbmtemplate&gt;</literal>)</title> - <para>Generic exporter that can be controlled by a user provided template or class.</para> + <para>Generic exporter that can be controlled by an user provided template or class.</para> <programlisting><![CDATA[<hbmtemplate filepattern="{package-name}/{class-name}.ftl" @@ -852,7 +852,7 @@ <property>&lt;property&gt;</property></emphasis> allows you bind a string value to a key. The value will be available in the templates via $&lt;key&gt;. The following example will assign the string value <emphasis> - <property>&quot;true&quot;</property></emphasis> to the variable <literal>$descriptors</literal></para> + <property>&quot;true&quot;</property></emphasis> to the variable <literal>$descriptors.</literal></para> <programlisting><![CDATA[<property key="descriptors" value="true"/>]]></programlisting> Modified: trunk/hibernatetools/docs/reference/en/modules/codegen.xml =================================================================== --- trunk/hibernatetools/docs/reference/en/modules/codegen.xml 2008-01-04 11:01:05 UTC (rev 5504) +++ trunk/hibernatetools/docs/reference/en/modules/codegen.xml 2008-01-04 11:20:31 UTC (rev 5505) @@ -288,7 +288,7 @@ &lt;/class&gt; &lt;/hibernate-mapping&gt;</programlisting> - <para>and for <emphasis> + <para>And for <emphasis> <property>Event.hbm</property></emphasis> file:</para> <programlisting>&lt;hibernate-mapping&gt; @@ -317,7 +317,7 @@ will include the other part (if at all) in the <literal>toString()/equals()</literal> methods. Therefore it is not a good practice to put at class scope such meta attributes, unless you - are defining a class without bi-directional associations</para> + are defining a class without bi-directional associations.</para> <para>We recomend instead to add the <literal>meta</literal> attributes at the property level:</para> @@ -426,7 +426,7 @@ accessors for pojo's.</para> <para>Extract the <emphasis> - <property>PojoPropertyAccessor.ftl</property></emphasis> into a + <property>PojoPropertyAccessor.ftl</property></emphasis> into a local folder i.e. <emphasis> <property>${hbm.template.path}</property></emphasis>, respecting the whole path, for example: @@ -495,9 +495,9 @@ &lt;/class&gt; &lt;/hibernate-mapping&gt;</programlisting> - <note> <para>i) If you don'&apos; use <literal>&lt;[[CDATA[]]&gt;</literal> + <note> <para>I) If you don'&apos; use <literal>&lt;[[CDATA[]]&gt;</literal> you have to scape the &amp; symbol, i.e.: &amp;amp; </para> - <para>ii). Note that we + <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 "this.firstName" instead. </para> @@ -532,7 +532,7 @@ <para>Invoking the target <emphasis> <property>&lt;hbm2java&gt;</property></emphasis> will generate on the <emphasis> - <property>${hbm2java.dest.dir}</property></emphasis> the file: + <property>${hbm2java.dest.dir}</property></emphasis> the file <property>Person.java</property>:</para> <programlisting>// default package Modified: trunk/hibernatetools/docs/reference/en/modules/codegenarchitecture.xml =================================================================== --- trunk/hibernatetools/docs/reference/en/modules/codegenarchitecture.xml 2008-01-04 11:01:05 UTC (rev 5504) +++ trunk/hibernatetools/docs/reference/en/modules/codegenarchitecture.xml 2008-01-04 11:20:31 UTC (rev 5505) @@ -33,7 +33,7 @@ </listitem> <listitem> - <para>A <emphasis> + <para>An <emphasis> <property>Annotation configuration</property> </emphasis> uses Hibernate Annotations and supports <emphasis> <property>hbm.xml</property> Modified: trunk/hibernatetools/docs/reference/en/modules/plugins.xml =================================================================== --- trunk/hibernatetools/docs/reference/en/modules/plugins.xml 2008-01-04 11:01:05 UTC (rev 5504) +++ trunk/hibernatetools/docs/reference/en/modules/plugins.xml 2008-01-04 11:20:31 UTC (rev 5505) @@ -367,7 +367,7 @@ <entry> <para>When enabled the project classpath will be appended to the classpath specified - above.</para> + above</para> </entry> <entry> @@ -569,7 +569,7 @@ <entry> <para>The name of the console configuration which should be used when code - generating.</para> + generating</para> </entry> </row> @@ -606,7 +606,7 @@ <entry> <para>The package name here is used as the default package name for any entities - found when reverse engineering.</para> + found when reverse engineering</para> </entry> </row> @@ -687,7 +687,7 @@ </entry> <entry> - <para>A path to a directory with custom templates.</para> + <para>A path to a directory with custom templates</para> </entry> </row> </tbody> @@ -768,7 +768,7 @@ </entry> <entry> - <para>Generate mapping (hbm.xml) files for each entity</para> + <para>Generate mapping (hbm.xml) files for each entity.</para> </entry> </row> @@ -907,7 +907,7 @@ <entry> <para>Pattern to use for the generated files, relatively for the output dir. - Example: {package-name}/{class-name}.java</para> + Example: {package-name}/{class-name}.java .</para> </entry> </row> @@ -919,7 +919,7 @@ </entry> <entry> - <para>executable to run GraphViz (only relevant, but optional for Schema + <para>Executable to run GraphViz (only relevant, but optional for Schema documentation)</para> </entry> </row> @@ -1068,7 +1068,7 @@ <title>Reveng.xml editor</title> <para>A <emphasis> - <property>reveng.xml</property></emphasis> + <property>reveng.xml </property></emphasis> file is used to customize and control how reverse engineering is performed by the tools. The plugins provide and editor to ease the editing of this file and hence used to configure the reverse engineering process.</para> @@ -1078,15 +1078,15 @@ default naming rules is not applicable.</para> <para>Note that not all the features of the <emphasis> - <property>.reveng.xml</property></emphasis> file is exposed or fully implemented in + <property>.reveng.xml </property></emphasis> file is 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> <para>The editor is activated as soon as an <emphasis> - <property>.reveng.xml</property></emphasis> file is opened. To get an initial + <property>.reveng.xml </property></emphasis> file is opened. To get an initial <emphasis> - <property>reveng.xml</property></emphasis> file the reveng.xml wizard can be started via <emphasis> + <property>reveng.xml </property></emphasis> file the reveng.xml wizard can be started via <emphasis> <property>Ctrl+N</property></emphasis> or via the code generation launcher.</para> @@ -1190,7 +1190,7 @@ </figure> <para><property>Hibernate Console</property> perspective shows entity structure, query editor and - result</para> + result.</para> <para>The console configuration does not dynamically adjust to changes done in mappings and @@ -1202,7 +1202,7 @@ <title>Mapping Diagram</title> <para>A mapping diagram for entities are available by right clicking on the entity you want - an mapping diagram for and then choose <emphasis> + a mapping diagram for and then choose <emphasis> <property>Open Mapping Diagram</property></emphasis></para> <figure> Modified: trunk/hibernatetools/docs/reference/en/modules/reverseengineering.xml =================================================================== --- trunk/hibernatetools/docs/reference/en/modules/reverseengineering.xml 2008-01-04 11:01:05 UTC (rev 5504) +++ trunk/hibernatetools/docs/reference/en/modules/reverseengineering.xml 2008-01-04 11:20:31 UTC (rev 5505) @@ -129,7 +129,7 @@ <programlisting><![CDATA[<schema-selection/>]]></programlisting> - <para>which in turn is equal to:</para> + <para>Which in turn is equal to:</para> <programlisting><![CDATA[<schema-selection match-catalog=".*" match-schema=".*" match-table=".*"/>]]></programlisting> @@ -309,7 +309,7 @@ <entry>java.lang.Character</entry> <entry>The most specific VARCHAR with not-null="true" is - selected.</entry> + selected</entry> </row> <row> @@ -445,11 +445,11 @@ <calloutlist> <callout arearefs="tablefilter-matchcatalog"> - <para>catalog (Optional): Catalog name for table. Has to be specified if you are reverse engineering multiple catalogs or if it is not equal to <literal>hiberante.default_catalog</literal></para> + <para>catalog (Optional): Catalog name for table. Has to be specified if you are reverse engineering multiple catalogs or if it is not equal to <literal>hiberante.default_catalog. </literal></para> </callout> <callout arearefs="tablefilter-matchschema"> - <para>schema (Optional): Schema name for table. Has to be specified if you are reverse engineering multiple schemas or if it is not equal to <literal>hiberante.default_schema</literal></para> + <para>schema (Optional): Schema name for table. Has to be specified if you are reverse engineering multiple schemas or if it is not equal to <literal>hiberante.default_schema.</literal></para> </callout> <callout arearefs="tablefilter-matchname"> @@ -555,17 +555,17 @@ <callout arearefs="column-type"> <para>type (Optional): Which hibernate-type to use for this - specific column.</para> + specific column</para> </callout> <callout arearefs="column-propertytype"> <para>property (Optional): What property name will be - generated for this column.</para> + generated for this column</para> </callout> <callout arearefs="column-exclude"> <para>exclude (default: false): set to true if this column - should be ignored.</para> + should be ignored</para> </callout> </calloutlist> </programlistingco></para> @@ -581,7 +581,7 @@ name of the resulting properties (many-to-one and one-to-many's).</para> - <para>Note</para> + <para>Note:</para> <para><programlistingco> <areaspec> @@ -626,26 +626,26 @@ <callout arearefs="foreignkey-catalog"> <para>foreign-catalog (Optional): Name of the foreign table's catalog. (Only relevant if you want to explicitly define a - foreign key)</para> + foreign key).</para> </callout> <callout arearefs="foreignkey-schema"> <para>foreign-schema (Optional): Name of the foreign table's schema. (Only relevant if you want to explicitly define a - foreign key)</para> + foreign key).</para> </callout> <callout arearefs="foreignkey-table"> <para>foreign-table (Optional): Name of the foreign table. (Only relevant if you want to explicitly define a foreign - key)</para> + key).</para> </callout> <callout arearefs="foreignkey-columnref"> <para>column-ref (Optional): Defines that the foreign-key constraint between a local-column and foreign-column name. (Only relevant if you want to explicitly define a foreign - key)</para> + key).</para> </callout> <callout arearefs="foreignkey-manytoone"> @@ -670,7 +670,7 @@ <section id="custom-reveng-strategy"> <title>Custom strategy</title> - <para>It is possible to implement a user strategy. Such strategy must + <para>It is possible to implement an user strategy. Such strategy must implement <emphasis> <property>org.hibernate.cfg.reveng.ReverseEngineeringStrategy</property></emphasis>. It is recommended that one uses the <property>DelegatingReverseEngineeringStrategy</property> and Modified: trunk/hibernatetools/docs/reference/en/modules/setup.xml =================================================================== --- trunk/hibernatetools/docs/reference/en/modules/setup.xml 2008-01-04 11:01:05 UTC (rev 5504) +++ trunk/hibernatetools/docs/reference/en/modules/setup.xml 2008-01-04 11:20:31 UTC (rev 5505) @@ -3,8 +3,8 @@ <title>Download and install Hibernate Tools</title> <para><property>Hibernate Tools</property> can be used &quot;standalone&quot; via Ant - 1.6.x or fully integrated into a Eclipse 3.3.x + WTP 2.x based IDE, such as <property>JBoss - Tools</property> or an default Eclipse 3.3.x + WTP 2.x installation. The following describes + 1.6.x or fully integrated into an Eclipse 3.3.x + WTP 2.x based IDE, such as <property>JBoss + Tools</property> or a default Eclipse 3.3.x + WTP 2.x installation. The following describes the install steps in these environments.</para> <section> @@ -69,7 +69,7 @@ <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 <emphasis> + directory at <emphasis> <property> <literal>/plugins/org.hibernate.eclipse.x.x.x/lib/tools/.</literal> </property>