Author: jgbutler
Date: Mon Jul 17 14:43:22 2006
New Revision: 422890
URL: http://svn.apache.org/viewvc?rev=422890&view=rev
Log:
More Abator documentation 0.7.0 Updates
Modified:
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/buildingFromSVN.html
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/eclipseui.html
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/quickstart.html
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/releasenotes.html
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/roadmap.html
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/toc.xml
Modified:
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/buildingFromSVN.html
URL:
http://svn.apache.org/viewvc/ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/buildingFromSVN.html?rev=422890&r1=422889&r2=422890&view=diff
==============================================================================
---
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/buildingFromSVN.html
(original)
+++
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/buildingFromSVN.html
Mon Jul 17 14:43:22 2006
@@ -1,7 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";>
-<html>
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3c.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";>
+
+<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
<head>
<title>Abator Feature Debug Reference</title>
+ <link type="text/css" rel="stylesheet" href="../core/htmldoc/abator.css"/>
</head>
<body>
<h1>Abator Feature Debug Reference</h1>
@@ -71,12 +75,11 @@
you did the SVN checkout (for example, /Abator/source/eclipse)</li>
<li>Select the four projects under the directory, do not copy the
projects into
your workspace. The filled out wizard looks like this: <br />
- <p><img src="importWizard.gif"/></p>
+ <p><img src="importWizard.gif" alt="Eclipse Project Import
Wizard"/></p>
</li>
<li>Press "Finish", wait for the workspace to build.</li>
</ol>
</li>
- <p />
<li>Note that there may be errors in the build depending on which JDK you
have installed
(for the official release, Abator is compiled with JDK 1.4.2).
If you see an error stating that <code>java.lang.Object</code> cannot be
resolved,
@@ -95,6 +98,7 @@
the errors should be removed. You may see warnings in the workspace,
but you
can ignore them</li>
</ol>
+ </li>
</ol>
<h2>Debugging</h2>
@@ -146,7 +150,30 @@
in the <code>org.apache.ibatis.abator.doc</code> project (an Ant build
file).</p>
<h2>Building the Abator Core JAR in Eclipse</h2>
+<p>If you would like to debug the Abator core JAR, then you can create a
+Java project for the core JAR by following these steps:</p>
+<ol>
+ <li>Start the Eclipse new project wizard
+ (File>New>Project...)
+ </li>
+ <li>Select the "Java Project from Existing Ant Buildfile" wizard, press
"Next"</li>
+ <li>Browse to the "build.xml" file in the checked out project (for example
+ /Abator/source/core/build\build.xml). Accept the default for the
+ other fields and press "Finish".</li>
+ <li>Wait for the workspace to build.</li>
+</ol>
+<p>Note that Abator is compiled with JDK 1.4.2 for distribution. If you are
using a
+JSE 5.0 or later compiler you will see many warnings in the workspace related
to
+type safety. To disable these warnings, set the compiler compliance level for
the
+new project to 1.4.</p>
+
+<p>If you make a change in the Abator core files, you can use the
<code>buildAbator.xml</code>
+Ant build file in the <code>org.apache.ibatis.abator.core</code> project to
update the
+JAR in the plug-in. If you have both a JDK 1.4 and JDK 5.0 installed on your
machine,
+there could be errors when running this build file. To fix the errors, make
sure
+that the JRE for the "Abator for iBATIS" project is set to the 1.4.2 JRE. You
might need
+to configure a new JRE in Eclipse to make this happen.</p>
</body>
</html>
Modified:
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/eclipseui.html
URL:
http://svn.apache.org/viewvc/ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/eclipseui.html?rev=422890&r1=422889&r2=422890&view=diff
==============================================================================
---
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/eclipseui.html
(original)
+++
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/eclipseui.html
Mon Jul 17 14:43:22 2006
@@ -1,12 +1,16 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";>
-<html>
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3c.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";>
+
+<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
<head>
<title>Using the Eclipse User Interface for Abator</title>
+ <link type="text/css" rel="stylesheet" href="../core/htmldoc/abator.css"/>
</head>
<body>
<h1>Using the Eclipse User Interface for Abator</h1>
<p>See the <a href="quickstart.html">Quickstart Guide</a> for a quick
start!</p>
-<p>The Abator user interface consistes of these elemsnts</p>
+<p>The Abator user interface consists of these elements</p>
<ul>
<li>A custom editor for Abator configuration files</li>
<li>A new file wizard for creating configuration files</li>
@@ -17,14 +21,14 @@
<h2>Configuration File Editor</h2>
<p>The configuration file editor is a low function editor. In this release,
it only provides
enough functionality to be somewhat better than a plain text editor (like
some color
- syntax hilighting). In future releases we hope to add more function to
this editor.
+ syntax highlighting). In future releases we hope to add more function to
this editor.
If you have some better XML file editor available in your environment, it
will likely be
a better than this editor. The editor is useful in a very basic Eclipse
installation
which has no other XML editor.</p>
-
-<p>The editor is automatically associated with files named "abatorConfig.xml".
If you
+
+<p>The editor is automatically associated with files named "abatorConfig.xml".
If you
are using a very basic Eclipse install, you might consider associating this
editor
- with any XML file. In the Eclipse 3.1 version of the plugin, we will
associate the
+ with any XML file. In the Eclipse 3.1 version of the plug-in, we will
associate the
editor with any Abator configuration file, regardless of the file name.</p>
<h2>New Configuration File Wizard</h2>
@@ -35,23 +39,23 @@
<p>You can access the wizard from the menu: "File>New>Abator for iBATIS
Configuration File"</p>
<h2>Run Abator Action</h2>
-<p>The run Abator action is the heart of the Eclipse user interface. The
plugin will
+<p>The run Abator action is the heart of the Eclipse user interface. The
plug-in will
add a popup menu option called "Generate iBATIS Artifacts" to any XML file
that has the
root element of "abatorConfiguration". To run Abator, right click on an
Abator
configuration file in any view and select the menu option.</p>
<h2>Integrated Ant Task</h2>
-<p>The Abator plugin declares an Ant task for use within the Eclipse JRE. The
- task is called "abator.generate". Here is en example Ant build file:
+<p>The Abator plug-in declares an Ant task for use within the Eclipse JRE. The
+ task is called "abator.generate". Here is en example Ant build file:</p>
-<pre>
+<pre>
<project default="runAbator">
<target name="runAbator">
- <eclipse.convertPath
resourcepath="AbatorTest/src/config/abatorConfig.xml"
+ <eclipse.convertPath
resourcepath="AbatorTest/src/config/abatorConfig.xml"
property="thePath"/>
<abator.generate configfile="${thePath}" />
</target>
-</project>
+</project>
</pre>
<p>This file uses the Eclipse supplied "eclipse.convertPath" task to calculate
the
actual path of the configuration file. Then we use the "abator.generate"
task to
Modified:
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/quickstart.html
URL:
http://svn.apache.org/viewvc/ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/quickstart.html?rev=422890&r1=422889&r2=422890&view=diff
==============================================================================
---
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/quickstart.html
(original)
+++
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/quickstart.html
Mon Jul 17 14:43:22 2006
@@ -1,20 +1,25 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";>
-<html>
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3c.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";>
+
+<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
<head>
<title>Abator for Eclipse Quick Start Guide</title>
+ <link type="text/css" rel="stylesheet" href="../core/htmldoc/abator.css"/>
</head>
<body>
<h1>Abator for Eclipse Quick Start Guide</h1>
<p>To get up and running quickly with Abator in the Eclipse environment,
follow these steps:</p>
<ol>
- <li>Create an Abator configuration file:</li>
- <ol>
+ <li>Create an Abator configuration file:
+ <ol type="a">
<li>File>New>Abator for iBATIS Configuration File</li>
<li>Specify the location of the file, and the name of the file (defaults
to abatorConfig.xml)</li>
<li>Finish the wizard</li>
</ol>
- <li>Fill out the configuration file appropriately. At a minimum, you must
specify:</li>
- <ol>
+ </li>
+ <li>Fill out the configuration file appropriately. At a minimum, you must
specify:
+ <ol type="a">
<li>jdbcConnection information to specify how to connect to the target
database</li>
<li>A target package, and target project for the javaModelGenerator</li>
<li>A target package, and target project for the sqlMapGenerator</li>
@@ -22,6 +27,7 @@
daoGenerator element if you don't wish to generate DAOs)</li>
<li>At least one database table</li>
</ol>
+ </li>
<li>Save the file</li>
<li>Right click on the configuration file in Eclipse's navigator, or package
explorer, view and take the
menu option to "Generate iBATIS Artifacts"</li>
@@ -33,9 +39,9 @@
<li>Abator does supply a custom editor for Abator configuration files, but
it is very low
function and currently only associated with files named
"abatorConfig.xml". With
Eclipse 3.1, the editor will be more full function. If you are using
RAD/RSA, then
- the included XML editor is much more useful. Or if you use some other
XML plugin (like
+ the included XML editor is much more useful. Or if you use some other
XML plug-in (like
XML Buddy),
- it it likely that the editor supplied with the plugin will be more
useful.</li>
+ it is likely that the editor supplied with the plug-in will be more
useful.</li>
</ol>
</body>
</html>
Modified:
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/releasenotes.html
URL:
http://svn.apache.org/viewvc/ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/releasenotes.html?rev=422890&r1=422889&r2=422890&view=diff
==============================================================================
---
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/releasenotes.html
(original)
+++
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/releasenotes.html
Mon Jul 17 14:43:22 2006
@@ -1,7 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";>
-<html>
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3c.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";>
+
+<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
<head>
<title>Abator Eclipse Feature Release Notes</title>
+ <link type="text/css" rel="stylesheet" href="../core/htmldoc/abator.css"/>
</head>
<body>
<h1>Abator Eclipse Feature Release Notes</h1>
@@ -13,7 +17,7 @@
<li>Fixed bug where multi-segment source paths failed</li>
<li>Use an adaptable type to associate Abator configuration files with the
popup menu items instead of content type. This should resolve conflicts
- with other plugins like oXygen</li>
+ with other plug-ins like oXygen</li>
</ul>
<h2>Version 0.6.5</h2>
@@ -25,7 +29,7 @@
<h2>Version 0.6.2</h2>
<ul>
<li>Made our content type high priority to avoid conflicts with other XML
- enabled plugins</li>
+ enabled plug-ins</li>
</ul>
<h2>Version 0.6.1</h2>
Modified:
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/roadmap.html
URL:
http://svn.apache.org/viewvc/ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/roadmap.html?rev=422890&r1=422889&r2=422890&view=diff
==============================================================================
---
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/roadmap.html
(original)
+++
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/html/roadmap.html
Mon Jul 17 14:43:22 2006
@@ -1,7 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";>
-<html>
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3c.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";>
+
+<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
<head>
<title>Abator for Eclipse Roadmap</title>
+ <link type="text/css" rel="stylesheet" href="../core/htmldoc/abator.css"/>
</head>
<body>
<h1>Abator for Eclipse Roadmap</h1>
Modified:
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/toc.xml
URL:
http://svn.apache.org/viewvc/ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/toc.xml?rev=422890&r1=422889&r2=422890&view=diff
==============================================================================
---
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/toc.xml
(original)
+++
ibatis/trunk/java/mapper/mapper2/tools/abator/eclipse/org.apache.ibatis.abator.doc/toc.xml
Mon Jul 17 14:43:22 2006
@@ -7,7 +7,7 @@
<topic label="Using the Eclipse User Interface"
href="html/eclipseui.html"/>
<topic label="Plugin Future Roadmap" href="html/roadmap.html"/>
<topic label="Plugin Release Notes" href="html/releasenotes.html"/>
- <topic label="Building the Plugins from Subversion"
href="html/buildingFromSVN.html"/>
+ <topic label="Abator Feature Debug Reference"
href="html/buildingFromSVN.html"/>
</topic>
<topic label="Core Abator Documentation">
