Author: mcaspers
Date: 2011-01-09 23:55:15 -0500 (Sun, 09 Jan 2011)
New Revision: 28026
Modified:
trunk/hibernatetools/docs/reference/en-US/codegen.xml
trunk/hibernatetools/docs/reference/en-US/codegenarchitecture.xml
trunk/hibernatetools/docs/reference/en-US/introduction.xml
trunk/hibernatetools/docs/reference/en-US/plugins.xml
trunk/hibernatetools/docs/reference/en-US/setup.xml
Log:
updated tags
Modified: trunk/hibernatetools/docs/reference/en-US/codegen.xml
===================================================================
--- trunk/hibernatetools/docs/reference/en-US/codegen.xml 2011-01-10 04:46:07 UTC (rev
28025)
+++ trunk/hibernatetools/docs/reference/en-US/codegen.xml 2011-01-10 04:55:15 UTC (rev
28026)
@@ -597,7 +597,7 @@
<para>In conclusion, this document is intended to introduce you to
Hibernate plugin specific
features related to tools bath for the Eclipse and Ant tasks.</para>
- <para>In the <link linkend="plugins">Eclipse
Plugins</link> chapter you've learnt
+ <para>In the <xref linkend="plugins"/> chapter
you've learnt
about a set of wizards for creating Mapping files, Configuration file, Console
Configuration, got familiar with Mapping and Configuration files editors,
tooling for
organizing and controlling Reverse Engineering, Hibernate Console and Mapping
diagram as
Modified: trunk/hibernatetools/docs/reference/en-US/codegenarchitecture.xml
===================================================================
--- trunk/hibernatetools/docs/reference/en-US/codegenarchitecture.xml 2011-01-10 04:46:07
UTC (rev 28025)
+++ trunk/hibernatetools/docs/reference/en-US/codegenarchitecture.xml 2011-01-10 04:55:15
UTC (rev 28026)
@@ -102,8 +102,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 <link
linkend="ant">Ant Tools</link>
- and <link linkend="plugins">Eclipse Plugins</link>
chapters.</para>
+ Eclipse UI. Documentation for these Exporters is in the <xref
linkend="ant"/>
+ and <xref linkend="plugins"/> 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-US/introduction.xml
===================================================================
--- trunk/hibernatetools/docs/reference/en-US/introduction.xml 2011-01-10 04:46:07 UTC
(rev 28025)
+++ trunk/hibernatetools/docs/reference/en-US/introduction.xml 2011-01-10 04:55:15 UTC
(rev 28026)
@@ -42,7 +42,7 @@
engineering, schema generation and generation of other
artifacts
during the build process.</para>
</entry>
- <entry><link linkend="ant">ant
task</link></entry>
+ <entry><xref linkend="ant"/></entry>
</row>
<row>
@@ -59,9 +59,9 @@
there is even support for completely reverse engineer an
existing
database schema.</para>
</entry>
- <entry> <link
linkend="map_file_wizard">hibernate mapping file</link>
- <link
linkend="hib_config_file">hibernate configuration file</link>
- <link linkend="code_gen">code
generation</link>
+ <entry> <xref linkend="map_file_wizard"/>
+ <xref linkend="hib_config_file"/>
+ <xref linkend="code_gen"/>
</entry>
</row>
@@ -79,7 +79,7 @@
names, making it much more versatile than a normal XML
editor.</para>
</entry>
- <entry> <link
linkend="map_config_editor">mapping and configuration files
editors</link></entry>
+ <entry> <xref
linkend="map_config_editor"/></entry>
</row>
<row>
@@ -92,8 +92,8 @@
mapping files, annotated EJB3 entity beans, etc. and
reveng.xml file
editor allows to control this processes.</para>
</entry>
- <entry><link linkend="code_gen">code
generation</link>
- <link linkend="rev_xml_editor">reveng.xml
editor</link></entry>
+ <entry><xref linkend="code_gen"/>
+ <xref
linkend="rev_xml_editor"/></entry>
</row>
<row>
@@ -107,7 +107,7 @@
The console allows you to execute HQL queries against
your database
and browse the result directly in Eclipse.</para>
</entry>
- <entry><link
linkend="hib_console">hibernate console</link></entry>
+ <entry><xref
linkend="hib_console"/></entry>
</row>
<row>
@@ -118,7 +118,7 @@
<para>The editors are intended for writing, editing and
executing HQL queries and criterias. They also support the functionality for generating
simple queries.</para>
</entry>
- <entry><link
linkend="hql_and_criteria_editors">hql and hibernate criteria
editors</link></entry>
+ <entry><xref
linkend="hql_and_criteria_editors"/></entry>
</row>
<row>
@@ -129,7 +129,7 @@
<para>Makes possible to visualize structure of entities
and
relationships between them.</para>
</entry>
- <entry><link linkend="map_diagram">mapping
diagram</link></entry>
+ <entry><xref
linkend="map_diagram"/></entry>
</row>
@@ -155,7 +155,7 @@
<title>Other relevant resources on the topic</title>
<!--para>Hibernate Tools page on the <ulink
url="http://www.hibernate.org/255.html">hibernate.org</ul...
- <para>All JBoss Developer Studio/JBoss Tools release documentation you can
find at<ulink
url="http://docs.jboss.org/tools/">http://docs.jboss.org/too...
in the corresponding release directory.</para>
+ <para>All JBoss Developer Studio/JBoss Tools release documentation you can
find at<ulink
url="http://docs.jboss.org/tools/">http://docs.jboss.org/too...
in the corresponding release directory.</para>
<para>There is some extra information about Hidernate on <ulink
url="http://www.jboss.org/community/wiki/JBossHibernate3">JBoss Wiki page.
</ulink></para>
<para>The latest documentation builds are available at <ulink
url="http://download.jboss.org/jbosstools/nightly-docs/">htt...
</section>
Modified: trunk/hibernatetools/docs/reference/en-US/plugins.xml
===================================================================
--- trunk/hibernatetools/docs/reference/en-US/plugins.xml 2011-01-10 04:46:07 UTC (rev
28025)
+++ trunk/hibernatetools/docs/reference/en-US/plugins.xml 2011-01-10 04:55:15 UTC (rev
28026)
@@ -9,8 +9,8 @@
<para>Hibernate Eclipse Tools include wizards for creating Hibernate mapping
files,
configuration files (.cfg.xml), revenge.xml as well as wizards for adjusting
Console
Configuration and Code Generation. Special structured and XML editors, editors for
executing
- HQL and Criteria queries are also provided in Hibernate Console. Refer to <link
- linkend="hibernate_key_features">Key Features</link> section
to find all benefits that you
+ HQL and Criteria queries are also provided in Hibernate Console. Refer to <xref
+ linkend="hibernate_key_features"/> section to find all benefits that
you
can take advantage of while using the tools within Eclipse.</para>
<note>
<title>Note:</title>
@@ -290,7 +290,7 @@
</tbody>
</tgroup>
</table>
- <tip>
+ <note>
<title>Tip:</title>
<para>The two latter settings are usually not required if you specify a
project and it has
<emphasis>
@@ -302,7 +302,7 @@
<literal>/META-INF/persistence.xml</literal>
</property>
</emphasis> in its project classpath.</para>
- </tip>
+ </note>
<itemizedlist>
<listitem>
<para>
@@ -561,8 +561,7 @@
<para> After clicking you will see the Edit Configuration Wizard that is
similar to
<emphasis>
<property>Create Console Configuration</property>
- </emphasis>,described in <link
linkend="creat_console_conf">Creating a Hibernate Console
- Configuration section</link>. </para>
+ </emphasis>,described in <xref
linkend="creat_console_conf"/>. </para>
</listitem>
<listitem>
<para>use Properties view for modifying some of Console Configuration
properties.</para>
@@ -749,12 +748,12 @@
name, otherwise the default prefix <emphasis>
<property>New_Generation</property>
</emphasis> will be used.</para>
- <tip>
+ <note>
<title>Tip:</title>
<para>The "At least one exporter option must be selected"
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>
- </tip>
+ </note>
<para>The dialog also have the standard tabs <emphasis>
<property>Refresh</property>
</emphasis> and <emphasis>
@@ -1195,11 +1194,11 @@
</imageobject>
</mediaobject>
</figure>
- <tip>
+ <note>
<title>Tip:</title>
<para>If the property is a directory, it is possible to browse directories
in the Value
field.</para>
- </tip>
+ </note>
<figure>
<title>Specifying the Property Value</title>
<mediaobject>
@@ -1457,8 +1456,7 @@
<para>Or you can get it via the <property>Code Generation
Launcher</property> by checking the
proper section in the <emphasis>
<property>Main</property>
- </emphasis> tab of the <link linkend="hib_code_gen">Hibernate
Code Generation
- Wizard</link>.</para>
+ </emphasis> tab of the <xref
linkend="hib_code_gen"/>.</para>
<para>The following screenshot shows the <emphasis>
<property>Overview</property>
</emphasis> page where the wanted console configuration is selected
(auto-detected if
@@ -1499,8 +1497,8 @@
(including usertypes) if the default rules are not applicable. Here again to see
the database
tables press <emphasis>
<property>Refresh</property>
- </emphasis> button underneath. More about type mappings you can find further
in the <link
- linkend="type_map">Type Mappings</link> section.</para>
+ </emphasis> button underneath. More about type mappings you can find further
in the <xref
+ linkend="type_map"/> section.</para>
<figure>
<title>Type Mappings Page</title>
<mediaobject>
@@ -1517,8 +1515,7 @@
<property>Table and Columns</property>
</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>
+ tables while reverse engineering read the <xref
linkend="tab_and_col"/> section.</para>
<figure>
<title>Table and Columns Page</title>
<mediaobject>
@@ -1538,8 +1535,8 @@
<title>Hibernate Console Perspective</title>
<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>
+ queries, and see the results. To use this perspective you need to create a
<xref
+ linkend="console_conf"/>.</para>
<section>
<title>Viewing the entity structure</title>
<para>To view your new configuration and entity/class structure, switch to
<property>Hibernate
@@ -1865,11 +1862,11 @@
</tbody>
</tgroup>
</table>
- <tip>
+ <note>
<title>Tip:</title>
<para>All the described types of the context menu are also available in
the <property
Outline</property> view.</para>
-
</tip>
+ </note>
<para>The below table lists the actions that could be performed using the
keyboard keys (or
keys combinations).</para>
<table>
@@ -1946,12 +1943,12 @@
</imageobject>
</mediaobject>
</figure>
- <tip>
+ <note>
<title>Note:</title>
<para>If you restart the Eclipse with the mapping diagram opened, the
mapping diagram will
be restored with the message like on the figure below. To view the diagram
content, you
should perform the refreshing.</para>
- </tip>
+ </note>
<figure>
<title>The Diagram after Restarting the Eclipse</title>
<mediaobject>
@@ -2133,12 +2130,12 @@
</imageobject>
</mediaobject>
</figure>
- <tip>
+ <note>
<title>Tip:</title>
<para>If the context menu items are 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>
- </tip>
+ </note>
<para>When open the editors they should automatically detect the chosen
Console
Configuration.</para>
<para>To get a prefill query for any entity (or any entity child node)
listed in the
@@ -2278,8 +2275,7 @@
</mediaobject>
</figure>
<para>You can also use <property>Properties view</property> when
clicking on the configuration
- itself in Hibernate Configuration View( <link
linkend="modif_console_conf">Modifying a
- Hibernate Console Configuration section</link>). </para>
+ itself in Hibernate Configuration View( <xref
linkend="modif_console_conf"/>). </para>
</section>
</section>
<section id="jpa_annotations">
@@ -2344,8 +2340,7 @@
<listitem>
<para><emphasis>
<property>@Version</property>
- </emphasis> is declared in case you select <link
linkend="optim_lock">Enable optimistic
- locking</link>.</para>
+ </emphasis> is declared in case you select <xref
linkend="optim_lock"/>.</para>
</listitem>
</itemizedlist>
<note>
@@ -2383,7 +2378,7 @@
</figure>
<para>Here you can add one more classes or whole package, moreover you can
limit dependencies
depth by selecting <property>depth control</property> option (more
about this option you will
- find in <link linkend="depth_control">Creating a Hibernate Mapping
File</link>). When finished
+ find in <xref linkend="depth_control"/>). When finished
just press the <property>Next</property> button and you will be
returned to <property>The
following classes will be changed</property> page and will be able to
continue work with
it.</para>
Modified: trunk/hibernatetools/docs/reference/en-US/setup.xml
===================================================================
--- trunk/hibernatetools/docs/reference/en-US/setup.xml 2011-01-10 04:46:07 UTC (rev
28025)
+++ trunk/hibernatetools/docs/reference/en-US/setup.xml 2011-01-10 04:55:15 UTC (rev
28026)
@@ -110,6 +110,6 @@
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>
+ via ant tasks are described in the <xref linkend="ant"/>
chapter.</para>
</section>
</chapter>