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 2008/08/28 23:28:16 UTC
svn commit: r689997 [3/32] - in /incubator/uima/uimaj/trunk/uima-docbooks:
./ src/ src/docbook/overview_and_setup/ src/docbook/references/
src/docbook/tools/ src/docbook/tutorials_and_users_guides/
src/docbook/uima/organization/ src/olink/references/
Propchange: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/conceptual_overview.xml
------------------------------------------------------------------------------
svn:eol-style = native
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?rev=689997&r1=689996&r2=689997&view=diff
==============================================================================
--- 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 Thu Aug 28 14:28:14 2008
@@ -1,425 +1,425 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
-"http://www.oasis-open.org/docbook/xml/4.5/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>
- <titleabbrev>Eclipse IDE setup for UIMA</titleabbrev>
-
- <para>This chapter describes how to set up the UIMA SDK to work with Eclipse. Eclipse (<ulink
- url="&url_eclipse;"/>) is a popular open-source Integrated Development
- Environment for many things, including Java. The UIMA SDK does not require that you use
- Eclipse. However, we recommend that you do use Eclipse because some useful UIMA SDK tools
- run as plug-ins to the Eclipse platform and because the UIMA SDK examples are provided in a
- form that's easy to import into your Eclipse environment.</para>
-
- <para>If you are not planning on using the UIMA SDK with Eclipse, you may skip this chapter and
- read <olink targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.aae"/>
- next.</para>
-
- <para>This chapter provides instructions for
-
- <itemizedlist spacing="compact"><listitem><para>installing Eclipse, </para>
- </listitem>
-
- <listitem><para>installing the UIMA SDK's Eclipse plugins into your Eclipse
- environment, and </para></listitem>
-
- <listitem><para>importing the example UIMA code into an Eclipse project. </para>
- </listitem></itemizedlist></para>
-
- <para>The UIMA Eclipse plugins are designed to be used with Eclipse version 3.1 or
- later.
- </para>
-
- <note><para>You will need to run Eclipse using a Java at the 1.5 or later level, in order
- to use the UIMA Eclipse plugins.</para></note>
-
- <section id="ugr.ovv.eclipse_setup.installation">
- <title>Installation</title>
- <section id="ugr.ovv.eclipse_setup.install_eclipse">
- <title>Install Eclipse</title>
-
- <itemizedlist spacing="compact"><listitem><para>Go to <ulink
- url="&url_eclipse;"/> and follow the instructions there to download Eclipse.
- </para></listitem>
-
- <listitem><para>We recommend using the latest release level (not an
- <quote>Integration level</quote>). Navigate to the Eclipse Release version you
- want and download the archive for your platform.</para></listitem>
-
- <listitem><para>Unzip the archive to install Eclipse somewhere, e.g., c:\</para>
- </listitem>
-
- <listitem><para>Eclipse has a bit of a learning curve. If you plan to make
- significant use of Eclipse, check out the tutorial under the help menu. It is well
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+"http://www.oasis-open.org/docbook/xml/4.5/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>
+ <titleabbrev>Eclipse IDE setup for UIMA</titleabbrev>
+
+ <para>This chapter describes how to set up the UIMA SDK to work with Eclipse. Eclipse (<ulink
+ url="&url_eclipse;"/>) is a popular open-source Integrated Development
+ Environment for many things, including Java. The UIMA SDK does not require that you use
+ Eclipse. However, we recommend that you do use Eclipse because some useful UIMA SDK tools
+ run as plug-ins to the Eclipse platform and because the UIMA SDK examples are provided in a
+ form that's easy to import into your Eclipse environment.</para>
+
+ <para>If you are not planning on using the UIMA SDK with Eclipse, you may skip this chapter and
+ read <olink targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.aae"/>
+ next.</para>
+
+ <para>This chapter provides instructions for
+
+ <itemizedlist spacing="compact"><listitem><para>installing Eclipse, </para>
+ </listitem>
+
+ <listitem><para>installing the UIMA SDK's Eclipse plugins into your Eclipse
+ environment, and </para></listitem>
+
+ <listitem><para>importing the example UIMA code into an Eclipse project. </para>
+ </listitem></itemizedlist></para>
+
+ <para>The UIMA Eclipse plugins are designed to be used with Eclipse version 3.1 or
+ later.
+ </para>
+
+ <note><para>You will need to run Eclipse using a Java at the 1.5 or later level, in order
+ to use the UIMA Eclipse plugins.</para></note>
+
+ <section id="ugr.ovv.eclipse_setup.installation">
+ <title>Installation</title>
+ <section id="ugr.ovv.eclipse_setup.install_eclipse">
+ <title>Install Eclipse</title>
+
+ <itemizedlist spacing="compact"><listitem><para>Go to <ulink
+ url="&url_eclipse;"/> and follow the instructions there to download Eclipse.
+ </para></listitem>
+
+ <listitem><para>We recommend using the latest release level (not an
+ <quote>Integration level</quote>). Navigate to the Eclipse Release version you
+ want and download the archive for your platform.</para></listitem>
+
+ <listitem><para>Unzip the archive to install Eclipse somewhere, e.g., c:\</para>
+ </listitem>
+
+ <listitem><para>Eclipse has a bit of a learning curve. If you plan to make
+ significant use of Eclipse, check out the tutorial under the help menu. It is well
worth the effort. There are also books you can get that describe Eclipse and its
- use.</para></listitem></itemizedlist>
-
- <para>The first time Eclipse starts up it will take a bit longer as it completes its
- installation. A <quote>welcome</quote> page will come up. After you are through
- reading the welcome information, click on the arrow to exit the welcome page and get to
- the main Eclipse screens.</para>
- </section>
-
- <section id="ugr.ovv.eclipse_setup.install_uima_eclipse_plugins">
- <title>Installing the UIMA Eclipse Plugins</title>
-
- <para>The best way to do this is to use the Eclipse Update mechanism, because that will
- insure that all needed prerequisites are also installed. See below for an alternative,
- manual approach.</para>
-
- <note><para>If your computer is on an internet connection which uses a proxy server, you can
- configure Eclipse to know about that. Put your proxy settings into Eclipse using the
- Eclipse preferences by accessing the menus: Window → Preferences... →
- Install/Update, and Enable HTTP proxy connection under the Proxy Settings with the
- information about your proxy. </para></note>
-
-
- <para>To use the Eclipse Update mechanism, start Eclipse, and then pick the menu
- <command>Help → Software Updates → Find and Install...</command>.
- On the next page, select the option to Search for new features to install, and press the
- <command>Next</command> button. On the next panel, update sites to visit, press the "Add a new
- remote site" button and enter the URL
- http://www.apache.org/dist/incubator/uima/eclipse-update-site, and press OK. On the previous
- page will now appear this new Site, and it should be checked.</para>
-
- <para>Also check the Europa (or Callisto)
- Discovery Site, which is where the EMF core plugins are (EMF stands for Eclipse Modeling Framework;
- it is an add-on to Eclipse, and is used
- by some of the UIMA Eclipse tooling).</para>
- <para>Now click finish, and follow the
- remaining panels to install the UIMA plugins. If
- you do not have a compatible level of EMF installed, when you select the UIMA plugins, you will get a
- message saying it needs EMF. To add EMF to the list of plugins to be downloaded, just expand the
- Discovery Site entry by clicking it's little "plus" sign and then push the "Select Required" button on the right
- of the panel. This will select the part of EMF that is needed.</para>
- </section>
-
- <section id="ugr.ovv.eclipse_setup.install_emf">
- <title>Manual Install additional Eclipse component: EMF</title>
- <para>You can skip this section if you installed EMF using the above process.</para>
-
- <warning><para>EMF comes in many versions; <emphasis role="bold">you must install
- the version that corresponds to the level of Eclipse that you are running.</emphasis>
- This is automatically done for you if you install it using the Eclipse update mechanism,
- described below. If you separately download an EMF package, you will need to verify it is
- the version that corresponds to the level of Eclipse you are running, before installing
- it.</para></warning>
-
- <para>Before installing EMF using these instructions, 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.3. </para>
-
- <para>Activate the software feature finding by using the menu: Help → Software
- Updates → Find and Install. Select <quote>Search for new features to
- install</quote>, push <quote>Next</quote>. Specify the update sites to use to
- search for EMF, making sure the <quote>Ignore features not applicable to this
- environment</quote> box is checked (at the bottom of the dialog), and push
- <quote>Finish</quote>. A good site to use is one of the Discovery Sites (e.g. Callisto or Europa) - which has a
- collection of Eclipse components including EMF. </para>
-
- <para>This will launch a search for updates to Eclipse; it may show a list of update site
- mirrors – click OK. When it finishes, it shows a list of possible updates in an
- expandable tree. Expand the tree nodes to find EMF SDK. The specific level may vary
- from the level shown below as newer versions are released.</para>
-
- <informalfigure>
- <mediaobject>
- <imageobject>
- <imagedata width="4in" format="JPG" fileref="&imgroot;image002.jpg"/>
- </imageobject>
- <textobject><phrase>Screenshot showing search results for EMF</phrase>
- </textobject>
- </mediaobject>
- </informalfigure>
-
- <para>Click <quote>Next</quote>. Then pick Eclipse Modeling Framework (EMF), and
- push <quote>Next</quote>, accept any licensing agreements, etc., until it
- finishes the installation. It may say it's an <quote>unsigned feature</quote>;
- proceed by clicking <quote>Install</quote>. If it recommends restarting, you may
- do that.</para>
-
- <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 id="ugr.ovv.eclipse_setup.install_emf_shortcut">
- <title>EMF Installation Shortcut for Eclipse 3.2</title>
- <para>Since Eclipse 3.2, all major Eclipse sub-projects coordinate their
+ use.</para></listitem></itemizedlist>
+
+ <para>The first time Eclipse starts up it will take a bit longer as it completes its
+ installation. A <quote>welcome</quote> page will come up. After you are through
+ reading the welcome information, click on the arrow to exit the welcome page and get to
+ the main Eclipse screens.</para>
+ </section>
+
+ <section id="ugr.ovv.eclipse_setup.install_uima_eclipse_plugins">
+ <title>Installing the UIMA Eclipse Plugins</title>
+
+ <para>The best way to do this is to use the Eclipse Update mechanism, because that will
+ insure that all needed prerequisites are also installed. See below for an alternative,
+ manual approach.</para>
+
+ <note><para>If your computer is on an internet connection which uses a proxy server, you can
+ configure Eclipse to know about that. Put your proxy settings into Eclipse using the
+ Eclipse preferences by accessing the menus: Window → Preferences... →
+ Install/Update, and Enable HTTP proxy connection under the Proxy Settings with the
+ information about your proxy. </para></note>
+
+
+ <para>To use the Eclipse Update mechanism, start Eclipse, and then pick the menu
+ <command>Help → Software Updates → Find and Install...</command>.
+ On the next page, select the option to Search for new features to install, and press the
+ <command>Next</command> button. On the next panel, update sites to visit, press the "Add a new
+ remote site" button and enter the URL
+ http://www.apache.org/dist/incubator/uima/eclipse-update-site, and press OK. On the previous
+ page will now appear this new Site, and it should be checked.</para>
+
+ <para>Also check the Europa (or Callisto)
+ Discovery Site, which is where the EMF core plugins are (EMF stands for Eclipse Modeling Framework;
+ it is an add-on to Eclipse, and is used
+ by some of the UIMA Eclipse tooling).</para>
+ <para>Now click finish, and follow the
+ remaining panels to install the UIMA plugins. If
+ you do not have a compatible level of EMF installed, when you select the UIMA plugins, you will get a
+ message saying it needs EMF. To add EMF to the list of plugins to be downloaded, just expand the
+ Discovery Site entry by clicking it's little "plus" sign and then push the "Select Required" button on the right
+ of the panel. This will select the part of EMF that is needed.</para>
+ </section>
+
+ <section id="ugr.ovv.eclipse_setup.install_emf">
+ <title>Manual Install additional Eclipse component: EMF</title>
+ <para>You can skip this section if you installed EMF using the above process.</para>
+
+ <warning><para>EMF comes in many versions; <emphasis role="bold">you must install
+ the version that corresponds to the level of Eclipse that you are running.</emphasis>
+ This is automatically done for you if you install it using the Eclipse update mechanism,
+ described below. If you separately download an EMF package, you will need to verify it is
+ the version that corresponds to the level of Eclipse you are running, before installing
+ it.</para></warning>
+
+ <para>Before installing EMF using these instructions, 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.3. </para>
+
+ <para>Activate the software feature finding by using the menu: Help → Software
+ Updates → Find and Install. Select <quote>Search for new features to
+ install</quote>, push <quote>Next</quote>. Specify the update sites to use to
+ search for EMF, making sure the <quote>Ignore features not applicable to this
+ environment</quote> box is checked (at the bottom of the dialog), and push
+ <quote>Finish</quote>. A good site to use is one of the Discovery Sites (e.g. Callisto or Europa) - which has a
+ collection of Eclipse components including EMF. </para>
+
+ <para>This will launch a search for updates to Eclipse; it may show a list of update site
+ mirrors – click OK. When it finishes, it shows a list of possible updates in an
+ expandable tree. Expand the tree nodes to find EMF SDK. The specific level may vary
+ from the level shown below as newer versions are released.</para>
+
+ <informalfigure>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="4in" format="JPG" fileref="&imgroot;image002.jpg"/>
+ </imageobject>
+ <textobject><phrase>Screenshot showing search results for EMF</phrase>
+ </textobject>
+ </mediaobject>
+ </informalfigure>
+
+ <para>Click <quote>Next</quote>. Then pick Eclipse Modeling Framework (EMF), and
+ push <quote>Next</quote>, accept any licensing agreements, etc., until it
+ finishes the installation. It may say it's an <quote>unsigned feature</quote>;
+ proceed by clicking <quote>Install</quote>. If it recommends restarting, you may
+ do that.</para>
+
+ <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 id="ugr.ovv.eclipse_setup.install_emf_shortcut">
+ <title>EMF Installation Shortcut for Eclipse 3.2</title>
+ <para>Since Eclipse 3.2, all major Eclipse sub-projects coordinate their
release timeframes and publish the consolidated releases. The code name
- for 3.2 was Callisto, the one for 3.3 is Europa. You can
- easily install EMF via the release 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 "[release name] 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 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_manually">
- <title>Installing the UIMA Eclipse Plugins, manually</title>
-
- <para>If you installed the UIMA plugins using the update mechanism above, please skip this section.</para>
-
- <para>If you are unable to use the Eclipse Update mechanism to install the UIMA plugins, you
- can do this manually. In the directory %UIMA_HOME%/eclipsePlugins (The environment variable
- %UIMA_HOME% is where you installed the UIMA SDK), you will see a set of folders. Copy these
- to your %ECLIPSE_HOME%/eclipse/plugins directory (%ECLIPSE_HOME% is where you
- installed Eclipse).</para>
-
- </section>
-
- <section id="ugr.ovv.eclipse_setup.start_eclipse">
- <title>Start Eclipse</title>
- <para>If you have Eclipse running, restart it (shut it down, and start it again) using
- the
- <code>-clean</code> option; you can do this by running the command
- <command>eclipse -clean</command> (see explanation in the next section) in the
- directory where you installed Eclipse. You may want to set up a desktop shortcut at
- this point for Eclipse.</para>
-
- <section id="ugr.ovv.eclipse_setup.special_startup_parameter_clean">
- <title>Special startup parameter for Eclipse: -clean</title>
- <para>If you have modified the plugin structure (by copying or files directly in the
- file system) in Eclipse 3.x after you started it for the first time, please include
- the <quote>-clean</quote> parameter in the startup arguments to Eclipse,
- <emphasis>one time</emphasis> (after any plugin modifications were done). This
- is needed because Eclipse may not notice the changes you made, otherwise. This
- parameter forces Eclipse to reexamine all of its plugins at startup and recompute
- any cached information about them.</para>
- </section>
-
- </section>
- </section>
- <section id="ugr.ovv.eclipse_setup.example_code">
- <title>Setting up Eclipse to view Example Code</title>
- <para>Later chapters refer to example code. You can create a special project in Eclipse to
- hold the examples. Here's how:</para>
-
- <itemizedlist spacing="compact"><listitem><para>In Eclipse, if the Java
- perspective is not already open, switch to it by going to Window → Open Perspective
- → Java.</para></listitem>
-
- <listitem><para>Set up a class path variable named UIMA_HOME, whose value is the
- directory where you installed the UIMA SDK. This is done as follows:
-
- <itemizedlist><listitem><para>Go to Window → Preferences → Java
- → Build Path → Classpath Variables.</para></listitem>
-
- <listitem><para>Click <quote>New</quote></para></listitem>
-
- <listitem><para>Enter UIMA_HOME (all capitals, exactly as written) in the
- <quote>Name</quote> field.</para></listitem>
-
- <listitem><para>Enter your installation directory (e.g. <literal>C:/Program
- Files/apache-uima</literal>) in the <quote>Path</quote> field</para>
- </listitem>
-
- <listitem><para>Click <quote>OK</quote> in the <quote>New Variable
- Entry</quote> dialog</para></listitem>
-
- <listitem><para>Click <quote>OK</quote> in the <quote>Preferences</quote>
- dialog</para></listitem>
-
- <listitem><para>If it asks you if you want to do a full build, click
- <quote>Yes</quote> </para></listitem></itemizedlist></para>
- </listitem>
-
- <listitem><para>Select the File → Import menu option</para></listitem>
-
- <listitem><para>Select <quote>General/Existing Project into Workspace</quote> and click
- the <quote>Next</quote> button.</para></listitem>
-
- <listitem><para>Click <quote>Browse</quote> and browse to the
- %UIMA_HOME%/ directory</para></listitem>
-
- <listitem><para>Click <quote>Finish.</quote> This will create a new project called
- <quote>uimaj-examples</quote> in your Eclipse workspace. There should be no
- compilation errors. </para></listitem></itemizedlist>
-
- <para>To verify that you have set up the project correctly, check that there are no error
- messages in the <quote>Problems</quote> view.</para>
-
+ for 3.2 was Callisto, the one for 3.3 is Europa. You can
+ easily install EMF via the release 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 "[release name] 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 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_manually">
+ <title>Installing the UIMA Eclipse Plugins, manually</title>
+
+ <para>If you installed the UIMA plugins using the update mechanism above, please skip this section.</para>
+
+ <para>If you are unable to use the Eclipse Update mechanism to install the UIMA plugins, you
+ can do this manually. In the directory %UIMA_HOME%/eclipsePlugins (The environment variable
+ %UIMA_HOME% is where you installed the UIMA SDK), you will see a set of folders. Copy these
+ to your %ECLIPSE_HOME%/eclipse/plugins directory (%ECLIPSE_HOME% is where you
+ installed Eclipse).</para>
+
+ </section>
+
+ <section id="ugr.ovv.eclipse_setup.start_eclipse">
+ <title>Start Eclipse</title>
+ <para>If you have Eclipse running, restart it (shut it down, and start it again) using
+ the
+ <code>-clean</code> option; you can do this by running the command
+ <command>eclipse -clean</command> (see explanation in the next section) in the
+ directory where you installed Eclipse. You may want to set up a desktop shortcut at
+ this point for Eclipse.</para>
+
+ <section id="ugr.ovv.eclipse_setup.special_startup_parameter_clean">
+ <title>Special startup parameter for Eclipse: -clean</title>
+ <para>If you have modified the plugin structure (by copying or files directly in the
+ file system) in Eclipse 3.x after you started it for the first time, please include
+ the <quote>-clean</quote> parameter in the startup arguments to Eclipse,
+ <emphasis>one time</emphasis> (after any plugin modifications were done). This
+ is needed because Eclipse may not notice the changes you made, otherwise. This
+ parameter forces Eclipse to reexamine all of its plugins at startup and recompute
+ any cached information about them.</para>
+ </section>
+
+ </section>
</section>
-
- <section id="ugr.ovv.eclipse_setup.adding_source">
- <title>Adding the UIMA source code to the jar files</title>
-
- <para>If you would like to be able to jump to the UIMA source code in Eclipse or to step
- through it with the debugger, you can add the UIMA source code to the jar files. This is
- done via a shell script that comes with the source distribution. To add the source code
- to the jars, you need to:
- </para>
-
- <itemizedlist>
-
- <listitem>
- <para>
- Download and unpack the UIMA source distribution.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Download and install the UIMA binary distribution (the UIMA_HOME environment variable needs
- to be set to point to where you installed the UIMA binary distribution).
- </para>
- </listitem>
-
- <listitem>
- <para>
- Execute the <command>addSourceToJars</command> script in the root directory of the
- source distribution.
- </para>
- </listitem>
-
- </itemizedlist>
-
- <para>
- This adds the source code to the jar files, and it will then be automatically available
- from Eclipse. There is no further Eclipse setup required.
- </para>
-
- </section>
-
-
- <section id="ugr.ovv.eclipse_setup.linking_uima_javadocs">
- <title>Attaching UIMA Javadocs</title>
-
- <para>The binary distribution also includes the UIMA Javadocs. They are
- attached to the UIMA library Jar files in the uima-examples project described
- above. You can attach the Javadocs to your own project as well.
- </para>
-
- <note><para>If you attached the source as described in the previous section, you
- don't need to attach the Javadocs because the source includes the Javadoc comments.</para></note>
-
- <para>Attaching the Javadocs enables Javadoc help for UIMA APIs. After they are
- attached, if you hover your mouse
- over a certain UIMA api element, the corresponding Javadoc will appear.
- You can then press <quote>F2</quote> to make the hover "stick", or
- <quote>Shift-F2</quote> to open the default
- web-browser on your system to let you browse the entire Javadoc information
- for that element.
- </para>
- <para>If this pop-up behavior is something you don't want, you can turn it off
- in the Eclipse preferences, in the menu Window → Preferences →
- Java → Editors → hovers.
- </para>
-
- <para>Eclipse also has a Javadoc "view" which you can show, using the Window →
- Show View → Javadoc.</para>
-
- <para>See <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.javadocs.libraries"/>
- for information on how to set up a UIMA "library" with the Javadocs attached, which
- can be reused for other projects in your Eclipse workspace.</para>
-
- <para>You can attach the Javadocs to each UIMA library jar you think you might be
- interested in. It makes most sense
- for the uima-core.jar, you'll probably use the core APIs most of all.
- </para>
-
- <para>Here's a screenshot of what you should see when you hover your mouse pointer over the
- class name <quote>CAS</quote> in the source code.
- </para>
-
- <informalfigure>
- <mediaobject>
- <imageobject>
- <imagedata width="5.7in" format="JPG" fileref="&imgroot;image004.jpg"/>
- </imageobject>
- <textobject><phrase>Screenshot of mouse-over for UIMA APIs</phrase>
- </textobject>
- </mediaobject>
- </informalfigure>
-
- </section>
-
- <section id="ugr.ovv.eclipse_setup.running_external_tools_from_eclipse">
- <title>Running external tools from Eclipse</title>
-
- <para>You can run many tools without using Eclipse at all, by using the shell scripts in the
- UIMA SDK's bin directory. In addition, many tools can be run from inside Eclipse;
- examples are the Document Analyzer, CPE Configurator, CAS Visual Debugger,
- and JCasGen. The uimaj-examples project provides Eclipse launch
- configurations that make this easy to do.</para>
-
- <para>To run these tools from Eclipse:</para>
-
- <itemizedlist spacing="compact"><listitem><para>If the Java perspective is not
- already open, switch to it by going to Window → Open Perspective →
- Java.</para></listitem>
-
- <listitem><para>Go to Run → Run... </para></listitem>
-
- <listitem><para>In the window that appears, select <quote>UIMA CPE GUI</quote>,
- <quote>UIMA CAS Visual Debugger</quote>, <quote>UIMA JCasGen</quote>, or
- <quote>UIMA Document Analyzer</quote>
- from the list of run configurations on the left. (If you don't see, these, please
- select the uimaj-examples project and do a Menu → File
- → Refresh).</para></listitem>
-
- <listitem><para>Press the <quote>Run</quote> button. The tools should start. Close
- the tools by clicking the <quote>X</quote> in the upper right corner on the GUI.
- </para></listitem></itemizedlist>
-
- <para>For instructions on using the Document Analyzer and CPE Configurator, see <olink
- targetdoc="&uima_docs_tools;" targetptr="ugr.tools.doc_analyzer"/>, and
- <olink targetdoc="&uima_docs_tools;" targetptr="ugr.tools.cpe"/> For
- instructions on using the CAS Visual Debugger and JCasGen, see <olink
- targetdoc="&uima_docs_tools;" targetptr="ugr.tools.cvd"/> and
- <olink targetdoc="&uima_docs_tools;" targetptr="ugr.tools.jcasgen"/></para>
-
- </section>
-
-</chapter>
+ <section id="ugr.ovv.eclipse_setup.example_code">
+ <title>Setting up Eclipse to view Example Code</title>
+ <para>Later chapters refer to example code. You can create a special project in Eclipse to
+ hold the examples. Here's how:</para>
+
+ <itemizedlist spacing="compact"><listitem><para>In Eclipse, if the Java
+ perspective is not already open, switch to it by going to Window → Open Perspective
+ → Java.</para></listitem>
+
+ <listitem><para>Set up a class path variable named UIMA_HOME, whose value is the
+ directory where you installed the UIMA SDK. This is done as follows:
+
+ <itemizedlist><listitem><para>Go to Window → Preferences → Java
+ → Build Path → Classpath Variables.</para></listitem>
+
+ <listitem><para>Click <quote>New</quote></para></listitem>
+
+ <listitem><para>Enter UIMA_HOME (all capitals, exactly as written) in the
+ <quote>Name</quote> field.</para></listitem>
+
+ <listitem><para>Enter your installation directory (e.g. <literal>C:/Program
+ Files/apache-uima</literal>) in the <quote>Path</quote> field</para>
+ </listitem>
+
+ <listitem><para>Click <quote>OK</quote> in the <quote>New Variable
+ Entry</quote> dialog</para></listitem>
+
+ <listitem><para>Click <quote>OK</quote> in the <quote>Preferences</quote>
+ dialog</para></listitem>
+
+ <listitem><para>If it asks you if you want to do a full build, click
+ <quote>Yes</quote> </para></listitem></itemizedlist></para>
+ </listitem>
+
+ <listitem><para>Select the File → Import menu option</para></listitem>
+
+ <listitem><para>Select <quote>General/Existing Project into Workspace</quote> and click
+ the <quote>Next</quote> button.</para></listitem>
+
+ <listitem><para>Click <quote>Browse</quote> and browse to the
+ %UIMA_HOME%/ directory</para></listitem>
+
+ <listitem><para>Click <quote>Finish.</quote> This will create a new project called
+ <quote>uimaj-examples</quote> in your Eclipse workspace. There should be no
+ compilation errors. </para></listitem></itemizedlist>
+
+ <para>To verify that you have set up the project correctly, check that there are no error
+ messages in the <quote>Problems</quote> view.</para>
+
+ </section>
+
+ <section id="ugr.ovv.eclipse_setup.adding_source">
+ <title>Adding the UIMA source code to the jar files</title>
+
+ <para>If you would like to be able to jump to the UIMA source code in Eclipse or to step
+ through it with the debugger, you can add the UIMA source code to the jar files. This is
+ done via a shell script that comes with the source distribution. To add the source code
+ to the jars, you need to:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ Download and unpack the UIMA source distribution.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Download and install the UIMA binary distribution (the UIMA_HOME environment variable needs
+ to be set to point to where you installed the UIMA binary distribution).
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Execute the <command>addSourceToJars</command> script in the root directory of the
+ source distribution.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ This adds the source code to the jar files, and it will then be automatically available
+ from Eclipse. There is no further Eclipse setup required.
+ </para>
+
+ </section>
+
+
+ <section id="ugr.ovv.eclipse_setup.linking_uima_javadocs">
+ <title>Attaching UIMA Javadocs</title>
+
+ <para>The binary distribution also includes the UIMA Javadocs. They are
+ attached to the UIMA library Jar files in the uima-examples project described
+ above. You can attach the Javadocs to your own project as well.
+ </para>
+
+ <note><para>If you attached the source as described in the previous section, you
+ don't need to attach the Javadocs because the source includes the Javadoc comments.</para></note>
+
+ <para>Attaching the Javadocs enables Javadoc help for UIMA APIs. After they are
+ attached, if you hover your mouse
+ over a certain UIMA api element, the corresponding Javadoc will appear.
+ You can then press <quote>F2</quote> to make the hover "stick", or
+ <quote>Shift-F2</quote> to open the default
+ web-browser on your system to let you browse the entire Javadoc information
+ for that element.
+ </para>
+ <para>If this pop-up behavior is something you don't want, you can turn it off
+ in the Eclipse preferences, in the menu Window → Preferences →
+ Java → Editors → hovers.
+ </para>
+
+ <para>Eclipse also has a Javadoc "view" which you can show, using the Window →
+ Show View → Javadoc.</para>
+
+ <para>See <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.javadocs.libraries"/>
+ for information on how to set up a UIMA "library" with the Javadocs attached, which
+ can be reused for other projects in your Eclipse workspace.</para>
+
+ <para>You can attach the Javadocs to each UIMA library jar you think you might be
+ interested in. It makes most sense
+ for the uima-core.jar, you'll probably use the core APIs most of all.
+ </para>
+
+ <para>Here's a screenshot of what you should see when you hover your mouse pointer over the
+ class name <quote>CAS</quote> in the source code.
+ </para>
+
+ <informalfigure>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="5.7in" format="JPG" fileref="&imgroot;image004.jpg"/>
+ </imageobject>
+ <textobject><phrase>Screenshot of mouse-over for UIMA APIs</phrase>
+ </textobject>
+ </mediaobject>
+ </informalfigure>
+
+ </section>
+
+ <section id="ugr.ovv.eclipse_setup.running_external_tools_from_eclipse">
+ <title>Running external tools from Eclipse</title>
+
+ <para>You can run many tools without using Eclipse at all, by using the shell scripts in the
+ UIMA SDK's bin directory. In addition, many tools can be run from inside Eclipse;
+ examples are the Document Analyzer, CPE Configurator, CAS Visual Debugger,
+ and JCasGen. The uimaj-examples project provides Eclipse launch
+ configurations that make this easy to do.</para>
+
+ <para>To run these tools from Eclipse:</para>
+
+ <itemizedlist spacing="compact"><listitem><para>If the Java perspective is not
+ already open, switch to it by going to Window → Open Perspective →
+ Java.</para></listitem>
+
+ <listitem><para>Go to Run → Run... </para></listitem>
+
+ <listitem><para>In the window that appears, select <quote>UIMA CPE GUI</quote>,
+ <quote>UIMA CAS Visual Debugger</quote>, <quote>UIMA JCasGen</quote>, or
+ <quote>UIMA Document Analyzer</quote>
+ from the list of run configurations on the left. (If you don't see, these, please
+ select the uimaj-examples project and do a Menu → File
+ → Refresh).</para></listitem>
+
+ <listitem><para>Press the <quote>Run</quote> button. The tools should start. Close
+ the tools by clicking the <quote>X</quote> in the upper right corner on the GUI.
+ </para></listitem></itemizedlist>
+
+ <para>For instructions on using the Document Analyzer and CPE Configurator, see <olink
+ targetdoc="&uima_docs_tools;" targetptr="ugr.tools.doc_analyzer"/>, and
+ <olink targetdoc="&uima_docs_tools;" targetptr="ugr.tools.cpe"/> For
+ instructions on using the CAS Visual Debugger and JCasGen, see <olink
+ targetdoc="&uima_docs_tools;" targetptr="ugr.tools.cvd"/> and
+ <olink targetdoc="&uima_docs_tools;" targetptr="ugr.tools.jcasgen"/></para>
+
+ </section>
+
+</chapter>
Propchange: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/eclipse_setup.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/faqs.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/faqs.xml?rev=689997&r1=689996&r2=689997&view=diff
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/faqs.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/faqs.xml Thu Aug 28 14:28:14 2008
@@ -22,7 +22,7 @@
specific language governing permissions and limitations
under the License.
-->
-<chapter id="ugr.faqs">
+<chapter id="ugr.faqs">
<title>UIMA Frequently Asked Questions (FAQ's)</title>
<titleabbrev>UIMA FAQ's</titleabbrev>
@@ -108,304 +108,304 @@
a region of an image or a segment of audio. The same concepts apply.</para>
</listitem>
</varlistentry>
-
-
- <varlistentry id="ugr.faqs.what_is_the_cas">
- <term><emphasis role="bold">What is the CAS?</emphasis></term>
- <listitem><para>The CAS stands for Common Analysis Structure. It provides
- cooperating UIMA components with a common representation and mechanism for
- shared access to the artifact being analyzed (e.g., a document, audio file, video
- stream etc.) and the current analysis results.</para></listitem>
- </varlistentry>
- <varlistentry id="ugr.faqs.what_does_the_cas_contain">
- <term><emphasis role="bold">What does the CAS contain?</emphasis></term>
- <listitem><para>The CAS is a data structure for which UIMA provides multiple
- interfaces. It contains and provides the analysis algorithm or application
- developer with access to</para>
-
- <itemizedlist spacing="compact">
-
- <listitem><para>the subject of analysis (the artifact being analyzed, like
- the document),</para></listitem>
-
- <listitem><para>the analysis results or metadata(e.g., annotations, parse
- trees, relations, entities etc.),</para></listitem>
-
- <listitem><para>indices to the analysis results, and</para></listitem>
-
- <listitem><para>the type system (a schema for the analysis results).</para>
- </listitem>
- </itemizedlist>
-
- <para>A CAS can hold multiple versions of the artifact being analyzed (for
- instance, a raw html document, and a detagged version, or an English version and a
- corresponding German version, or an audio sample, and the text that
- corresponds, etc.). For each version there is a separate instance of the results
- indices.</para></listitem>
- </varlistentry>
- <varlistentry id="ugr.faqs.only_annotations">
- <term><emphasis role="bold">Does the CAS only contain Annotations?</emphasis></term>
- <listitem><para>No. The CAS contains the artifact being analyzed plus the analysis
- results. Analysis results are those metadata recorded by <link linkend="ugr.faqs.annotator_versus_ae">analysis engines</link> in the
- CAS. The most common form of analysis result is the addition of an annotation. But an
- analysis engine may write any structure that conforms to the CAS's type
- system into the CAS. These may not be annotations but may be other things, for
- example links between annotations and properties of objects associated with
+
+
+ <varlistentry id="ugr.faqs.what_is_the_cas">
+ <term><emphasis role="bold">What is the CAS?</emphasis></term>
+ <listitem><para>The CAS stands for Common Analysis Structure. It provides
+ cooperating UIMA components with a common representation and mechanism for
+ shared access to the artifact being analyzed (e.g., a document, audio file, video
+ stream etc.) and the current analysis results.</para></listitem>
+ </varlistentry>
+ <varlistentry id="ugr.faqs.what_does_the_cas_contain">
+ <term><emphasis role="bold">What does the CAS contain?</emphasis></term>
+ <listitem><para>The CAS is a data structure for which UIMA provides multiple
+ interfaces. It contains and provides the analysis algorithm or application
+ developer with access to</para>
+
+ <itemizedlist spacing="compact">
+
+ <listitem><para>the subject of analysis (the artifact being analyzed, like
+ the document),</para></listitem>
+
+ <listitem><para>the analysis results or metadata(e.g., annotations, parse
+ trees, relations, entities etc.),</para></listitem>
+
+ <listitem><para>indices to the analysis results, and</para></listitem>
+
+ <listitem><para>the type system (a schema for the analysis results).</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>A CAS can hold multiple versions of the artifact being analyzed (for
+ instance, a raw html document, and a detagged version, or an English version and a
+ corresponding German version, or an audio sample, and the text that
+ corresponds, etc.). For each version there is a separate instance of the results
+ indices.</para></listitem>
+ </varlistentry>
+ <varlistentry id="ugr.faqs.only_annotations">
+ <term><emphasis role="bold">Does the CAS only contain Annotations?</emphasis></term>
+ <listitem><para>No. The CAS contains the artifact being analyzed plus the analysis
+ results. Analysis results are those metadata recorded by <link linkend="ugr.faqs.annotator_versus_ae">analysis engines</link> in the
+ CAS. The most common form of analysis result is the addition of an annotation. But an
+ analysis engine may write any structure that conforms to the CAS's type
+ system into the CAS. These may not be annotations but may be other things, for
+ example links between annotations and properties of objects associated with
annotations.</para>
<para>The CAS may have multiple representations of the artifact being analyzed, each one
- represented in the CAS as a particular Subject of Analysis. or <link linkend="ugr.faqs.what_is_a_sofa">Sofa</link></para></listitem>
- </varlistentry>
- <varlistentry id="ugr.faqs.just_xml">
- <term><emphasis role="bold">Is the CAS just XML?</emphasis></term>
- <listitem><para>No, in fact there are many possible representations of the CAS. If all
- of the <link linkend="ugr.faqs.annotator_versus_ae">analysis engines</link> are running in the same process, an efficient, in-memory
- data object is used. If a CAS must be sent to an analysis engine on a remote machine, it
- can be done via an XML or a binary serialization of the CAS. </para>
-
- <para>The UIMA framework provides serialization and de-serialization methods
- for a particular XML representation of the CAS named the XMI.</para></listitem>
- </varlistentry>
- <varlistentry id="ugr.faqs.what_is_a_type_system">
- <term><emphasis role="bold">What is a Type System?</emphasis></term>
- <listitem><para>Think of a type system as a schema or class model for the <link linkend="ugr.faqs.what_is_the_cas">CAS</link>. It defines
- the types of objects and their properties (or features) that may be instantiated in
- a CAS. A specific CAS conforms to a particular type system. UIMA components declare
- their input and output with respect to a type system. </para>
-
- <para>Type Systems include the definitions of types, their properties, range
- types (these can restrict the value of properties to other types) and
- single-inheritance hierarchy of types.</para></listitem>
- </varlistentry>
- <varlistentry id="ugr.faqs.what_is_a_sofa">
- <term><emphasis role="bold">What is a Sofa?</emphasis></term>
- <listitem><para>Sofa stands for “Subject of Analysis". A <link linkend="ugr.faqs.what_is_the_cas">CAS</link> is
- associated with a single artifact being analysed by a collection of UIMA analysis
- engines. But a single artifact may have multiple independent views, each of which
- may be analyzed separately by a different set of <link linkend="ugr.faqs.annotator_versus_ae">analysis engines</link>. For example,
- given a document it may have different translations, each of which are associated
- with the original document but each potentially analyzed by different engines. A
- CAS may have multiple Views, each containing a different Subject of Analysis
- corresponding to some version of the original artifact. This feature is ideal for
- multi-modal analysis, where for example, one view of a video stream may be the video
- frames and the other the close-captions.</para></listitem>
- </varlistentry>
-
-
- <varlistentry id="ugr.faqs.annotator_versus_ae">
- <term><emphasis role="bold">What's the difference between an Annotator and an Analysis
- Engine?</emphasis></term>
- <listitem><para>In the terminology of UIMA, an annotator is simply some code that
- analyzes documents and outputs <link linkend="ugr.faqs.what_is_an_annotation">annotations</link> on the content of the documents. The
- UIMA framework takes the annotator, together with metadata describing such
- things as the input requirements and outputs types of the annotator, and produces
- an analysis engine. </para>
-
- <para>Analysis Engines contain the framework-provided infrastructure that
- allows them to be easily combined with other analysis engines in different flows
- and according to different deployment options (collocated or as web services,
- for example). </para>
-
- <para>Analysis Engines are the framework-generated objects that an Application
- interacts with. An Annotator is a user-written class that implements the one of
- the supported Annotator interfaces.</para></listitem>
- </varlistentry>
- <varlistentry id="ugr.faqs.web_services">
- <term><emphasis role="bold">Are UIMA analysis engines web services?</emphasis></term>
- <listitem><para>They can be deployed as such. Deploying an analysis engine as a web
- service is one of the deployment options supported by the UIMA framework.</para>
- </listitem>
- </varlistentry>
- <varlistentry id="ugr.faqs.stateless_aes">
- <term><emphasis role="bold">Do Analysis Engines have to be
- "stateless"?</emphasis></term>
- <listitem><para>This is a user-specifyable option. The XML metadata for the
- component includes an
- <code>operationalProperties</code> element which can specify if multiple
- deployment is allowed. If true, then a particular instance of an Engine might not
- see all the CASes being processed. If false, then that component will see all of the
- CASes being processed. In this case, it can accumulate state information among all
- the CASes. Typically, Analysis Engines in the main analysis pipeline are marked
- multipleDeploymentAllowed = true. The CAS Consumer component, on the other hand,
- defaults to having this property set to false, and is typically associated with
- some resource like a database or search engine that aggregates analysis results
- across an entire collection.</para>
-
- <para>Analysis Engines developers are encouraged not to maintain state between
- documents that would prevent their engine from working as advertised if
- operated in a parallelized environment.</para></listitem>
- </varlistentry>
- <varlistentry id="ugr.faqs.uddi">
- <term><emphasis role="bold">Is engine meta-data compatible with web services and
- UDDI?</emphasis></term>
- <listitem><para>All UIMA component implementations are associated with Component
- Descriptors which represents metadata describing various properties about the
- component to support discovery, reuse, validation, automatic composition and
- development tooling. In principle, UIMA component descriptors are compatible
- with web services and UDDI. However, the UIMA framework currently uses its own XML
- representation for component metadata. It would not be difficult to convert
- between UIMA's XML representation and the WSDL and UDDI standards.</para>
- </listitem>
- </varlistentry>
-
-
- <varlistentry id="ugr.faqs.scaling">
- <term><emphasis role="bold">How do you scale a UIMA application?</emphasis></term>
- <listitem><para>The UIMA framework allows components such as <link linkend="ugr.faqs.annotator_versus_ae">analysis engines</link> and
- CAS Consumers to be easily deployed as services or in other containers and managed
- by systems middleware designed to scale. UIMA applications tend to naturally
- scale-out across documents allowing many documents to be analyzed in
- parallel.</para>
- <para>A component in the UIMA framework called the CPM (Collection Processing
- Manager) has a host of features and configuration settings for scaling an
- application to increase its throughput and recoverability.</para></listitem>
- </varlistentry>
- <varlistentry id="ugr.faqs.embedding">
- <term><emphasis role="bold">What does it mean to embed UIMA in systems middleware?</emphasis></term>
- <listitem><para>An example of an embedding would be the deployment of a UIMA analysis
- engine as an Enterprise Java Bean inside an application server such as IBM
- WebSphere. Such an embedding allows the deployer to take advantage of the features
- and tools provided by WebSphere for achieving scalability, service management,
- recoverability etc. UIMA is independent of any particular systems middleware, so
- <link linkend="ugr.faqs.annotator_versus_ae">analysis engines</link> could be deployed on other application servers as well.</para>
- </listitem>
- </varlistentry>
- <varlistentry id="ugr.faqs.cpm_versus_cpe">
- <term><emphasis role="bold">How is the CPM different from a CPE?</emphasis></term>
- <listitem><para>These name complimentary aspects of collection processing. The CPM
+ represented in the CAS as a particular Subject of Analysis. or <link linkend="ugr.faqs.what_is_a_sofa">Sofa</link></para></listitem>
+ </varlistentry>
+ <varlistentry id="ugr.faqs.just_xml">
+ <term><emphasis role="bold">Is the CAS just XML?</emphasis></term>
+ <listitem><para>No, in fact there are many possible representations of the CAS. If all
+ of the <link linkend="ugr.faqs.annotator_versus_ae">analysis engines</link> are running in the same process, an efficient, in-memory
+ data object is used. If a CAS must be sent to an analysis engine on a remote machine, it
+ can be done via an XML or a binary serialization of the CAS. </para>
+
+ <para>The UIMA framework provides serialization and de-serialization methods
+ for a particular XML representation of the CAS named the XMI.</para></listitem>
+ </varlistentry>
+ <varlistentry id="ugr.faqs.what_is_a_type_system">
+ <term><emphasis role="bold">What is a Type System?</emphasis></term>
+ <listitem><para>Think of a type system as a schema or class model for the <link linkend="ugr.faqs.what_is_the_cas">CAS</link>. It defines
+ the types of objects and their properties (or features) that may be instantiated in
+ a CAS. A specific CAS conforms to a particular type system. UIMA components declare
+ their input and output with respect to a type system. </para>
+
+ <para>Type Systems include the definitions of types, their properties, range
+ types (these can restrict the value of properties to other types) and
+ single-inheritance hierarchy of types.</para></listitem>
+ </varlistentry>
+ <varlistentry id="ugr.faqs.what_is_a_sofa">
+ <term><emphasis role="bold">What is a Sofa?</emphasis></term>
+ <listitem><para>Sofa stands for “Subject of Analysis". A <link linkend="ugr.faqs.what_is_the_cas">CAS</link> is
+ associated with a single artifact being analysed by a collection of UIMA analysis
+ engines. But a single artifact may have multiple independent views, each of which
+ may be analyzed separately by a different set of <link linkend="ugr.faqs.annotator_versus_ae">analysis engines</link>. For example,
+ given a document it may have different translations, each of which are associated
+ with the original document but each potentially analyzed by different engines. A
+ CAS may have multiple Views, each containing a different Subject of Analysis
+ corresponding to some version of the original artifact. This feature is ideal for
+ multi-modal analysis, where for example, one view of a video stream may be the video
+ frames and the other the close-captions.</para></listitem>
+ </varlistentry>
+
+
+ <varlistentry id="ugr.faqs.annotator_versus_ae">
+ <term><emphasis role="bold">What's the difference between an Annotator and an Analysis
+ Engine?</emphasis></term>
+ <listitem><para>In the terminology of UIMA, an annotator is simply some code that
+ analyzes documents and outputs <link linkend="ugr.faqs.what_is_an_annotation">annotations</link> on the content of the documents. The
+ UIMA framework takes the annotator, together with metadata describing such
+ things as the input requirements and outputs types of the annotator, and produces
+ an analysis engine. </para>
+
+ <para>Analysis Engines contain the framework-provided infrastructure that
+ allows them to be easily combined with other analysis engines in different flows
+ and according to different deployment options (collocated or as web services,
+ for example). </para>
+
+ <para>Analysis Engines are the framework-generated objects that an Application
+ interacts with. An Annotator is a user-written class that implements the one of
+ the supported Annotator interfaces.</para></listitem>
+ </varlistentry>
+ <varlistentry id="ugr.faqs.web_services">
+ <term><emphasis role="bold">Are UIMA analysis engines web services?</emphasis></term>
+ <listitem><para>They can be deployed as such. Deploying an analysis engine as a web
+ service is one of the deployment options supported by the UIMA framework.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="ugr.faqs.stateless_aes">
+ <term><emphasis role="bold">Do Analysis Engines have to be
+ "stateless"?</emphasis></term>
+ <listitem><para>This is a user-specifyable option. The XML metadata for the
+ component includes an
+ <code>operationalProperties</code> element which can specify if multiple
+ deployment is allowed. If true, then a particular instance of an Engine might not
+ see all the CASes being processed. If false, then that component will see all of the
+ CASes being processed. In this case, it can accumulate state information among all
+ the CASes. Typically, Analysis Engines in the main analysis pipeline are marked
+ multipleDeploymentAllowed = true. The CAS Consumer component, on the other hand,
+ defaults to having this property set to false, and is typically associated with
+ some resource like a database or search engine that aggregates analysis results
+ across an entire collection.</para>
+
+ <para>Analysis Engines developers are encouraged not to maintain state between
+ documents that would prevent their engine from working as advertised if
+ operated in a parallelized environment.</para></listitem>
+ </varlistentry>
+ <varlistentry id="ugr.faqs.uddi">
+ <term><emphasis role="bold">Is engine meta-data compatible with web services and
+ UDDI?</emphasis></term>
+ <listitem><para>All UIMA component implementations are associated with Component
+ Descriptors which represents metadata describing various properties about the
+ component to support discovery, reuse, validation, automatic composition and
+ development tooling. In principle, UIMA component descriptors are compatible
+ with web services and UDDI. However, the UIMA framework currently uses its own XML
+ representation for component metadata. It would not be difficult to convert
+ between UIMA's XML representation and the WSDL and UDDI standards.</para>
+ </listitem>
+ </varlistentry>
+
+
+ <varlistentry id="ugr.faqs.scaling">
+ <term><emphasis role="bold">How do you scale a UIMA application?</emphasis></term>
+ <listitem><para>The UIMA framework allows components such as <link linkend="ugr.faqs.annotator_versus_ae">analysis engines</link> and
+ CAS Consumers to be easily deployed as services or in other containers and managed
+ by systems middleware designed to scale. UIMA applications tend to naturally
+ scale-out across documents allowing many documents to be analyzed in
+ parallel.</para>
+ <para>A component in the UIMA framework called the CPM (Collection Processing
+ Manager) has a host of features and configuration settings for scaling an
+ application to increase its throughput and recoverability.</para></listitem>
+ </varlistentry>
+ <varlistentry id="ugr.faqs.embedding">
+ <term><emphasis role="bold">What does it mean to embed UIMA in systems middleware?</emphasis></term>
+ <listitem><para>An example of an embedding would be the deployment of a UIMA analysis
+ engine as an Enterprise Java Bean inside an application server such as IBM
+ WebSphere. Such an embedding allows the deployer to take advantage of the features
+ and tools provided by WebSphere for achieving scalability, service management,
+ recoverability etc. UIMA is independent of any particular systems middleware, so
+ <link linkend="ugr.faqs.annotator_versus_ae">analysis engines</link> could be deployed on other application servers as well.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="ugr.faqs.cpm_versus_cpe">
+ <term><emphasis role="bold">How is the CPM different from a CPE?</emphasis></term>
+ <listitem><para>These name complimentary aspects of collection processing. The CPM
(Collection Processing <emphasis role="bold">Manager</emphasis> is the part of
- the UIMA framework that manages the execution of a workflow of UIMA
- components orchestrated to analyze a large collection of documents. The UIMA
- developer does not implement or describe a CPM. It is a piece of infrastructure code
- that handles CAS transport, instance management, batching, check-pointing,
- statistics collection and failure recovery in the execution of a collection
- processing workflow.</para>
-
- <para>A Collection Processing Engine (CPE) is component created by the framework
- from a specific CPE descriptor. A CPE descriptor refers to a series of UIMA
- components including a Collection Reader, CAS Initializer, Analysis
- Engine(s) and CAS Consumers. These components are organized in a work flow and
- define a collection analysis job or CPE. A CPE acquires documents from a source
- collection, initializes CASs with document content, performs document
- analysis and then produces collection level results (e.g., search engine
- index, database etc). The CPM is the execution engine for a CPE.</para>
- </listitem>
- </varlistentry>
- <varlistentry id="ugr.faqs.semantic_search">
- <term><emphasis role="bold">What is Semantic Search and what is its relationship to
- UIMA?</emphasis></term>
- <listitem><para>Semantic Search refers to a document search paradigm that allows
- users to search based not just on the keywords contained in the documents, but also
- on the semantics associated with the text by <link linkend="ugr.faqs.annotator_versus_ae">analysis engines</link>. UIMA applications
- perform analysis on text documents and generate semantics in the form of
- <link linkend="ugr.faqs.what_is_an_annotation">annotations</link> on regions of text. For example, a UIMA analysis engine may discover
- the text <quote>First Financial Bank</quote> to refer to an organization and
- annotated it as such. With traditional keyword search, the query
- <command>first</command> will return all documents that contain that word.
- <command>First</command> is a frequent and ambiguous term – it occurs a lot
- and can mean different things in different places. If the user is looking for
- organizations that contain that word <command>first</command> in their names,
- s/he will likely have to sift through lots of documents containing the word
- <quote>first</quote> used in different ways. Semantic Search exploits the
- results of analysis to allow more precise queries. For example, the semantic
- search query <emphasis><organization> first
- </organization></emphasis> will rank first documents that contain the
- word <quote>first</quote> as part of the name of an organization. The UIMA SDK
- documentation demonstrates how UIMA applications can be built using semantic
- search. It provides details about the XML Fragment Query language. This is the
- particular query language used by the semantic search engine that comes with the
- SDK.</para></listitem>
- </varlistentry>
- <varlistentry id="ugr.faqs.xml_fragment_not_xml">
- <term><emphasis role="bold">Is an XML Fragment Query valid XML?</emphasis></term>
- <listitem><para>Not necessarily. The XML Fragment Query syntax is used to formulate
- queries interpreted by the semantic search engine that ships with the UIMA SDK.
- This query language relies on basic XML syntax as an intuitive way to describe
- hierarchical patterns of annotations that may occur in a <link linkend="ugr.faqs.what_is_the_cas">CAS</link>. The language
- deviates from valid XML in order to support queries over
- <quote>overlapping</quote> or <quote>cross-over</quote> annotations and
- other features that affect the interpretation of the query by the query processor.
- For example, it admits notations in the query to indicate whether a keyword or an
- annotation is optional or required to match a document.</para></listitem>
- </varlistentry>
- <varlistentry id="ugr.faqs.modalities_other_than_text">
- <term><emphasis role="bold">Does UIMA support modalities other than text?</emphasis></term>
- <listitem><para>The UIMA architecture supports the development, discovery,
- composition and deployment of multi-modal analytics including text, audio and
- video. Applications that process text, speech and video have been developed using
- UIMA. This release of the SDK, however, does not include examples of these
- multi-modal applications. </para>
-
- <para>It does however include documentation and programming examples for using
- the key feature required for building multi-modal applications. UIMA supports
- multiple subjects of analysis or <link linkend="ugr.faqs.what_is_a_sofa">Sofas</link>. These allow multiple views of a single
- artifact to be associated with a <link linkend="ugr.faqs.what_is_the_cas">CAS</link>. For example, if an artifact is a video
- stream, one Sofa could be associated with the video frames and another with the
- closed-captions text. UIMA's multiple Sofa feature is included and
- described in this release of the SDK.</para></listitem>
- </varlistentry>
- <varlistentry id="ugr.faqs.compare">
- <term><emphasis role="bold">How does UIMA compare to other similar work?</emphasis></term>
- <listitem><para>A number of different frameworks for NLP have preceded UIMA. Two of
- them were developed at IBM Research and represent UIMA's early roots. For
- details please refer to the UIMA article that appears in the IBM Systems Journal
- Vol. 43, No. 3 (<ulink
- url="http://www.research.ibm.com/journal/sj/433/ferrucci.html"/>
- ).</para>
-
- <para>UIMA has advanced that state of the art along a number of dimensions
- including: support for distributed deployments in different middleware
- environments, easy framework embedding in different software product
- platforms (key for commercial applications), broader architectural converge
- with its collection processing architecture, support for
- multiple-modalities, support for efficient integration across programming
- languages, support for a modern software engineering discipline calling out
- different roles in the use of UIMA to develop applications, the extensive use of
- descriptive component metadata to support development tooling, component
- discovery and composition. (Please note that not all of these features are
- available in this release of the SDK.)</para></listitem>
- </varlistentry>
- <varlistentry id="ugr.faqs.open_source">
- <term><emphasis role="bold">Is UIMA Open Source?</emphasis></term>
- <listitem><para>Yes. As of version 2, UIMA development has moved to Apache and is being
- developed within the Apache open source processes. It is licensed under the Apache
- version 2 license. Previous versions are available on the IBM alphaWorks site (
- <ulink url="http://www.alphaworks.ibm.com/tech/uima"/>) and the source
- code for previous version of the UIMA framework is available on SourceForge (
- <ulink url="http://uima-framework.sourceforge.net/"/>).</para>
- </listitem>
- </varlistentry>
- <varlistentry id="ugr.faqs.levels_required">
- <term><emphasis role="bold">What Java level and OS are required for the UIMA SDK?</emphasis></term>
+ the UIMA framework that manages the execution of a workflow of UIMA
+ components orchestrated to analyze a large collection of documents. The UIMA
+ developer does not implement or describe a CPM. It is a piece of infrastructure code
+ that handles CAS transport, instance management, batching, check-pointing,
+ statistics collection and failure recovery in the execution of a collection
+ processing workflow.</para>
+
+ <para>A Collection Processing Engine (CPE) is component created by the framework
+ from a specific CPE descriptor. A CPE descriptor refers to a series of UIMA
+ components including a Collection Reader, CAS Initializer, Analysis
+ Engine(s) and CAS Consumers. These components are organized in a work flow and
+ define a collection analysis job or CPE. A CPE acquires documents from a source
+ collection, initializes CASs with document content, performs document
+ analysis and then produces collection level results (e.g., search engine
+ index, database etc). The CPM is the execution engine for a CPE.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="ugr.faqs.semantic_search">
+ <term><emphasis role="bold">What is Semantic Search and what is its relationship to
+ UIMA?</emphasis></term>
+ <listitem><para>Semantic Search refers to a document search paradigm that allows
+ users to search based not just on the keywords contained in the documents, but also
+ on the semantics associated with the text by <link linkend="ugr.faqs.annotator_versus_ae">analysis engines</link>. UIMA applications
+ perform analysis on text documents and generate semantics in the form of
+ <link linkend="ugr.faqs.what_is_an_annotation">annotations</link> on regions of text. For example, a UIMA analysis engine may discover
+ the text <quote>First Financial Bank</quote> to refer to an organization and
+ annotated it as such. With traditional keyword search, the query
+ <command>first</command> will return all documents that contain that word.
+ <command>First</command> is a frequent and ambiguous term – it occurs a lot
+ and can mean different things in different places. If the user is looking for
+ organizations that contain that word <command>first</command> in their names,
+ s/he will likely have to sift through lots of documents containing the word
+ <quote>first</quote> used in different ways. Semantic Search exploits the
+ results of analysis to allow more precise queries. For example, the semantic
+ search query <emphasis><organization> first
+ </organization></emphasis> will rank first documents that contain the
+ word <quote>first</quote> as part of the name of an organization. The UIMA SDK
+ documentation demonstrates how UIMA applications can be built using semantic
+ search. It provides details about the XML Fragment Query language. This is the
+ particular query language used by the semantic search engine that comes with the
+ SDK.</para></listitem>
+ </varlistentry>
+ <varlistentry id="ugr.faqs.xml_fragment_not_xml">
+ <term><emphasis role="bold">Is an XML Fragment Query valid XML?</emphasis></term>
+ <listitem><para>Not necessarily. The XML Fragment Query syntax is used to formulate
+ queries interpreted by the semantic search engine that ships with the UIMA SDK.
+ This query language relies on basic XML syntax as an intuitive way to describe
+ hierarchical patterns of annotations that may occur in a <link linkend="ugr.faqs.what_is_the_cas">CAS</link>. The language
+ deviates from valid XML in order to support queries over
+ <quote>overlapping</quote> or <quote>cross-over</quote> annotations and
+ other features that affect the interpretation of the query by the query processor.
+ For example, it admits notations in the query to indicate whether a keyword or an
+ annotation is optional or required to match a document.</para></listitem>
+ </varlistentry>
+ <varlistentry id="ugr.faqs.modalities_other_than_text">
+ <term><emphasis role="bold">Does UIMA support modalities other than text?</emphasis></term>
+ <listitem><para>The UIMA architecture supports the development, discovery,
+ composition and deployment of multi-modal analytics including text, audio and
+ video. Applications that process text, speech and video have been developed using
+ UIMA. This release of the SDK, however, does not include examples of these
+ multi-modal applications. </para>
+
+ <para>It does however include documentation and programming examples for using
+ the key feature required for building multi-modal applications. UIMA supports
+ multiple subjects of analysis or <link linkend="ugr.faqs.what_is_a_sofa">Sofas</link>. These allow multiple views of a single
+ artifact to be associated with a <link linkend="ugr.faqs.what_is_the_cas">CAS</link>. For example, if an artifact is a video
+ stream, one Sofa could be associated with the video frames and another with the
+ closed-captions text. UIMA's multiple Sofa feature is included and
+ described in this release of the SDK.</para></listitem>
+ </varlistentry>
+ <varlistentry id="ugr.faqs.compare">
+ <term><emphasis role="bold">How does UIMA compare to other similar work?</emphasis></term>
+ <listitem><para>A number of different frameworks for NLP have preceded UIMA. Two of
+ them were developed at IBM Research and represent UIMA's early roots. For
+ details please refer to the UIMA article that appears in the IBM Systems Journal
+ Vol. 43, No. 3 (<ulink
+ url="http://www.research.ibm.com/journal/sj/433/ferrucci.html"/>
+ ).</para>
+
+ <para>UIMA has advanced that state of the art along a number of dimensions
+ including: support for distributed deployments in different middleware
+ environments, easy framework embedding in different software product
+ platforms (key for commercial applications), broader architectural converge
+ with its collection processing architecture, support for
+ multiple-modalities, support for efficient integration across programming
+ languages, support for a modern software engineering discipline calling out
+ different roles in the use of UIMA to develop applications, the extensive use of
+ descriptive component metadata to support development tooling, component
+ discovery and composition. (Please note that not all of these features are
+ available in this release of the SDK.)</para></listitem>
+ </varlistentry>
+ <varlistentry id="ugr.faqs.open_source">
+ <term><emphasis role="bold">Is UIMA Open Source?</emphasis></term>
+ <listitem><para>Yes. As of version 2, UIMA development has moved to Apache and is being
+ developed within the Apache open source processes. It is licensed under the Apache
+ version 2 license. Previous versions are available on the IBM alphaWorks site (
+ <ulink url="http://www.alphaworks.ibm.com/tech/uima"/>) and the source
+ code for previous version of the UIMA framework is available on SourceForge (
+ <ulink url="http://uima-framework.sourceforge.net/"/>).</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="ugr.faqs.levels_required">
+ <term><emphasis role="bold">What Java level and OS are required for the UIMA SDK?</emphasis></term>
<listitem><para>As of release 2.2.1, the UIMA SDK requires a Java 1.5 level (or later). Releases prior to 2.2.1
require as a minimum the Java 1.4 level; they will not run on 1.3 (or earlier levels).
The release has been tested with Java 5 and 6.
It has been tested on mainly on Windows XP and Linux Intel 32bit platforms, with some
- testing on the MacOSX. Other
- platforms and JDK implementations will likely work, but have
- not been as significantly tested.</para></listitem>
- </varlistentry>
- <varlistentry id="ugr.faqs.building_apps_on_top_of_uima">
- <term><emphasis role="bold">Can I build my UIM application on top of UIMA?</emphasis></term>
- <listitem><para>Yes. Apache UIMA is licensed under the Apache version 2 license,
- enabling you to build and distribute applications which include the framework.
- </para></listitem>
- </varlistentry>
- <varlistentry id="ugr.faqs.commercial_products">
- <term><emphasis role="bold">Do any commercial products support the UIMA framework or include
- it as part of their product?</emphasis></term>
- <listitem><para>Yes. IBM's WebSphere Information Integration Omnifind Edition
- product (<ulink
- url="http://www.ibm.com/developerworks/db2/zones/db2ii"/> or <ulink
- url="http://www-306.ibm.com/software/data/integration/db2ii/editions_womnifind.html"/>
- ) has UIMA <quote>inside</quote> and supports adding UIMA annotators to the
- processing pipeline. We are actively seeking other product embeddings. </para>
- </listitem>
- </varlistentry>
- <!--
- <varlistentry>
- <term><emphasis role="bold"></emphasis></term>
- <listitem><para></para></listitem>
- </varlistentry>
- -->
- </variablelist>
-</chapter>
+ testing on the MacOSX. Other
+ platforms and JDK implementations will likely work, but have
+ not been as significantly tested.</para></listitem>
+ </varlistentry>
+ <varlistentry id="ugr.faqs.building_apps_on_top_of_uima">
+ <term><emphasis role="bold">Can I build my UIM application on top of UIMA?</emphasis></term>
+ <listitem><para>Yes. Apache UIMA is licensed under the Apache version 2 license,
+ enabling you to build and distribute applications which include the framework.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry id="ugr.faqs.commercial_products">
+ <term><emphasis role="bold">Do any commercial products support the UIMA framework or include
+ it as part of their product?</emphasis></term>
+ <listitem><para>Yes. IBM's WebSphere Information Integration Omnifind Edition
+ product (<ulink
+ url="http://www.ibm.com/developerworks/db2/zones/db2ii"/> or <ulink
+ url="http://www-306.ibm.com/software/data/integration/db2ii/editions_womnifind.html"/>
+ ) has UIMA <quote>inside</quote> and supports adding UIMA annotators to the
+ processing pipeline. We are actively seeking other product embeddings. </para>
+ </listitem>
+ </varlistentry>
+ <!--
+ <varlistentry>
+ <term><emphasis role="bold"></emphasis></term>
+ <listitem><para></para></listitem>
+ </varlistentry>
+ -->
+ </variablelist>
+</chapter>
Propchange: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/faqs.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/glossary.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/glossary.xml?rev=689997&r1=689996&r2=689997&view=diff
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/glossary.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/glossary.xml Thu Aug 28 14:28:14 2008
@@ -22,7 +22,7 @@
specific language governing permissions and limitations
under the License.
-->
-<glossary id="ugr.glossary">
+<glossary id="ugr.glossary">
<title>Glossary: Key Terms & Concepts</title>
<titleabbrev>Glossary</titleabbrev>
<!--
@@ -554,6 +554,6 @@
</glossary>
- <!--
+ <!--
</chapter>
- -->
+ -->
Propchange: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/glossary.xml
------------------------------------------------------------------------------
svn:eol-style = native