You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by ea...@apache.org on 2007/02/12 20:31:18 UTC

svn commit: r506596 - /incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/eclipse_setup.xml

Author: eae
Date: Mon Feb 12 11:31:17 2007
New Revision: 506596

URL: http://svn.apache.org/viewvc?view=rev&rev=506596
Log:
UIMA-260

Modified:
    incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/eclipse_setup.xml

Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/eclipse_setup.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/eclipse_setup.xml?view=diff&rev=506596&r1=506595&r2=506596
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/eclipse_setup.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/eclipse_setup.xml Mon Feb 12 11:31:17 2007
@@ -1,30 +1,30 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
-"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
-<!ENTITY imgroot "../images/overview_and_setup/eclipse_setup_files/" >
-<!ENTITY % uimaents SYSTEM "../entities.ent" >  
-%uimaents;
-]>
-<!--
-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.
--->
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+<!ENTITY imgroot "../images/overview_and_setup/eclipse_setup_files/" >
+<!ENTITY % uimaents SYSTEM "../entities.ent" >  
+%uimaents;
+]>
+<!--
+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.
+-->
 <chapter id="ugr.ovv.eclipse_setup">
-  <title>Setting up the Eclipse IDE to work with UIMA</title>
+  <title>Setting up the Eclipse IDE to work with UIMA</title>
   <titleabbrev>Eclipse IDE setup for UIMA</titleabbrev>
   
   <para>This chapter describes how to set up the UIMA SDK to work with Eclipse. Eclipse (<ulink
@@ -81,13 +81,13 @@
         by the UIMA Eclipse tooling. Before installing it, please go to <ulink
           url="&url_emf;"/> and read the installation instructions, and then click on the
         "Update Manager" link to see what url to use in the next step, where you use the built-in
-        facilities in Eclipse to find and install new features. </para>
-        
-      <para>
-      The exact way to install EMF changes from time to time.  In the next few paragraphs, we try
-      to give instructions that should work for most versions.  Please see the end of this section
-      for shortcut instructions for the current version of Eclipse at the time of this writing,
-      Eclipse 3.2.1.
+        facilities in Eclipse to find and install new features. </para>
+        
+      <para>
+      The exact way to install EMF changes from time to time.  In the next few paragraphs, we try
+      to give instructions that should work for most versions.  Please see the end of this section
+      for shortcut instructions for the current version of Eclipse at the time of this writing,
+      Eclipse 3.2.1.
       </para>
       
       <para>Activate the software feature finding by using the menu: Help &rarr; Software
@@ -125,42 +125,48 @@
       <para>This will install EMF, without any extras. (If you want the whole EMF system,
         including source and documentation, you can pick the <quote>EMF SDK</quote> and the
         <quote>Examples for Eclipse Modeling Framework</quote>.)</para>
-      
-      <section>
-      <title>EMF Installation Shortcut for Eclipse 3.2</title>
-      <para>
-      In Eclipse 3.2, all major Eclipse sub-projects have coordinated their release timeframes and
-      published the consolidated "Callisto" release.  You can easily install EMF via the Callisto
-      discovery site as follows.
-      <orderedlist>
-      <listitem><para>
-      From the Eclipse menu, select Help/Software Updates/Find and Install.../Search for new 
-      features to install.
-      </para></listitem>
-      <listitem><para>
-      Check the "Callisto discovery site", push "Next".
-      </para></listitem>
-      <listitem><para>
-      Select a convenient mirror site.
-      </para></listitem>
-      <listitem><para>
-      Check the EMF box under "Models and model development"
-      </para></listitem>
-      <listitem><para>
-      Follow the instructions for the rest of the install.
-      </para></listitem>
-      </orderedlist>
-      </para>
-      </section>
+      
+      <section>
+      <title>EMF Installation Shortcut for Eclipse 3.2</title>
+      <para>
+      In Eclipse 3.2, all major Eclipse sub-projects have coordinated their release timeframes and
+      published the consolidated "Callisto" release.  You can easily install EMF via the Callisto
+      discovery site as follows.
+      <orderedlist>
+      <listitem><para>
+      From the Eclipse menu, select Help/Software Updates/Find and Install.../Search for new 
+      features to install.
+      </para></listitem>
+      <listitem><para>
+      Check the "Callisto discovery site", push "Next".
+      </para></listitem>
+      <listitem><para>
+      Select a convenient mirror site.
+      </para></listitem>
+      <listitem><para>
+      Check the EMF box under "Models and model development"
+      </para></listitem>
+      <listitem><para>
+      Follow the instructions for the rest of the install.
+      </para></listitem>
+      </orderedlist>
+      </para>
+      </section>
       
     </section>
     
     <section id="ugr.ovv.eclipse_setup.install_uima_sdk">
       <title>Install the UIMA SDK</title>
       <para>If you haven't already done so, please download and install the UIMA SDK from
-          <ulink url="&url_apache_uima_download;"/>.  Be sure to run the
-          <literal>adjustExamplePaths.bat</literal> or <literal>adjustExamplePaths.sh</literal>
+          <ulink url="&url_apache_uima_download;"/>.  Be sure to set the environmental variable
+          UIMA_HOME pointing to the root of the installed UIMA SDK and run the
+          <literal>adjustExamplePaths.bat</literal> or <literal>adjustExamplePaths.sh</literal>
           script, as explained in the README.</para>
+
+      <para>The environmental parameter UIMA_HOME is used by the command-line scripts in the
+          %UIMA_HOME%/bin directory as well as by eclipse run configurations in the uimaj-examples
+          sample project.</para>
+
     </section>
     
     <section id="ugr.ovv.eclipse_setup.install_uima_eclipse_plugins">