Author: schor
Date: Wed Jun 16 20:46:09 2010
New Revision: 955375
URL: http://svn.apache.org/viewvc?rev=955375&view=rev
Log:
[UIMA-1810 UIMA-1811] web site updates for new build, update onetime setup
instructions
Modified:
uima/site/trunk/uima-website/xdocs/building-uima.xml
uima/site/trunk/uima-website/xdocs/distribution.xml
uima/site/trunk/uima-website/xdocs/one-time-setup.xml
uima/site/trunk/uima-website/xdocs/svn.xml
Modified: uima/site/trunk/uima-website/xdocs/building-uima.xml
URL:
http://svn.apache.org/viewvc/uima/site/trunk/uima-website/xdocs/building-uima.xml?rev=955375&r1=955374&r2=955375&view=diff
==============================================================================
--- uima/site/trunk/uima-website/xdocs/building-uima.xml (original)
+++ uima/site/trunk/uima-website/xdocs/building-uima.xml Wed Jun 16 20:46:09
2010
@@ -1,8 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE document [
-<!ENTITY rarr "->" >
-<!ENTITY larr "<-" >
-]>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -48,23 +44,23 @@ under the License.
<subsection name="One time initial setup">
<ul>
<li>
- <a href="one-time-setup.html#svn-setup">SVN: Click here to see the
one-time SVN setup</a>.
+ <a href="one-time-setup.html#svn-setup">SVN: Click here for the one-time
SVN setup</a>.
</li>
<li>
- <a href="one-time-setup.html#maven-setup">Maven: Click here to see the
one-time Maven 3.0 setup</a>.
+ <a href="one-time-setup.html#maven-setup">Maven: Click here for the
one-time Maven 3.0 setup</a>.
</li>
<li>
- <a href="one-time-setup.html#eclipse-setup">Eclipse: Click here to see
the one-time Eclipse setup</a>. This includes
+ <a href="one-time-setup.html#eclipse-setup">Eclipse: Click here for the
one-time Eclipse setup</a>. This includes
setting up m2eclipse plugin (including a patch), and is only needed if
you are using Eclipse as your IDE.
</li>
<li>
- <a href="one-time-setup.html#docbkx-setup">Docbkx: Click here to see the
one-time Docbkx setup</a>. This involves
+ <a href="one-time-setup.html#docbkx-setup">Docbkx: Click here for the
one-time Docbkx setup</a>. This involves
applying a 1-line patch (required).
</li>
</ul>
</subsection>
-<subsection name="Building one project - using the command line">
+<subsection name="Building one project - using the command line"
id="building.command.line.one">
<ol>
<li><p>
Check out one project from SVN: for example, (Windows)<br/>
@@ -79,10 +75,16 @@ under the License.
<li><p><code>mvn install</code></p>
<p>This will build that one project and install it to your local Maven
repository.</p>
</li>
- </ol>
+ </ol>
+
+ <p>
+ This should build all of the jars, any docbooks, and run the unit tests.
+The output artifacts (Jars, html and pdf documents, etc.) are placed in each
project's "target" directory, and
+also are put into your local Maven repository. Docbook output is placed in
the target/site/d directory.
+ </p>
</subsection>
-<subsection name="Building all the projects for a major component - using
command line">
+<subsection name="Building all the projects for a major component - using
command line" id="building.command.line.group">
<p>For convenience, the build, uimaj, uima-as, and add-ons major components
define "aggregate"
projects which use Maven's <modules> element to specify groups of
individual projects
that can be then built in one operation.</p>
@@ -107,16 +109,59 @@ under the License.
</ol>
</subsection>
-<subsection name="Building using Eclipse, with the m2eclipse plugin">
+<subsection name="Building using Eclipse, with the m2eclipse plugin"
id="building-from-eclipse">
<ol>
<li>Checkout one or many projects, as above, into some location. Then use
- Eclipse menu: File → import → Maven → Existing
Maven projects
+ Eclipse menu: <code>File -> Import -> Maven -> Existing Maven
projects</code>
to import those projects into the Eclipse workspace and set them up for
Maven building.</li>
<li>To run maven commands on a project, select the project, right click,
and pick <code>Run as</code>
and then select mvn install (or other choice as you wish).</li>
</ol>
-</subsection>
+
+ <p>If your Maven build generates sources (e.g., you have some XMLBeans
defined),
+ then after the initial import and project build, you'll need to use the
m2eclipse command
+ <code>Update Project Configuration</code> found on the <code>Maven</code>
context menu obtained by right-clicking the project folder.</p>
+ </subsection>
+
+<subsection name="Checking Out Code using Eclipse" id="checkout.using.eclipse">
+
+<p>To access the SVN repository from Eclipse, use Maven's m2eclipse plugin
+ and the Subclipse plugin.
+</p>
+
+<p>The individual projects can be checked out without worrying about relative
path
+ dependencies, except for a few projects that refer to other projects using
relative addresses.
+ Currently, the projects which do that are
+ <ul>
+ <li>the aggregator projects - those special maven projects
+ that only serve to aggregate build operations for a set of other projects,
and</li>
+ <li>the "distribution" projects - those that build entire
distributions.</li>
+ </ul></p>
+
+<p>The recommended way to check out many projects at once is to use the
command line
+ (non-Eclipse) svn checkout
+ command. Use this to check out entire sets of projects under one of the
trunks, for instance.
+ Once they are checked out, you can import them into an Eclipse workspace
using the
+ <code>File -> Import -> Maven -> Existing Maven Projects</code>.
+</p>
+
+<p>You can also check out individual projects using
+<ol>
+ <li>Bring up the "SVN Repositories" View (from <code>Window -> Show View ->
Other</code>)</li>
+ <li>Right click in the SVN Repositories View and select <code>New ->
Repository Location</code>.</li>
+ <li>Enter the URL
<code>http://svn.apache.org/repos/asf/uima/uimaj/trunk</code> (or
<code>https://</code>...)</li>
+ <li>Shift-click to multi-select the projects you want, right click and
choose "Checkout as Maven Projects"</li>
+ <li>Select "Check out into the workspace as projects" and click
"Finish"</li>
+</ol>
+</p>
+
+<p class="note">
+ If you check out projects individually, m2eclipse may put them into
individual subfolders, causing the
+ distribution and aggregation projects to no longer have the right relative
directory specifications.
+ If this happens, the best thing to do is to re-checkout the entire set of
related items in one go.
+</p>
+</subsection>
</section>
</body>
Modified: uima/site/trunk/uima-website/xdocs/distribution.xml
URL:
http://svn.apache.org/viewvc/uima/site/trunk/uima-website/xdocs/distribution.xml?rev=955375&r1=955374&r2=955375&view=diff
==============================================================================
--- uima/site/trunk/uima-website/xdocs/distribution.xml (original)
+++ uima/site/trunk/uima-website/xdocs/distribution.xml Wed Jun 16 20:46:09 2010
@@ -52,6 +52,9 @@ under the License.
<section name="Building the Apache UIMA base distribution">
+ <p class="note">These instructions are for the 2.3.0 release; the
+ build process is being revised for 2.3.1, and these pages will be updated
as that is
+ completed.</p>
<p>
Start by extracting and building the code manually as described on the
<a href="./svn.html">source code page</a>.
Modified: uima/site/trunk/uima-website/xdocs/one-time-setup.xml
URL:
http://svn.apache.org/viewvc/uima/site/trunk/uima-website/xdocs/one-time-setup.xml?rev=955375&r1=955374&r2=955375&view=diff
==============================================================================
--- uima/site/trunk/uima-website/xdocs/one-time-setup.xml (original)
+++ uima/site/trunk/uima-website/xdocs/one-time-setup.xml Wed Jun 16 20:46:09
2010
@@ -91,7 +91,7 @@ under the License.
href="https://issues.sonatype.org/browse/MNGECLIPSE-1694";>https://issues.sonatype.org/browse/MNGECLIPSE-1694</a>.
</p>
</li>
- <li>Use Eclipse<code> Preferences -> Maven -> Installations </code> to
add the Maven 3.0-beta-1 installation as the
+ <li>Use Eclipse<code> Preferences -> Maven -> Installations </code> to
add the Maven 3.0-beta-1 (or later) installation as the
default to use.</li>
</ol>
</p>
@@ -99,7 +99,7 @@ under the License.
<section name="One time setup for using the Docbkx Maven plugin"
id="docbkx-setup">
<p>
- A patch is needed to get get the Docbkx plugin to work with Maven 3:
+ A patch is needed to get get the Maven Docbkx plugin to work with Maven 3:
<ol><li>use m2Eclipse to checkout
http://docbkx-tools.googlecode.com/svn/tags/docbkx-2.0.10/docbkx-maven-base
project</li>
<li>Edit line 472 of <code>AbstractTransformerMojo.java</code>, where
it says <code>...getResources("/catalog.xml")</code> and
Modified: uima/site/trunk/uima-website/xdocs/svn.xml
URL:
http://svn.apache.org/viewvc/uima/site/trunk/uima-website/xdocs/svn.xml?rev=955375&r1=955374&r2=955375&view=diff
==============================================================================
--- uima/site/trunk/uima-website/xdocs/svn.xml (original)
+++ uima/site/trunk/uima-website/xdocs/svn.xml Wed Jun 16 20:46:09 2010
@@ -18,6 +18,7 @@ KIND, either express or implied. See th
specific language governing permissions and limitations
under the License.
-->
+
<document>
<properties>
@@ -76,6 +77,8 @@ If you're new to Subversion, you can che
<a href="http://svnbook.red-bean.com/"; target="_blank">online book</a> about
Subversion.
</p>
+<p>See <a href="one-time-setup.html#svn-setup">SVN setup</a> for details on
how to setup SVN.</p>
+
<p>
The code for UIMA is stored in several sections:</p>
<ol>
@@ -166,53 +169,10 @@ via HTTPS, in order to be able to check
<longquote><code>% svn checkout \<br/>
https://svn.apache.org/repos/asf/uima/uimaj/trunk</code></longquote>
</subsection>
-
+
<subsection name="Checking Out Code using Eclipse" id="checkout.using.eclipse">
-
-<p>To access the SVN repository from Eclipse, please use Maven's m2eclipse
plugin
- from <a class="external" rel="nofollow" target="_blank"
href="http://m2eclipse.sonatype.org/sites/m2e";>
- http://m2eclipse.sonatype.org/sites/m2e</a>, and
- the Subclispe plugin from
-<a class="external" rel="nofollow" target="_blank"
href="http://subclipse.tigris.org/update_1.0.x";>
-http://subclipse.tigris.org/update_1.0.x</a>.
-</p>
-
-<p class="note">Note that m2eclipse comes with a bundled version of maven 3
included. If that version is < 3.0.0-beta-1,
- please obtain the latest maven 3 build, install it, and then use the
preferences for Eclipse Maven to tell
- it to use the later maven 3 build for running builds.</p>
-
-<p>The individual projects can be checked out without worrying about relative
path
- dependencies, except for a few projects that refer to other projects using
relative addresses.
- Currently, the projects which do that are
- <ul>
- <li>the aggregator projects - those special maven projects
- that only serve to aggregate build operations for a set of other projects,
and</li>
- <li>the "distribution" projects - those that build entire
distributions.</li>
- </ul></p>
-
-<p>The recommended way to check out many projects at once is to use the
command line (non-Eclipse) svn checkout
- command. Use this to check out entire sets of projects under one of the
trunks, for instance.
- Once they are checked out, you can import them into an Eclipse workspace
using the
- File -> Import -> Maven -> Existing Maven Projects.
-</p>
-
-<p>You can also check out individual projects using
-<ol>
- <li>Bring up the "SVN Repositories" View (from Window -> Show View ->
Other)</li>
- <li>Right click in the SVN Repositories View and select New ->
Repository Location.</li>
- <li>Enter the URL
<code>http://svn.apache.org/repos/asf/uima/uimaj/trunk</code> (or
<code>https://</code>...)</li>
- <li>Shift-click to multi-select the projects you want, right click and
choose "Checkout as Maven Projects"</li>
- <li>Select "Check out into the workspace as projects" and click
"Finish"</li>
-</ol>
-</p>
-
-<p class="note">
- If you check out projects individually, m2eclipse may put them into
individual subfolders, causing the
- distribution and aggregation projects to no longer have the right relative
directory specifications.
- If this happens, the best thing to do is to re-checkout the entire set of
related items in one go.
-</p>
+<p>See <a href="building-uima.html#checkout.using.eclipse">Building UIMA -
checkout using Eclipse</a>.</p>
</subsection>
-
</section>
<section name="Submitting Code Changes" id="submit.code.changes">
@@ -224,7 +184,7 @@ with the developer community. If there i
create a patch and attach it to the JIRA issue.
</p>
<p>
-To create a patch, use the Eclipse Team -> Create Patch command
+To create a patch, use the Eclipse Team <code>-></code> Create Patch command
select the project in the Package Explorer, right click it to find
the Team menu in the context menu). Or, use the command line and
execute the svn diff command. This creates a patch that
@@ -249,7 +209,7 @@ password once you become a committer.
<p>
Once your password is set, you can commit from Eclipse using the
-Team -> commit context menu. You can do this on an individual file,
+<code>Team -> commit</code> context menu. You can do this on an individual
file,
a set of files or directories (multi-select), or on whole project(s).
You can also commit from the command line like this:
</p>
@@ -288,11 +248,10 @@ http://jira.atlassian.com/browse/SVN-37<
</subsection>
</section>
-<section name="Building UIMA from Source" id="building.with.maven">
+<section name="Building UIMA">
+<subsection name="Building UIMA from Source" id="building.with.maven">
<p>
-Apache UIMA uses Maven 2 or 3 to do builds. Release 2.2.x of Maven, or later,
is required.
-Download Maven from <a class="external" rel="nofollow" target="_blank"
href="http://maven.apache.org";>
-http://maven.apache.org</a> and add <maven-home>/bin to your path.
+ See <a href="building-uima.html">Building UIMA</a>.
</p>
<p>
@@ -301,48 +260,23 @@ http://maven.apache.org</a> and add <
<li>you can use the source version of the release artifact you download
from the download
page.</li></ol>
</p>
-
-
-<subsection name="Building from the command line" id="building.command.line">
-<p>
- These instructions apply to the release 2.3.1 and onwards version. To build
base UIMA from the command line,
-<longquote><pre>
-$> cd aggregate-uimaj
-$> mvn install
-</pre></longquote>
-</p>
-
-<p>Builds for uima-as and the sandbox projects work similarly.
- </p>
-
- <p>Once the directory is set up, do:
-<longquote><pre>
-$> cd aggregate-uima-as
-$> mvn install
- or
-$> cd aggregate-addons
-$> mvn install
-</pre></longquote>
-</p>
+
+</subsection>
-<p>
-This should build all of the jars, any docbooks, and run the unit tests.
-The output artifacts (Jars, html and pdf documents, etc.) are placed in each
project's "target" directory, and
-also are put into your local Maven repository.
-</p>
-
-<p>If you want to build just one of the "projects", and not the whole thing,
cd to the project you want to build, and run
-mvn install there.</p>
-
+<subsection name="Building from the Command Line" id="building.command.line">
+ <p>
+ See <a href="building-uima.html#building.command.line.one">Building one
project from the command line</a>, and
+ <a href="building-uima.html#building.command.line.group">Building all the
projects for a major component from the command line</a>.
+ </p>
</subsection>
<subsection name="Building from Eclipse" id="building.eclipse">
- <p>With m2eclipse plugin, you can right-click any maven project, and select
Run -> maven commands to do maven runs. Furthermore, you can
- save run configurations you build using Run -> Run As ... -> Maven build
...; these become launchable using the standard Eclipse run menus.
+ <p>With m2eclipse plugin, you can right-click any maven project, and select
<code>Run -> maven commands</code> to do maven runs. Furthermore, you can
+ save run configurations you build using <code>Run -> Run As ... -> Maven
build ...</code>; these become launchable using the standard Eclipse run menus.
</p>
<p>Within a project, you can run the unit tests in Eclipse by right-clicking
on a folder (for example
- <code>uimaj-core/src/test/java</code>) and selecting Run As -> JUnit
Test. This will run all tests
+ <code>uimaj-core/src/test/java</code>) and selecting <code>Run As ->
JUnit Test</code>. This will run all tests
under that folder.</p>
<!--
<ol>
@@ -378,7 +312,7 @@ mvn -Declipse.workspace=<eclipse work
<li><p>The projects should now compile without errors, and have build
paths which reference copies of things in
your local maven repository.</p></li>
<li><p>You can run the unit tests in Eclipse by right-clicking on a
folder (for example
- <code>uimaj-core/src/test/java</code>) and selecting Run As -> JUnit
Test. This will run all tests
+ <code>uimaj-core/src/test/java</code>) and selecting Run As
<code>-></code> JUnit Test. This will run all tests
under that folder.</p></li>
</ol>
</p>
@@ -406,7 +340,7 @@ If not using Eclipse, you can use <code>
<subsection name="How to build the full Apache UIMA distribution"
id="build.distribution">
<p>Distributions include zip/tar packages of source or binaries.
- Please refer to this page: <a href="distribution.html">Building a
distribution</a> for
+ Please refer to <a href="distribution.html">Building a distribution</a> for
details on how to do this.</p>
<p>
