svn commit: r1409318 - /incubator/ctakes/site/trunk/content/ctakes/3.0.0/user-guide-3.0.mdtext

[bl...@apache.org]

Author: bleeker
Date: Wed Nov 14 19:35:05 2012
New Revision: 1409318

URL: http://svn.apache.org/viewvc?rev=1409318&view=rev
Log:
CMS commit to ctakes by bleeker

Modified:
    incubator/ctakes/site/trunk/content/ctakes/3.0.0/user-guide-3.0.mdtext

Modified: incubator/ctakes/site/trunk/content/ctakes/3.0.0/user-guide-3.0.mdtext
URL: http://svn.apache.org/viewvc/incubator/ctakes/site/trunk/content/ctakes/3.0.0/user-guide-3.0.mdtext?rev=1409318&r1=1409317&r2=1409318&view=diff
==============================================================================
--- incubator/ctakes/site/trunk/content/ctakes/3.0.0/user-guide-3.0.mdtext (original)
+++ incubator/ctakes/site/trunk/content/ctakes/3.0.0/user-guide-3.0.mdtext Wed Nov 14 19:35:05 2012
@@ -21,15 +21,18 @@ Notice:    Licensed to the Apache Softwa
 #cTAKES 3.0 User Guide
 
 cTAKES users are those who wish to use cTAKES as it is without code modifications.
-With these instructions you can install
-cTAKES, configure it, and use it to process text (typically text associated
-with a medical record). If you were planning to expand, change, or modify the
-code within cTAKES, refer to the [cTAKES 3.0 Developer Install
-Instructions]().
-
-At present there is no GUI through which you can utilize the results of cTAKES processing.
-The available GUIs are for launching the text or document processing (called a pipeline).
-The results ...
+With these instructions you can install cTAKES, configure it, and use it to process text.
+cTAKES is built around analysis of text associated with a medical record. If you were planning to expand, change, or modify the
+code within cTAKES, refer to the [cTAKES 3.0 Developer Guide](/3.0.0/developer-guide-3.0).
+
+There are GUIs for the configuration and viewing of results, however, there are no summaries, statistics, or pretty graphs.
+The results are lots of annotations recorded in [UIMA XMI files](http://uima.apache.org/downloads/releaseDocs/2.1.0-incubating/docs/html/tutorials_and_users_guides/tutorials_and_users_guides.html#ugr.tug.xmi_emf).
+You can see and sift through the results, but more processing is required to reap the benefits of the processing.
+The process that you set up to do these annotations is called a pipeline.
+
+
+
+
 
 These instructions will cover installation and a test of the main product
 including trained models for sentence detection and tagging parts of speech,
@@ -39,30 +42,28 @@ resource, etc. Optional components will 
 Once you have finished installation of cTAKES, you will be able to see what
 cTAKES is capable of. Further exploitation of the software's ability may
 require following a few additional steps involving what dictionaries are being
-used. These are the last steps in these instructions.
+used.
 
 ## Prerequisites
 
-Make sure you have Java 1.6 or higher. Many systems come with Java already
-installed. Run this command to check your version, for example:
-
     :::text
-    C:\>java -version
-    java version "1.6.0_20"
-    Java(TM) SE Runtime Environment (build 1.6.0_20-b02)
-    Java HotSpot(TM) Client VM (build 16.3-b01, mixed mode, sharing)
 
 If you do not have Java installed or have an older version then you can install Java from [java.com](http://www.java.com/en/download/faq/develop.xml).
 
 ## Install cTAKES
 
-1. Download the [**cTAKES-3.0.zip**]() file.
+1. Make sure you have Java 1.6 or higher. Many systems come with Java already
+installed. Run this command to check your version, for example:
+<pre>
+    C:\>java -version
+</pre>
+2. Download the [**cTAKES-3.0.zip**](NotYetAvailable) file.
 Save the file to a temporary location on your machine.
 
-2. Unzip the ZIP file into a directory that you want to be the cTAKES install location.
+3. Unzip the ZIP file into a directory that you want to be the cTAKES install location.
 This folder we will call **cTAKES_HOME**. You will need to refer to the directory later.
 
-####**Windows**:
+#####**Windows**:
 
     c:\cTAKES-3.0
   
@@ -74,7 +75,7 @@ This folder we will call **cTAKES_HOME**
 
 ## Process documents using cTAKES
 
-This version allows you to test most components bundled in cTAKES in two
+This version allows you to use most components bundled in cTAKES in two
 different ways:
 
   1. Using cTAKES CAS Visual Debugger (CVD) to view the results stored as XCAS files or run the annotators or
@@ -82,9 +83,8 @@ different ways:
 
 ### CAS Visual Debugger (CVD)
 
-Step
+[CAS Visual Debugger (CVD)](http://uima.apache.org/downloads/releaseDocs/2.2.2-incubating/docs/html/tools/tools.html#ugr.tools.cvd)
 
-Example
 
 1. Open a command prompt and change to the cTAKES_HOME directory.
 
@@ -198,6 +198,7 @@ Text frame on the right. You may close C
 
 ### Collection processing engine (CPE)
 
+The [Collection Processing Engine (CPE) Configuration GUI](http://uima.apache.org/downloads/releaseDocs/2.2.2-incubating/docs/html/tools/tools.html#ugr.tools.cpe) is for configuring a pipeline to process documents (called a pipeline).
 Step
 
 Example