You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by mb...@apache.org on 2007/07/16 13:52:18 UTC
svn commit: r556594 - in /incubator/uima/site/trunk/uima-website: docs/
docs/images/getting-started/ xdocs/ xdocs/images/getting-started/
Author: mbaessler
Date: Mon Jul 16 04:52:16 2007
New Revision: 556594
URL: http://svn.apache.org/viewvc?view=rev&rev=556594
Log:
UIMA-506
commit UIMA getting started - UIMA examples
JIRA ticket https://issues.apache.org/jira/browse/UIMA-506
Added:
incubator/uima/site/trunk/uima-website/docs/doc-uima-examples.html
incubator/uima/site/trunk/uima-website/docs/images/getting-started/
incubator/uima/site/trunk/uima-website/docs/images/getting-started/analytics-world.jpg (with props)
incubator/uima/site/trunk/uima-website/docs/images/getting-started/analyzed_docs.jpg (with props)
incubator/uima/site/trunk/uima-website/docs/images/getting-started/annotations.jpg (with props)
incubator/uima/site/trunk/uima-website/docs/images/getting-started/interactive.jpg (with props)
incubator/uima/site/trunk/uima-website/docs/images/getting-started/run_config.jpg (with props)
incubator/uima/site/trunk/uima-website/xdocs/doc-uima-examples.xml
incubator/uima/site/trunk/uima-website/xdocs/images/getting-started/
incubator/uima/site/trunk/uima-website/xdocs/images/getting-started/analytics-world.jpg (with props)
incubator/uima/site/trunk/uima-website/xdocs/images/getting-started/analyzed_docs.jpg (with props)
incubator/uima/site/trunk/uima-website/xdocs/images/getting-started/annotations.jpg (with props)
incubator/uima/site/trunk/uima-website/xdocs/images/getting-started/interactive.jpg (with props)
incubator/uima/site/trunk/uima-website/xdocs/images/getting-started/run_config.jpg (with props)
Modified:
incubator/uima/site/trunk/uima-website/xdocs/documentation.xml
Added: incubator/uima/site/trunk/uima-website/docs/doc-uima-examples.html
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/docs/doc-uima-examples.html?view=auto&rev=556594
==============================================================================
--- incubator/uima/site/trunk/uima-website/docs/doc-uima-examples.html (added)
+++ incubator/uima/site/trunk/uima-website/docs/doc-uima-examples.html Mon Jul 16 04:52:16 2007
@@ -0,0 +1,407 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+
+<!--
+Copyright 1999-2004 The Apache Software Foundation
+Licensed 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.
+-->
+
+
+<!-- Content Stylesheet for Site -->
+
+
+<!-- start the processing -->
+ <!-- ====================================================================== -->
+ <!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
+ <!-- Main Page Section -->
+ <!-- ====================================================================== -->
+ <html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
+
+ <meta name="author" value="
+ UIMA Documentation Team
+ ">
+ <meta name="email" value="uima-dev@incubator.apache.org">
+
+
+
+
+
+
+
+ <title>Apache UIMA - Getting Started: UIMA Examples</title>
+ </head>
+
+ <body bgcolor="#ffffff" text="#000000" link="#525D76">
+ <table border="0" width="100%" cellspacing="0">
+ <!-- TOP IMAGE -->
+ <tr>
+ <td align='LEFT'>
+ <td align="left">
+<a href="http://incubator.apache.org/"><img src="./images/apache-incubator-logo.png" alt="Apache UIMA" border="0"/></a>
+</td>
+ </td>
+ <td align='CENTER'>
+ <td width="80%" align="center" valign="bottom" bgcolor="#ffffff">
+ <font color="#625972" size="+3" face="arial,helvetica,sanserif">
+ <b>Getting Started: UIMA Examples</b>
+</font>
+</td>
+ </td>
+ <td align='RIGHT'>
+ <td align="left">
+<img src="./images/UIMA_banner.png" alt="UIMA project logo" border="0"/>
+</td>
+ </td>
+ </tr>
+ </table>
+ <table border="0" width="100%" cellspacing="4">
+ <tr><td colspan="2">
+ <hr noshade="" size="1"/>
+ </td></tr>
+
+ <tr>
+ <!-- LEFT SIDE NAVIGATION -->
+ <td width="20%" valign="top" nowrap="true">
+
+ <!-- special ACon Logo - leave here for next time
+ <a href="http://apachecon.com/2005/US/">
+ <img src="http://apache.org/images/ac2005us_blue_125x125.jpg" height="125"
+ width="125" border="0" alt="ApacheCon US 2005" />
+ </a> -->
+
+ <!-- regular menu -->
+
+
+ <!-- ============================================================ -->
+
+ <p><strong>General</strong></p>
+ <ul>
+ <li> <a href="./index.html">Home</a>
+</li>
+ <li> <a href="./news.html">News</a>
+</li>
+ <li> <a href="./documentation.html">Documentation</a>
+</li>
+ <li> <a href="./downloads.html">Downloads</a>
+</li>
+ <li> <a href="./license.html">License</a>
+</li>
+ <li> <a href="http://www.apache.org/">ASF</a>
+</li>
+ </ul>
+ <p><strong>Community</strong></p>
+ <ul>
+ <li> <a href="./project-guidelines.html">Project Guidelines</a>
+</li>
+ <li> <a href="./contribution-policy.html">Contribution Policies</a>
+</li>
+ <li> <a href="./get-involved.html">Get Involved</a>
+</li>
+ <li> <a href="./team-list.html">Committers</a>
+</li>
+ <li> <a href="./mail-lists.html">Mailing Lists</a>
+</li>
+ <li> <a href="./faq.html">FAQ</a>
+</li>
+ <li> <a href="http://cwiki.apache.org/UIMA/">Wiki</a>
+</li>
+ <li> <a href="./external-resources.html">External UIMA Resources</a>
+</li>
+ </ul>
+ <p><strong>Development</strong></p>
+ <ul>
+ <li> <a href="./svn.html">Source Code</a>
+</li>
+ <li> <a href="./distribution.html">Creating a Distribution</a>
+</li>
+ <li> <a href="./codeConventions.html">Code Conventions</a>
+</li>
+ <li> <a href="http://issues.apache.org/jira/browse/uima ">JIRA</a>
+</li>
+ <li> <a href="./uima-specification.html">UIMA Specification</a>
+</li>
+ <li> <a href="./sandbox.html">Sandbox</a>
+</li>
+ </ul>
+ <p><strong>Conferences</strong></p>
+ <ul>
+ <li> <a href="./gldv07.html">GLDV 2007</a>
+</li>
+ </ul>
+ </td>
+ <td width="80%" align="left" valign="top">
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#726982">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="Getting Started: UIMA Examples"><strong>Getting Started: UIMA Examples</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ The "Getting Started: UIMA Examples" guide should help you to understand what UIMA is,
+ what it can be used for, and how you can use it. You will learn, after a short UIMA overview,
+ how to install the UIMA release package and how run the UIMA analysis example.
+ </p>
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+
+
+ <tr><td bgcolor="#9289A2">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="What Is UIMA"><strong>What Is UIMA</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ UIMA stands for Unstructured Information Management Architecture and is a component
+ architecture and software framework implementation for the analysis of unstructured
+ content like text, video and audio data. Unstructured information represents the largest,
+ most current and fastest growing source of information available to businesses and governments.
+ </p>
+ <p>
+ The motivation to develop such a framework was to build a common platform for unstructured analytics,
+ to foster reuse of analysis components and to reduce duplication of analysis development.
+ The pluggable architecture of UIMA allows to easily plug-in your own analysis components and
+ combine them together with others. A full analysis task of a solution using unstructured analytics
+ like search or government intelligence applications is often not a
+ monolithic thing but a multi-stage process where different modules need to build on each other
+ to get a powerful analysis chain. In some cases also annotators from different specialized vendors
+ may need to work together to produce the results needed.
+ The UIMA application interested in such analysis results does not need to know the details of how annotators
+ work together to create the results. The UIMA framework take care of the integration and orchestration
+ of multiple annotators.
+ </p>
+ <p>
+ So the major goal of UIMA is to transform unstructured information to structured
+ information by orchestrating analysis engines to detect entities or relations and thus to build the
+ bridge between the unstructured and the structured world.
+ </p>
+ <p>
+ <table width="100%"><tr><td align="center" valign="middle">
+ <img src="./images/getting-started/analytics-world.jpg" alt="analytics world" border="0" />
+ </td></tr></table>
+ </p>
+ <p>
+ The Apache UIMA incubator project provides two Apache licensed UIMA framework implementations,
+ one for Java and one for C++.
+ </p>
+ </blockquote>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+
+
+ <tr><td bgcolor="#9289A2">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="What Can UIMA Be Used For"><strong>What Can UIMA Be Used For</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ There are lots of use cases where UIMA may be applicable. One of the major ones are search applications.
+ Within search applications, the unstructured content that is available mainly as text in various kinds
+ must be processed and analyzed to be searchable. To obtain a powerful search application, the text
+ content must be analyzed to get the document language followed by language dependent linguistic
+ processing such as tokenization, lemmatization and part of speech detection. After these steps a
+ more sophisticated analysis like entity detection and relation detection between entities can be done.
+ For all these analysis steps UIMA and UIMA components can be used.
+ </p>
+ <p>
+ Another important use case is business or government intelligence. For example, UIMA analysis is used
+ to extract structured information from car repair reports. This data is then used for quality feed-back
+ and problem early warning systems.
+ </p>
+ <p>
+ Other possible solutions where UIMA can be used for are the analsyis of call center notes to detect product
+ problems and customer issues or a public image monitoring solution to find out how others for example in internet
+ forums or press releases think about my product or company.
+ </p>
+ </blockquote>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+
+
+ <tr><td bgcolor="#9289A2">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="Install UIMA"><strong>Install UIMA</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ To get started with UIMA, you first have to install the Apache UIMA release package.
+ The packages are available at the UIMA <a href="downloads.html">download page</a> in different data formats for different platforms.
+ To install UIMA, download the perferred packages and unzip the binary distribution package to a target directory of your choice.
+ After unzipping the package, create an UIMA_HOME environment variable that points to the target
+ directory where you have unzipped the release package. If you haven't already set a JAVA_HOME variable,
+ create a JAVA_HOME environment variable that points to a JDK (Java Development Kit) of your choice. UIMA requires at least a
+ Java level 1.4 to run. For more details about the supported Java versions, please refer to the README document of the
+ release package.
+ </p>
+ <p>
+ If you want to have the UIMA script files in the PATH environment variable of your system you additionally have to add
+ $UIMA_HOME/bin (or for Windows %UIMA_HOME%\bin) to your PATH settings.
+ </p>
+ <p>
+ Now the installation of UIMA is finished and all the tooling should work properly.
+ To use the provided examples you have to perform an additional step to
+ adjust the examples to your UIMA installation directory. To do that, just run the
+ <code>adjustExamplePaths.sh</code> (or for Windows .bat) script in the <code>bin</code> subdirectory of your UIMA installation.
+ </p>
+ </blockquote>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+
+
+ <tr><td bgcolor="#9289A2">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="Running The UIMA Analysis Example"><strong>Running The UIMA Analysis Example</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ UIMA comes with many examples for the different UIMA components and artifacts that can be created.
+ All these examples are explained and used in the UIMA documentation when the specific components or
+ artifacts are introduced. The UIMA analysis example that we want to use now is a combination of
+ some of these example components that shows a basic document analysis using UIMA.
+ </p>
+ <p>
+ To run the UIMA analysis example, we use the UIMA DocumentAnalyzer tooling that comes with the UIMA SDK.
+ The tool can run UIMA analysis components (also know as annotators) on a given set of text documents
+ and shows the result of the analysis run at the end.
+ </p>
+ <p>
+ To start the UIMA DocumentAnalyzer, start the <code>documentAnalyzer.sh</code> (or for Windows .bat) file located in the <code>bin</code>
+ subdirectory of your UIMA installation. The DocumentAnalyzer window pops up where the following values
+ must be set to run the UIMA analysis example:
+ </p>
+ <p>
+ Input Directory: <code><UIMA_HOME>/examples/data</code><br />
+ Output Directory: <code><UIMA_HOME>/examples/data/processed </code><br />
+ AE XML Descriptor: <code><UIMA_HOME>/examples/descriptors/analysis_engine/UIMA_Analysis_Example.xml </code><br />
+ </p>
+ <p>
+ Replace <UIMA_HOME> above with the path of your Apache UIMA installation directory. In the sample screenshot below, the Apache
+ UIMA installation directory was "C:\programme\apache-uima".
+ </p>
+ <p>
+ <table width="100%"><tr><td align="center" valign="middle">
+ <img src="./images/getting-started/run_config.jpg" alt="DocumentAnalyzer run configuration" border="0" />
+ </td></tr></table>
+ </p>
+ <p>
+ To analyze the doccuments, click the "Run" button, which should, after a brief pause, pop up an "Analyzed Results" window.
+ </p>
+ <p>
+ <table width="100%"><tr><td align="center" valign="middle">
+ <img src="./images/getting-started/analyzed_docs.jpg" alt="Analyzed Documents view" border="0" />
+ </td></tr></table>
+ </p>
+ <p>
+ To display the analysis results for one of the documents, just double-click the desired document.
+ The important one for the UIMA analysis example is the Apache_UIMA.xmi file.
+ When you open this document from the result list, you will see different kind of annotations such as:
+ </p>
+ <p>
+ <ul>
+ <li>EmailAddress annotations</li>
+ <li>Name annotations</li>
+ <li>PersonTitle annotations</li>
+ <li>Sentence annotations</li>
+ <li>Token annotations</li>
+ </ul>
+ </p>
+ <p>
+ When selecting the check-box for those annotations the highlighting in the text for those
+ annotations can be turned on or off.
+ </p>
+ <p>
+ <table width="100%"><tr><td align="center" valign="middle">
+ <img src="./images/getting-started/annotations.jpg" alt="DocumentAnalyzer annotation view" border="0" />
+ </td></tr></table>
+ </p>
+ <p>
+ This concludes the exercise. You may wish to experiment by submitting text of your own for analysis.
+ To do that you can use the DocumentAnalyzer in the interactive mode. Just click the "Interactive" button instead
+ of the "Run" button when you have entered the settings for the analysis example as seen in the screenshot above.
+ </p>
+ <p>
+ After clicking the "Interactive" button to following screen is displayed where you can enter your text.
+ </p>
+ <p>
+ <table width="100%"><tr><td align="center" valign="middle">
+ <img src="./images/getting-started/interactive.jpg" alt="DocumentAnalyzer interactive mode" border="0" />
+ </td></tr></table>
+ </p>
+ <p>
+ When clicking the "Analyze" button your text will be analyzed and you will see the analysis results
+ in the annotation view in the same way as for the example above.
+ </p>
+ </blockquote>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+ </blockquote>
+ </p>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+
+ </td>
+ </tr>
+
+ <!-- FOOTER -->
+ <tr><td colspan="2">
+ <hr noshade="" size="1"/>
+ </td></tr>
+ <tr><td colspan="2">
+ <div align="center"><font color="#525D76" size="-1"><em>
+ Copyright © 2003-2006, The Apache Software Foundation
+ </em></font></div>
+ </td></tr>
+ </table>
+ </body>
+ </html>
+<!-- end the processing -->
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Added: incubator/uima/site/trunk/uima-website/docs/images/getting-started/analytics-world.jpg
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/docs/images/getting-started/analytics-world.jpg?view=auto&rev=556594
==============================================================================
Binary file - no diff available.
Propchange: incubator/uima/site/trunk/uima-website/docs/images/getting-started/analytics-world.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/uima/site/trunk/uima-website/docs/images/getting-started/analyzed_docs.jpg
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/docs/images/getting-started/analyzed_docs.jpg?view=auto&rev=556594
==============================================================================
Binary file - no diff available.
Propchange: incubator/uima/site/trunk/uima-website/docs/images/getting-started/analyzed_docs.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/uima/site/trunk/uima-website/docs/images/getting-started/annotations.jpg
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/docs/images/getting-started/annotations.jpg?view=auto&rev=556594
==============================================================================
Binary file - no diff available.
Propchange: incubator/uima/site/trunk/uima-website/docs/images/getting-started/annotations.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/uima/site/trunk/uima-website/docs/images/getting-started/interactive.jpg
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/docs/images/getting-started/interactive.jpg?view=auto&rev=556594
==============================================================================
Binary file - no diff available.
Propchange: incubator/uima/site/trunk/uima-website/docs/images/getting-started/interactive.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/uima/site/trunk/uima-website/docs/images/getting-started/run_config.jpg
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/docs/images/getting-started/run_config.jpg?view=auto&rev=556594
==============================================================================
Binary file - no diff available.
Propchange: incubator/uima/site/trunk/uima-website/docs/images/getting-started/run_config.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/uima/site/trunk/uima-website/xdocs/doc-uima-examples.xml
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/xdocs/doc-uima-examples.xml?view=auto&rev=556594
==============================================================================
--- incubator/uima/site/trunk/uima-website/xdocs/doc-uima-examples.xml (added)
+++ incubator/uima/site/trunk/uima-website/xdocs/doc-uima-examples.xml Mon Jul 16 04:52:16 2007
@@ -0,0 +1,209 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<!--
+ 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>Getting Started: UIMA Examples</title>
+ <author email="uima-dev@incubator.apache.org">
+ UIMA Documentation Team
+ </author>
+ </properties>
+
+ <body>
+ <section name="Getting Started: UIMA Examples">
+ <p>
+ The "Getting Started: UIMA Examples" guide should help you to understand what UIMA is,
+ what it can be used for, and how you can use it. You will learn, after a short UIMA overview,
+ how to install the UIMA release package and how run the UIMA analysis example.
+ </p>
+
+ <subsection name="What Is UIMA">
+
+ <p>
+ UIMA stands for Unstructured Information Management Architecture and is a component
+ architecture and software framework implementation for the analysis of unstructured
+ content like text, video and audio data. Unstructured information represents the largest,
+ most current and fastest growing source of information available to businesses and governments.
+ </p>
+ <p>
+ The motivation to develop such a framework was to build a common platform for unstructured analytics,
+ to foster reuse of analysis components and to reduce duplication of analysis development.
+ The pluggable architecture of UIMA allows to easily plug-in your own analysis components and
+ combine them together with others. A full analysis task of a solution using unstructured analytics
+ like search or government intelligence applications is often not a
+ monolithic thing but a multi-stage process where different modules need to build on each other
+ to get a powerful analysis chain. In some cases also annotators from different specialized vendors
+ may need to work together to produce the results needed.
+ The UIMA application interested in such analysis results does not need to know the details of how annotators
+ work together to create the results. The UIMA framework take care of the integration and orchestration
+ of multiple annotators.
+ </p>
+ <p>
+ So the major goal of UIMA is to transform unstructured information to structured
+ information by orchestrating analysis engines to detect entities or relations and thus to build the
+ bridge between the unstructured and the structured world.
+ </p>
+ <p>
+ <table width="100%"><tr><td align="center" valign="middle">
+ <img src="./images/getting-started/analytics-world.jpg" alt="analytics world" border="0"/>
+ </td></tr></table>
+ </p>
+ <p>
+ The Apache UIMA incubator project provides two Apache licensed UIMA framework implementations,
+ one for Java and one for C++.
+ </p>
+
+ </subsection>
+
+ <subsection name="What Can UIMA Be Used For">
+ <p>
+ There are lots of use cases where UIMA may be applicable. One of the major ones are search applications.
+ Within search applications, the unstructured content that is available mainly as text in various kinds
+ must be processed and analyzed to be searchable. To obtain a powerful search application, the text
+ content must be analyzed to get the document language followed by language dependent linguistic
+ processing such as tokenization, lemmatization and part of speech detection. After these steps a
+ more sophisticated analysis like entity detection and relation detection between entities can be done.
+ For all these analysis steps UIMA and UIMA components can be used.
+ </p>
+ <p>
+ Another important use case is business or government intelligence. For example, UIMA analysis is used
+ to extract structured information from car repair reports. This data is then used for quality feed-back
+ and problem early warning systems.
+ </p>
+ <p>
+ Other possible solutions where UIMA can be used for are the analsyis of call center notes to detect product
+ problems and customer issues or a public image monitoring solution to find out how others for example in internet
+ forums or press releases think about my product or company.
+ </p>
+ </subsection>
+
+ <subsection name="Install UIMA">
+ <p>
+ To get started with UIMA, you first have to install the Apache UIMA release package.
+ The packages are available at the UIMA <a href="downloads.html">download page</a> in different data formats for different platforms.
+ To install UIMA, download the perferred packages and unzip the binary distribution package to a target directory of your choice.
+ After unzipping the package, create an UIMA_HOME environment variable that points to the target
+ directory where you have unzipped the release package. If you haven't already set a JAVA_HOME variable,
+ create a JAVA_HOME environment variable that points to a JDK (Java Development Kit) of your choice. UIMA requires at least a
+ Java level 1.4 to run. For more details about the supported Java versions, please refer to the README document of the
+ release package.
+ </p>
+ <p>
+ If you want to have the UIMA script files in the PATH environment variable of your system you additionally have to add
+ $UIMA_HOME/bin (or for Windows %UIMA_HOME%\bin) to your PATH settings.
+ </p>
+ <p>
+ Now the installation of UIMA is finished and all the tooling should work properly.
+ To use the provided examples you have to perform an additional step to
+ adjust the examples to your UIMA installation directory. To do that, just run the
+ <code>adjustExamplePaths.sh</code> (or for Windows .bat) script in the <code>bin</code> subdirectory of your UIMA installation.
+ </p>
+ </subsection>
+
+ <subsection name="Running The UIMA Analysis Example">
+ <p>
+ UIMA comes with many examples for the different UIMA components and artifacts that can be created.
+ All these examples are explained and used in the UIMA documentation when the specific components or
+ artifacts are introduced. The UIMA analysis example that we want to use now is a combination of
+ some of these example components that shows a basic document analysis using UIMA.
+ </p>
+ <p>
+ To run the UIMA analysis example, we use the UIMA DocumentAnalyzer tooling that comes with the UIMA SDK.
+ The tool can run UIMA analysis components (also know as annotators) on a given set of text documents
+ and shows the result of the analysis run at the end.
+ </p>
+ <p>
+ To start the UIMA DocumentAnalyzer, start the <code>documentAnalyzer.sh</code> (or for Windows .bat) file located in the <code>bin</code>
+ subdirectory of your UIMA installation. The DocumentAnalyzer window pops up where the following values
+ must be set to run the UIMA analysis example:
+ </p>
+ <p>
+ Input Directory: <code><UIMA_HOME>/examples/data</code><br></br>
+ Output Directory: <code><UIMA_HOME>/examples/data/processed </code><br></br>
+ AE XML Descriptor: <code><UIMA_HOME>/examples/descriptors/analysis_engine/UIMA_Analysis_Example.xml </code><br></br>
+ </p>
+ <p>
+ Replace <UIMA_HOME> above with the path of your Apache UIMA installation directory. In the sample screenshot below, the Apache
+ UIMA installation directory was "C:\programme\apache-uima".
+ </p>
+ <p>
+ <table width="100%"><tr><td align="center" valign="middle">
+ <img src="./images/getting-started/run_config.jpg" alt="DocumentAnalyzer run configuration" border="0"/>
+ </td></tr></table>
+ </p>
+ <p>
+ To analyze the doccuments, click the "Run" button, which should, after a brief pause, pop up an "Analyzed Results" window.
+ </p>
+ <p>
+ <table width="100%"><tr><td align="center" valign="middle">
+ <img src="./images/getting-started/analyzed_docs.jpg" alt="Analyzed Documents view" border="0"/>
+ </td></tr></table>
+ </p>
+ <p>
+ To display the analysis results for one of the documents, just double-click the desired document.
+ The important one for the UIMA analysis example is the Apache_UIMA.xmi file.
+ When you open this document from the result list, you will see different kind of annotations such as:
+ </p>
+ <p>
+ <ul>
+ <li>EmailAddress annotations</li>
+ <li>Name annotations</li>
+ <li>PersonTitle annotations</li>
+ <li>Sentence annotations</li>
+ <li>Token annotations</li>
+ </ul>
+ </p>
+ <p>
+ When selecting the check-box for those annotations the highlighting in the text for those
+ annotations can be turned on or off.
+ </p>
+ <p>
+ <table width="100%"><tr><td align="center" valign="middle">
+ <img src="./images/getting-started/annotations.jpg" alt="DocumentAnalyzer annotation view" border="0"/>
+ </td></tr></table>
+ </p>
+ <p>
+ This concludes the exercise. You may wish to experiment by submitting text of your own for analysis.
+ To do that you can use the DocumentAnalyzer in the interactive mode. Just click the "Interactive" button instead
+ of the "Run" button when you have entered the settings for the analysis example as seen in the screenshot above.
+ </p>
+ <p>
+ After clicking the "Interactive" button to following screen is displayed where you can enter your text.
+ </p>
+ <p>
+ <table width="100%"><tr><td align="center" valign="middle">
+ <img src="./images/getting-started/interactive.jpg" alt="DocumentAnalyzer interactive mode" border="0"/>
+ </td></tr></table>
+ </p>
+ <p>
+ When clicking the "Analyze" button your text will be analyzed and you will see the analysis results
+ in the annotation view in the same way as for the example above.
+ </p>
+ </subsection>
+ </section>
+
+
+
+ </body>
+
+</document>
+
Modified: incubator/uima/site/trunk/uima-website/xdocs/documentation.xml
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/xdocs/documentation.xml?view=diff&rev=556594&r1=556593&r2=556594
==============================================================================
--- incubator/uima/site/trunk/uima-website/xdocs/documentation.xml (original)
+++ incubator/uima/site/trunk/uima-website/xdocs/documentation.xml Mon Jul 16 04:52:16 2007
@@ -51,7 +51,25 @@
<p>
<a href="apidocs.zip">Download Apache UIMA Javadoc</a>
</p>
- </section>
+ </section>
+ <!--
+ <section name="Getting Started">
+ <p>
+ The UIMA "Getting Started" guides are intended to offer a quick overview of UIMA and how it works.
+ They are designed to address different audiences that want to work with UIMA.
+ </p>
+ <p>
+ The section below lists all currently available "getting started" guides with their links.
+ For more advanced documentation about these topics, please refer to the Apache UIMA release documentation.
+ <ul>
+
+ <li><a href="doc-uima-examples.html">Getting Started: UIMA Examples</a><br></br>
+ For first time UIMA users who want to know what UIMA is, how it is installed and how they can run
+ the UIMA analysis example that is provided with the release package.</li>
+ </ul>
+ </p>
+ </section>
+ -->
</body>
Added: incubator/uima/site/trunk/uima-website/xdocs/images/getting-started/analytics-world.jpg
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/xdocs/images/getting-started/analytics-world.jpg?view=auto&rev=556594
==============================================================================
Binary file - no diff available.
Propchange: incubator/uima/site/trunk/uima-website/xdocs/images/getting-started/analytics-world.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/uima/site/trunk/uima-website/xdocs/images/getting-started/analyzed_docs.jpg
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/xdocs/images/getting-started/analyzed_docs.jpg?view=auto&rev=556594
==============================================================================
Binary file - no diff available.
Propchange: incubator/uima/site/trunk/uima-website/xdocs/images/getting-started/analyzed_docs.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/uima/site/trunk/uima-website/xdocs/images/getting-started/annotations.jpg
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/xdocs/images/getting-started/annotations.jpg?view=auto&rev=556594
==============================================================================
Binary file - no diff available.
Propchange: incubator/uima/site/trunk/uima-website/xdocs/images/getting-started/annotations.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/uima/site/trunk/uima-website/xdocs/images/getting-started/interactive.jpg
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/xdocs/images/getting-started/interactive.jpg?view=auto&rev=556594
==============================================================================
Binary file - no diff available.
Propchange: incubator/uima/site/trunk/uima-website/xdocs/images/getting-started/interactive.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/uima/site/trunk/uima-website/xdocs/images/getting-started/run_config.jpg
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/xdocs/images/getting-started/run_config.jpg?view=auto&rev=556594
==============================================================================
Binary file - no diff available.
Propchange: incubator/uima/site/trunk/uima-website/xdocs/images/getting-started/run_config.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream