You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by sc...@apache.org on 2010/06/13 14:33:25 UTC
svn commit: r954212 - in /uima/site/trunk/uima-website/xdocs:
building-uima.xml one-time-setup.xml
Author: schor
Date: Sun Jun 13 12:33:25 2010
New Revision: 954212
URL: http://svn.apache.org/viewvc?rev=954212&view=rev
Log:
[UIMA-1810 UIMA-1811] add one-time setup page and building-uima page
Added:
uima/site/trunk/uima-website/xdocs/building-uima.xml
uima/site/trunk/uima-website/xdocs/one-time-setup.xml
Added: 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=954212&view=auto
==============================================================================
--- uima/site/trunk/uima-website/xdocs/building-uima.xml (added)
+++ uima/site/trunk/uima-website/xdocs/building-uima.xml Sun Jun 13 12:33:25 2010
@@ -0,0 +1,123 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document [
+<!ENTITY rarr "->" >
+<!ENTITY larr "<-" >
+]>
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<document>
+
+<properties>
+<title>Building UIMA</title>
+<author email="dev@uima.apache.org">
+ UIMA Documentation Team</author>
+</properties>
+
+<body>
+
+<section name="Building UIMA from sources">
+
+<p>
+ We use <a class="external" rel="nofollow" target="_blank"
+ href="http://maven.apache.org/">Maven</a>, release 3.0 or later, for building.
+
+ Most of us use <a class="external" rel="nofollow" target="_blank"
+ href="">Eclipse</a> as the IDE for working with Java. Maven has a plugin for Eclipse,
+ <a class="external" rel="nofollow" target="_blank"
+ href="http://m2eclipse.sonatype.org/">m2eclipse</a>, that is useful in working with Maven from
+ within Eclipse.
+</p>
+
+<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>.
+ </li>
+ <li>
+ <a href="one-time-setup.html#maven-setup">Maven: Click here to see 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
+ 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
+ applying a 1-line patch (required).
+ </li>
+ </ul>
+</subsection>
+
+<subsection name="Building one project - using the command line">
+ <ol>
+ <li><p>
+ Check out one project from SVN: for example, (Windows)<br/>
+ <code> svn checkout https://svn.apache.org/repos/asf/uima/uimaj/trunk/uimaj-core c:/myWorkingDir/uimaj-core</code></p>
+ <p>If you have <a class="external" rel="nofollow" target="_blank"
+ href="http://tortoisesvn.tigris.org/">tortoiseSVN</a> windows shell extensions installed,
+ you can use the <code>repo-browser</code> right-click menu option to do this.</p>
+ </li>
+ <li><p>
+ <code>cd to that directory</code> where you checked out the project.</p>
+ </li>
+ <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>
+</subsection>
+
+<subsection name="Building all the projects for a major component - using command line">
+ <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>
+ <ol>
+ <li><p>
+ Check out a set of projects from SVN: for example, (Windows):<br/>
+ <code> svn checkout https://svn.apache.org/repos/asf/uima/uimaj/trunk c:/myWorkingDir/uimaj</code>, or <br/>
+ <code> svn checkout https://svn.apache.org/repos/asf/uima/build/trunk c:/myWorkingDir/build</code>, or <br/>
+ <code> svn checkout https://svn.apache.org/repos/asf/uima/uima-as/trunk c:/myWorkingDir/uima-as</code>, etc.
+ </p>
+ </li>
+ <li><p>
+ <code>cd to that directory</code> where you checked out the projects
+ </p>
+ </li><li><p>
+ <code>cd to the aggregate</code>, e.g., aggregate-uimaj or aggregate-build, or aggregate-uima-as, etc.
+ </p>
+ </li><li><p>
+ <code>mvn install</code></p>
+ <p>This will build that all the projects in that aggregate and install them to your local Maven repository.</p>
+ </li>
+ </ol>
+</subsection>
+
+<subsection name="Building using Eclipse, with the m2eclipse plugin">
+ <ol>
+ <li>Checkout one or many projects, as above, into some location. Then use
+ Eclipse menu: File → import → Maven → Existing Maven projects
+ 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>
+
+</section>
+</body>
+</document>
Added: 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=954212&view=auto
==============================================================================
--- uima/site/trunk/uima-website/xdocs/one-time-setup.xml (added)
+++ uima/site/trunk/uima-website/xdocs/one-time-setup.xml Sun Jun 13 12:33:25 2010
@@ -0,0 +1,118 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<document>
+
+<properties>
+<title>One time setup</title>
+<author email="dev@uima.apache.org">
+ UIMA Documentation Team</author>
+</properties>
+
+<body>
+
+<section name="One time setup instructions for working with Apache UIMA source code">
+ <p>
+ Here you will find information on how to set up various tools used in working with UIMA source code, including:
+ <ul>
+ <li><a href="#svn-setup">SVN</a></li>
+ <li><a href="#maven-setup">Maven</a></li>
+ <li><a href="#eclipse-setup">Eclipse</a></li>
+ <li><a href="#docbkx-setup">Docbkx</a> - a Maven plugin for processing Docbook files</li>
+ </ul>
+ </p>
+</section>
+
+<section name="One time setup for SVN" id="svn-setup">
+ <p>Install an svn client (not server) to use for command line invocation of SVN from
+ <a class="external" rel="nofollow" target="_blank"
+ href="http://subversion.apache.org/packages.html">http://subversion.apache.org/packages.html</a>.
+ Use the 1.6.x or later version.
+ For Windows platform, you may find it convenient to also install a windows shell extension for this, such
+ as the one from Tigris.org.</p>
+
+ <p>If you are using an IDE, you should obtain the SVN client for that IDE.</p>
+</section>
+
+<section name="One time setup for Maven" id="maven-setup">
+ <ol><li>Download Maven 3.0 beta-1 or later from
+ <a class="external" rel="nofollow" target="_blank"
+ href="http://maven.apache.org/download.html">http://maven.apache.org/download.html</a>.</li>
+ <li>Set up your path to use this version.</li>
+ <li>Add the following environment variable for Maven: <br/>
+ <pre> Variable name: <code>MAVEN_OPTS</code><br/>
+ Value: <code>-Xmx800m -XX:MaxPermSize=256m</code></pre></li>
+ </ol>
+</section>
+
+<section name="One time setup for Eclipse" id="eclipse-setup">
+ <p>Install a current Eclipse (these instructions tested with Eclipse 3.5.2). Then:
+ <ol>
+ <li><p>Install the SVN support plugin <code>Subclipse</code> from
+ <a class="external" rel="nofollow" target="_blank"
+ href="http://subclipse.tigris.org/">http://subclipse.tigris.org/</a>.
+ Be sure to pick the version for 1.6.x SVN client.
+ </p></li>
+ <li><p>Install m2Eclipse 0.10.0 or later from
+ <a class="external" rel="nofollow" target="_blank"
+ href="http://m2eclipse.sonatype.org/">http://m2eclipse.sonatype.org/</a>.
+ </p>
+ <p>Version 0.10.0 has a bug which prevents projects which use XMLBeans from compiling.
+ Until this is fixed, install this "update" after installing the base:
+ <ol><li>Download <a class="external" rel="nofollow" target="_blank"
+ href="
+ https://cit-server.cit.tu-berlin.de/~battre/org.maven.ide.eclipse.site-0.10.1-SNAPSHOT-site.zip">
+ https://cit-server.cit.tu-berlin.de/~battre/org.maven.ide.eclipse.site-0.10.1-SNAPSHOT-site.zip</a>
+ </li><li>
+ unzip it locally
+ </li><li>add the directory as a local "Software Site" in "Help -> Install New Software"</li>
+ <li>update the m2eclipse with "Help -> Check for Updates"</li>
+ </ol>
+ </p>
+ <p>For more details about this bug, see
+ <a class="external" rel="nofollow" target="_blank"
+ 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
+ default to use.</li>
+ </ol>
+ </p>
+</section>
+
+<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:
+ <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 , where it says <code>...getResources("/catalog.xml")</code> and
+ remove the <code>/</code> in front of <code>catalog.xml</code>.</li>
+ <li>do a<code> mvn install </code> in the docbkx-maven-base directory, to install the fix to your local repo.</li>
+ </ol>
+ <p>
+ If you're interested in knowing more about this bug, see
+ <a class="external" rel="nofollow" target="_blank"
+ href="http://code.google.com/p/docbkx-tools/issues/detail?id=52">http://code.google.com/p/docbkx-tools/issues/detail?id=52</a>.
+ </p>
+ </p>
+
+</section>
+</body>
+</document>