You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by tw...@apache.org on 2009/07/30 14:23:18 UTC
svn commit: r799247 - in
/incubator/uima/site/trunk/uima-website/docs/downloads/sandbox/simple-server:
images/simpleServerUserGuide/ simpleServerUserGuide/
Author: twgoetz
Date: Thu Jul 30 12:23:18 2009
New Revision: 799247
URL: http://svn.apache.org/viewvc?rev=799247&view=rev
Log:
UIMA-1457: Update website with latest simple server documentation.
https://issues.apache.org/jira/browse/UIMA-1457
Removed:
incubator/uima/site/trunk/uima-website/docs/downloads/sandbox/simple-server/images/simpleServerUserGuide/new-web-project3.jpg
Modified:
incubator/uima/site/trunk/uima-website/docs/downloads/sandbox/simple-server/images/simpleServerUserGuide/new-web-project1.jpg
incubator/uima/site/trunk/uima-website/docs/downloads/sandbox/simple-server/images/simpleServerUserGuide/new-web-project2.jpg
incubator/uima/site/trunk/uima-website/docs/downloads/sandbox/simple-server/images/simpleServerUserGuide/sample-project-layout.jpg
incubator/uima/site/trunk/uima-website/docs/downloads/sandbox/simple-server/simpleServerUserGuide/simpleServerUserGuide.html
Modified: incubator/uima/site/trunk/uima-website/docs/downloads/sandbox/simple-server/images/simpleServerUserGuide/new-web-project1.jpg
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/docs/downloads/sandbox/simple-server/images/simpleServerUserGuide/new-web-project1.jpg?rev=799247&r1=799246&r2=799247&view=diff
==============================================================================
Binary files - no diff available.
Modified: incubator/uima/site/trunk/uima-website/docs/downloads/sandbox/simple-server/images/simpleServerUserGuide/new-web-project2.jpg
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/docs/downloads/sandbox/simple-server/images/simpleServerUserGuide/new-web-project2.jpg?rev=799247&r1=799246&r2=799247&view=diff
==============================================================================
Binary files - no diff available.
Modified: incubator/uima/site/trunk/uima-website/docs/downloads/sandbox/simple-server/images/simpleServerUserGuide/sample-project-layout.jpg
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/docs/downloads/sandbox/simple-server/images/simpleServerUserGuide/sample-project-layout.jpg?rev=799247&r1=799246&r2=799247&view=diff
==============================================================================
Binary files - no diff available.
Modified: incubator/uima/site/trunk/uima-website/docs/downloads/sandbox/simple-server/simpleServerUserGuide/simpleServerUserGuide.html
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/docs/downloads/sandbox/simple-server/simpleServerUserGuide/simpleServerUserGuide.html?rev=799247&r1=799246&r2=799247&view=diff
==============================================================================
--- incubator/uima/site/trunk/uima-website/docs/downloads/sandbox/simple-server/simpleServerUserGuide/simpleServerUserGuide.html (original)
+++ incubator/uima/site/trunk/uima-website/docs/downloads/sandbox/simple-server/simpleServerUserGuide/simpleServerUserGuide.html Thu Jul 30 12:23:18 2009
@@ -27,7 +27,7 @@
service marks have been appropriately capitalized. Use of such terms
in this book should not be regarded as affecting the validity of the
the trademark or service mark.
- </p></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#sandbox.simpleServer">1. Introduction</a></span></dt><dd><dl><dt><span class="section"><a href="#d0e76">1.1. Quick start for the impatient</a></span></dt><dd><dl><dt><span class="section"><a href="#d0e96">1.1.1. Build a sample WAR file</a></span></dt><dt><span class="section"><a href="#d0e200">1.1.2. Trying it out</a></span></dt></dl></dd></dl></dd></dl></div><div class="chapter" lang="en" id="sandbox.simpleServer"><div class="titlepage"><div><div><h2 class="title"><a name="sandbox.simpleServer"></a>Chapter 1. Introduction</h2></div></div></div><p>The UIMA Simple Server makes results of UIMA processing available in a simple, XML-based
+ </p></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#sandbox.simpleServer">1. Introduction</a></span></dt><dd><dl><dt><span class="section"><a href="#d0e76">1.1. Quick start for the impatient</a></span></dt><dd><dl><dt><span class="section"><a href="#d0e96">1.1.1. Build a sample WAR file</a></span></dt><dt><span class="section"><a href="#d0e193">1.1.2. Trying it out</a></span></dt></dl></dd></dl></dd></dl></div><div class="chapter" lang="en" id="sandbox.simpleServer"><div class="titlepage"><div><div><h2 class="title"><a name="sandbox.simpleServer"></a>Chapter 1. Introduction</h2></div></div></div><p>The UIMA Simple Server makes results of UIMA processing available in a simple, XML-based
format. The intended use of the the Simple Server is to provide UIMA analysis as a REST service.
The Simple Server is implemented as a Java Servlet, and can be deployed into any Servlet container
(such as Apache Tomcat or Jetty).</p><p>You can
@@ -36,12 +36,12 @@
simple service running in a few minutes. If not, not to worry. We'll go over this in much more
detail later on. To follow the quick start guide, you will need to have:</p><div class="itemizedlist"><ul type="disc"><li><p>Tomcat or some other servlet container installed. Installing Tomcat is a breeze, see
<a xmlns:xlink="http://www.w3.org/1999/xlink" href="http://tomcat.apache.org/" target="_top">http://tomcat.apache.org/</a>. For the purposes of this documentation, we have
- used Apache Tomcat 6.0.16, but other versions should work just as well if they're not too old.</p></li><li><p>The latest Apache UIMA release, plus the Apache UIMA sandbox add-ons. See
+ used Apache Tomcat 6.0.20, but other versions should work just as well if they're not too old.</p></li><li><p>The latest Apache UIMA release, plus the Apache UIMA sandbox add-ons. See
<a xmlns:xlink="http://www.w3.org/1999/xlink" href="http://incubator.apache.org/uima/downloads.cgi" target="_top">the Apache UIMA download site</a>.
</p></li><li><p>Doing all this from Eclipse is convenient, but not required. If you work with Eclipse, it is
useful to use the Web Tools Platform. Alternatively, just install the J2EE development
version of Eclipse. The screenshots for this documentation were done with the J2EE development
- version of Eclipse 3.3.1.1.</p></li></ul></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e96"></a>1.1.1. Build a sample WAR file</h3></div></div></div><p>
+ version of Eclipse 3.5.0 (Galileo).</p></li></ul></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e96"></a>1.1.1. Build a sample WAR file</h3></div></div></div><p>
Create a Web ARchive project in your favorite development
environment. We'll show you how to do this in Eclipse, but if you
don't use Eclipse, you'll figure out how to do this without.
@@ -53,12 +53,11 @@
Below is the next step in the dialog, where you can set the project name and the intended
runtime. If you haven't done so yet, point Eclipse to your Tomcat installation.
</p><div class="screenshot"><div class="mediaobject"><img src="../images/simpleServerUserGuide/new-web-project2.jpg" alt="New project dialog: note server runtime"></div></div><p>
- Finally, you can select other project facets for your project. The
- default should be fine.
- </p><div class="screenshot"><div class="mediaobject"><img src="../images/simpleServerUserGuide/new-web-project3.jpg" alt="New project dialog: no other facets are necessary"></div></div><p>
+ Hit finish next, accepting default settings for the rest of the project setup.
+ </p><p>
We'll now describe what jar files you need to package in your WAR file for the application
to run. Note that these are jars that you will need for each and every UIMA service you
- deploy. So if deploy several different services into the same servlet container, you can
+ deploy. So if you deploy several different services into the same servlet container, you can
also copy those jars to the shared lib directory of your servlet container: you then don't
have to deploy them with each UIMA service. However, for the purposes of this example, we
<span class="emphasis"><em>will</em></span> deploy the common jars with the WAR file.
@@ -124,7 +123,7 @@
Alternatively, you can build a WAR file out of your project. In Eclipse, right-click
your project, and select "Export/Web/WAR file". Save the WAR file to some location
and deploy it in Tomcat (for example, using the admin web app that comes with Tomcat).
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e200"></a>1.1.2. Trying it out</h3></div></div></div><p>This is it, your first simple service should be ready to run. Make sure
+ </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e193"></a>1.1.2. Trying it out</h3></div></div></div><p>This is it, your first simple service should be ready to run. Make sure
Tomcat is running and direct your browser to the following URL:
<a xmlns:xlink="http://www.w3.org/1999/xlink" href="http://localhost:8080/simple-server-test" target="_top">http://localhost:8080/simple-server-test</a>.
You should see something like this:
@@ -147,6 +146,4 @@
Programmatic access to the service is described on the info page. You can also
look at the unit tests in the source code for how to use Apache's HttpClient
to call UIMA simple services.
- </p><p>
- TODO: describe service spec (output filtering and mapping), detailed reference...
</p></div></div></div></div></body></html>
\ No newline at end of file