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 2013/07/26 23:33:22 UTC
svn commit: r1507472 [1/7] - in
/uima/site/trunk/uima-website/docs/d/uimaj-2.4.1: README RELEASE_NOTES.html
references.html references.pdf tools.html tools.pdf
tutorials_and_users_guides.html tutorials_and_users_guides.pdf
Author: schor
Date: Fri Jul 26 21:33:21 2013
New Revision: 1507472
URL: http://svn.apache.org/r1507472
Log:
no Jira - release 2.4.1 uima sdk updates for website, including news, downloads, doc page refs. Doing this in pieces to see if I can get it to go.
Added:
uima/site/trunk/uima-website/docs/d/uimaj-2.4.1/README (with props)
uima/site/trunk/uima-website/docs/d/uimaj-2.4.1/RELEASE_NOTES.html (with props)
uima/site/trunk/uima-website/docs/d/uimaj-2.4.1/references.html (with props)
uima/site/trunk/uima-website/docs/d/uimaj-2.4.1/references.pdf (with props)
uima/site/trunk/uima-website/docs/d/uimaj-2.4.1/tools.html (with props)
uima/site/trunk/uima-website/docs/d/uimaj-2.4.1/tools.pdf (with props)
uima/site/trunk/uima-website/docs/d/uimaj-2.4.1/tutorials_and_users_guides.html (with props)
uima/site/trunk/uima-website/docs/d/uimaj-2.4.1/tutorials_and_users_guides.pdf (with props)
Added: uima/site/trunk/uima-website/docs/d/uimaj-2.4.1/README
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimaj-2.4.1/README?rev=1507472&view=auto
==============================================================================
--- uima/site/trunk/uima-website/docs/d/uimaj-2.4.1/README (added)
+++ uima/site/trunk/uima-website/docs/d/uimaj-2.4.1/README Fri Jul 26 21:33:21 2013
@@ -0,0 +1,119 @@
+
+ Apache UIMA (Unstructured Information Management Architecture) v2.4.1 SDK
+ -------------------------------------------------------------------------
+
+Building from the Source Distribution
+-------------------------------------
+
+We use Maven 3.0 or later for building; download this if needed,
+and set the environment variable MAVEN_OPTS to -Xmx800m -XX:MaxPerSize=256m.
+
+Then do the build by going into the .../uimaj directory, and issuing the command
+ mvn clean install
+
+This builds everything except the ...source-release.zip file. If you want that,
+change the command to
+
+ mvn clean install -Papache-release
+
+Look for the result here:
+ target/uimaj-[version]-source-release.zip (if run with -Papache-release)
+
+For more details, please see http://uima.apache.org/building-uima.html
+
+What's New in 2.4.1
+-------------------
+
+ There are many improvements, some bug fixes, and tooling enhancements in this release. The major changes include:
+
+ * Documentation of binary serialization.
+ * New kinds of compressed binary serialization that compress the data significantly
+ and one form that supports unequal source/target type systems
+
+ * A new facility called External Parameter Overrides for specifying parameter settings for annotators
+ that uses properties files and is independent of the annotator hierarchy
+
+ * CasCopier enhancements to allow copying one view to a different view.
+
+ * Additional options to restrict JCasGen operation to generating just those types that are defined in a project,
+ excluding other types that are imported from other projects
+ * A new Maven plugin that runs JCasGen (see tools documentation for how to configure and use this)
+
+ * a new ability to preserve white space (indentation) when parsing XML descriptors; this is now used in the
+ Component Descriptor Editor (CDE), to preserve indentation when editing an existing descriptor.
+
+ * Performance and space improvements
+ * Some "bulk" methods for efficiently removing Feature Structures from Indexes
+
+ * The CDE supports 3 new things: the preserving of existing white-space in XML descriptors,
+ External Parameter Overrides, and a configuration option to restrict JCasGen to just those
+ types defined in the project.
+ * Enhancements to the DocumentAnalyzer utility to support reading CASes in various formats
+
+ Some User-facing Interfaces and Classes have new methods:
+ * FsIndexRepository - new methods for bulk removal of all instances of a type from the indexes
+ * JCas - same methods added for bulk removal, as above
+ * Serialization - Javadocs added to document the kinds of serialization and deserialization supported (binary and compressed binary forms)
+ - Methods added to support Binary Compressed serialization / deserialization
+ * CasCopier - new copyCasView methods for copying to a different view
+
+ Some interfaces and classes, less likely to be used by users, were changed:
+ * ConfigurationManager's createContext method has additional parameter for the new external parameter override mechanism
+ * ConfigurationParameter - has new support for external parameter override names
+
+
+
+Supported Platforms
+--------------------
+
+Apache UIMA requires Java level 1.5; it has been tested with Sun/Oracle Java SDK v5 and v6 amd v7, and IBM Java 6 and 7.
+Running the Eclipse plugin tooling for UIMA requires you start Eclipse using a Java 5 or later, as well.
+The supported platforms are: Windows, Linux, Solaris, AIX and Mac OS X.
+Other platforms and Java (5+) implementations should work, but have not been significantly tested.
+
+Many of the scripts in the /bin directory invoke Java. They use the value of the environment variable, JAVA_HOME,
+to locate the Java to use; if it is not set, they invoke "java" expecting to find an appropriate Java in your PATH.
+
+
+Environment Variables
+----------------------
+
+After you have unpacked the Apache UIMA distribution from the package of your choice (e.g. .zip or .gz),
+perform the steps below to set up UIMA so that it will function properly.
+
+ * Set JAVA_HOME to the directory of your JRE installation you would like to use for UIMA.
+ * Set UIMA_HOME to the apache-uima directory of your unpacked Apache UIMA distribution
+ * Append UIMA_HOME/bin to your PATH
+
+ * Please run the script UIMA_HOME/bin/adjustExamplePaths.bat (or .sh), to update
+ paths in the examples based on the actual UIMA_HOME directory path.
+ This script runs a Java program;
+ you must either have java in your PATH or set the environment variable JAVA_HOME to a
+ suitable JRE.
+
+ Note: The Mac OS X operating system procedures for setting up global environment
+ variables are described here: see http://developer.apple.com/qa/qa2001/qa1067.html.
+
+
+Verifying Your Installation
+----------------------------
+
+To test the installation, run the documentAnalyzer.bat (or .sh) file located in the bin subdirectory.
+This should pop up a "Document Analyzer" window. Set the values displayed in this GUI to as follows:
+
+ * Input Directory: UIMA_HOME/examples/data
+ * Output Directory: UIMA_HOME/examples/data/processed
+ * Location of Analysis Engine XML Descriptor: UIMA_HOME/examples/descriptors/analysis_engine/PersonTitleAnnotator.xml
+
+Replace UIMA_HOME above with the path of your Apache UIMA installation.
+
+Next, click the "Run" button, which should, after a brief pause, pop up an "Analyzed Results" window.
+Double-click on one of the documents to display the analysis results for that document.
+
+
+Getting Started
+----------------
+
+For an introduction to Apache UIMA and how to use it, please read the documentation
+located in the docs subdirectory. A good place to start is the overview_and_setup
+book's first chapter, which has a brief guide to the documentation.
\ No newline at end of file
Propchange: uima/site/trunk/uima-website/docs/d/uimaj-2.4.1/README
------------------------------------------------------------------------------
svn:eol-style = native
Added: uima/site/trunk/uima-website/docs/d/uimaj-2.4.1/RELEASE_NOTES.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimaj-2.4.1/RELEASE_NOTES.html?rev=1507472&view=auto
==============================================================================
--- uima/site/trunk/uima-website/docs/d/uimaj-2.4.1/RELEASE_NOTES.html (added)
+++ uima/site/trunk/uima-website/docs/d/uimaj-2.4.1/RELEASE_NOTES.html Fri Jul 26 21:33:21 2013
@@ -0,0 +1,186 @@
+ <!--
+ ***************************************************************
+ * 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.
+ ***************************************************************
+ -->
+<html>
+<head>
+ <title>Apache UIMA v2.4.1 Release Notes</title>
+</head>
+<body>
+<h1>Apache UIMA (Unstructured Information Management Architecture) v2.4.1 Release Notes</h1>
+
+<h2>Contents</h2>
+<p>
+<a href="#what.is.uima">What is UIMA?</a><br/>
+<a href="#major.changes">Major Changes in this Release</a><br/>
+<a href="#get.involved">How to Get Involved</a><br/>
+<a href="#report.issues">How to Report Issues</a><br/>
+<a href="#list.issues">List of JIRA Issues Fixed in this Release</a><br/>
+<a href="#migrating">Migrating from IBM UIMA to Apache UIMA</a><br/>
+</p>
+
+<h2><a name="what.is.uima">1. What is UIMA?</a></h2>
+
+ <p>
+ Unstructured Information Management applications are
+ software systems that analyze large volumes of
+ unstructured information in order to discover knowledge
+ that is relevant to an end user. UIMA is a framework and
+ SDK for developing such applications. An example UIM
+ application might ingest plain text and identify
+ entities, such as persons, places, organizations; or
+ relations, such as works-for or located-at. UIMA enables
+ such an application to be decomposed into components,
+ for example "language identification" -> "language
+ specific segmentation" -> "sentence boundary
+ detection" -> "entity detection (person/place names
+ etc.)". Each component must implement interfaces defined
+ by the framework and must provide self-describing
+ metadata via XML descriptor files. The framework manages
+ these components and the data flow between them.
+ Components are written in Java or C++; the data that
+ flows between components is designed for efficient
+ mapping between these languages. UIMA additionally
+ provides capabilities to wrap components as network
+ services, and can scale to very large volumes by
+ replicating processing pipelines over a cluster of
+ networked nodes.
+ </p>
+ <p>
+ Apache UIMA is an Apache-licensed open source
+ implementation of the UIMA specification (that
+ specification is, in turn, being developed concurrently
+ by a technical committee within
+ <a href="http://www.oasis-open.org">OASIS</a>
+ , a standards organization). We invite and encourage you
+ to participate in both the implementation and
+ specification efforts.
+ </p>
+ <p>
+ UIMA is a component framework for analysing unstructured
+ content such as text, audio and video. It comprises an
+ SDK and tooling for composing and running analytic
+ components written in Java and C++, with some support
+ for Perl, Python and TCL.
+ </p>
+
+<h2><a name="major.changes">Major Changes in this Release</a></h2>
+<p>
+Please see the <a href="README">README</a> for this information.
+</p>
+
+<h2><a name="get.involved">How to Get Involved</a></h2>
+<p>
+The Apache UIMA project really needs and appreciates any contributions,
+including documentation help, source code and feedback. If you are interested
+in contributing, please visit
+<a href="http://uima.apache.org/get-involved.html">
+ http://uima.apache.org/get-involved.html</a>.
+</p>
+
+<h2><a name="report.issues">How to Report Issues</a></h2>
+<p>
+The Apache UIMA project uses JIRA for issue tracking. Please report any
+issues you find at
+<a href="http://issues.apache.org/jira/browse/uima">http://issues.apache.org/jira/browse/uima</a>
+</p>
+
+<h2><a name="list.issues">List of JIRA Issues Fixed in this Release</a></h2>
+Click <a href="issuesFixed/jira-report.html">issuesFixed/jira-report.hmtl</a> for the list of
+issues fixed in this release.
+
+<h2><a name="migrating">Migrating from IBM UIMA to Apache UIMA</a></h2>
+
+<p>
+This section describes how to move from pre-Apache versions of UIMA to the
+Apache version (starting with Apache UIMA 2.1).
+</p>
+
+<p>
+Note: Before running the migration utility, be sure to back up your files, just
+in case you encounter any problems, because the migration tool updates the
+files in place in the directories where it finds them.
+</p>
+<p>
+The migration utility is run by executing the script file
+apache-uima/bin/ibmUimaToApacheUima.bat (Windows) or
+apache-uima/bin/ibmUimaToApacheUima.sh (UNIX). You must pass one argument: the
+directory containing the files that you want to be migrated. Subdirectories
+will be processed recursively.
+</p>
+<p>
+The script scans your files and applies the necessary updates, for example
+replacing the com.ibm package names with the new org.apache package names.
+</p>
+<p>
+The script will only attempt to modify files with the extensions: java, xml,
+xmi, wsdd, properties, launch, bat, cmd, sh, ksh, or csh; and files with no
+extension. Also, files with size greater than 1,000,000 bytes will be skipped.
+(If you want the script to modify files with other extensions, you can edit
+the script file and change the -ext argument appropriately.)
+</p>
+<p>
+If the migration tool reports warnings, there may be a few additional steps to
+take. The following two sections explain some simple manual changes that you
+might need to make to your code.
+</p>
+
+<h3>3.1. JCas Cover Classes for DocumentAnnotation</h3>
+<p>
+If you have run JCasGen it is likely that you have the classes
+com.ibm.uima.jcas.tcas.DocumentAnnotation and
+com.ibm.uima.jcas.tcas.DocumentAnnotation_Type as part of your code. This
+package name is no longer valid, and the migration utility does not move your
+files between directories so it is unable to fix this.
+</p>
+<p>
+If you have not made manual modifications to these classes, the best solution
+is usually to just delete these two classes (and their containing package).
+There is a default version in the uima-document-annotation.jar file that is
+included in Apache UIMA. If you have made custom changes, then you should not
+delete the file but instead move it to the correct package
+org.apache.uima.jcas.tcas. For more information about JCas and
+DocumentAnnotation please see Section 5.5.4,
+"Adding Features to DocumentAnnotation" in the
+ <a href="docs/html/references/references.html">UIMA References</a> manual.
+</p>
+
+<h3>3.2. JCas.getDocumentAnnotation</h3>
+<p>
+The deprecated method JCas.getDocumentAnnotation has been removed. Its use
+must be replaced with JCas.getDocumentAnnotationFs. The method
+JCas.getDocumentAnnotationFs() returns type TOP, so your code must cast this to
+type DocumentAnnotation. The reasons for this are described in Section
+5.5.4, "Adding Features to DocumentAnnotation" in the
+<a href="docs/html/references/references.html">UIMA References</a> manual.
+</p>
+
+<h3>3.3. Rare Cases Where Additional Manual Migration is Necessary</h3>
+<p>
+For most users there should not be any additional migration steps necessary.
+However, if the migration tool reported an additional warning or if you are
+having trouble getting your code to compile or run after running the migration,
+please see Section 1.4.2. "Rare Cases Where Additional Manual Migration is
+Necessary," in the <a href="docs/html/overview_and_setup/overview_and_setup.html">
+Overview and Setup</a> manual.
+</p>
+
+
+</body>
+</html>
\ No newline at end of file
Propchange: uima/site/trunk/uima-website/docs/d/uimaj-2.4.1/RELEASE_NOTES.html
------------------------------------------------------------------------------
svn:eol-style = native