You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ctakes.apache.org by se...@apache.org on 2024/06/03 15:48:14 UTC

(ctakes) branch main updated: Simple readme and piper doc changes

This is an automated email from the ASF dual-hosted git repository.

seanfinan pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/ctakes.git


The following commit(s) were added to refs/heads/main by this push:
     new 3a62ac5  Simple readme and piper doc changes
3a62ac5 is described below

commit 3a62ac5d59af045b303583ac40a8987f3bf681e5
Author: Sean Finan <se...@childrens.harvard.edu>
AuthorDate: Mon Jun 3 11:47:57 2024 -0400

    Simple readme and piper doc changes
---
 .asf.yaml                                          |  11 +-
 ctakes-assertion/README.md                         |   9 +
 .../assertion/pipeline/AssertionSubPipe.piper      |   3 +-
 .../pipeline/AttributeCleartkSubPipe.piper         |   3 +-
 .../pipeline/TsAttributeCleartkSubPipe.piper       |   3 +-
 .../pipeline/WindowedAttributeCleartkSubPipe.piper |   2 +-
 ctakes-chunker/README                              | 138 ----------
 ctakes-chunker/README.md                           |   2 +
 .../ctakes/chunker/pipeline/ChunkerSubPipe.piper   |   3 +-
 .../ctakes/chunker/pipeline/TsChunkerSubPipe.piper |   3 +-
 ctakes-clinical-pipeline/README.md                 |   6 +
 .../clinical/pipeline/DefaultFastPipeline.piper    |   2 +-
 .../clinical/pipeline/SectionedFastPipeline.piper  |   2 +-
 .../clinical/pipeline/TsDefaultFastPipeline.piper  |   2 +-
 .../pipeline/TsSectionedFastPipeline.piper         |   2 +-
 ctakes-constituency-parser/README                  |   5 -
 ctakes-constituency-parser/READMEmd                |   5 +
 ctakes-context-tokenizer/README                    |  52 ----
 ctakes-context-tokenizer/README.md                 |   9 +
 ctakes-core/README                                 |  99 -------
 ctakes-core/README.md                              |   1 +
 .../core/pipeline/DefaultTokenizerPipeline.piper   |   2 +-
 .../core/pipeline/FullTokenizerPipeline.piper      |   2 +-
 .../core/pipeline/TsDefaultTokenizerPipeline.piper |   2 +-
 .../core/pipeline/TsFullTokenizerPipeline.piper    |   2 +-
 ctakes-coreference/README                          |  76 ------
 ctakes-coreference/README.md                       |  29 +++
 .../ctakes/coreference/pipeline/CorefSubPipe.piper |   3 +-
 .../pipeline/DefaultAdvancedPipeline.piper         |   4 +-
 .../pipeline/DefaultCorefPipeline.piper            |   4 +-
 .../pipeline/DefaultRelationCorefPipeline.piper    |   5 +-
 .../pipeline/DefaultTemporalCorefPipeline.piper    |   3 +-
 .../pipeline/SectionedAdvancedPipeline.piper       |   5 +-
 .../pipeline/SectionedCorefPipeline.piper          |   4 +-
 .../pipeline/SectionedRelationCorefPipeline.piper  |   5 +-
 .../pipeline/SectionedTemporalCorefPipeline.piper  |   5 +-
 .../coreference/pipeline/TsCorefSubPipe.piper      |   3 +-
 .../pipeline/TsDefaultAdvancedPipeline.piper       |   5 +-
 .../pipeline/TsDefaultCorefPipeline.piper          |   4 +-
 .../pipeline/TsDefaultRelationCorefPipeline.piper  |   6 +-
 .../pipeline/TsDefaultTemporalCorefPipeline.piper  |   4 +-
 .../pipeline/TsSectionedAdvancedPipeline.piper     |   5 +-
 .../pipeline/TsSectionedCorefPipeline.piper        |   4 +-
 .../TsSectionedRelationCorefPipeline.piper         |   6 +-
 .../TsSectionedTemporalCorefPipeline.piper         |   6 +-
 ctakes-dependency-parser/README.md                 |  17 ++
 ctakes-dictionary-lookup-fast/README               |   2 -
 ctakes-dictionary-lookup-fast/README.md            |  94 +++++++
 .../lookup/fast/pipeline/DictionarySubPipe.piper   |   3 +-
 .../lookup/fast/pipeline/TsDictionarySubPipe.piper |   3 +-
 ctakes-dictionary-lookup/{README => README.md}     | 206 ++++-----------
 ctakes-distribution/README.md                      |   9 +
 ctakes-drug-ner/README                             | 105 --------
 ctakes-drug-ner/README.md                          |   5 +
 .../pipeline/HelloWorldAggregatePipeline.java      |  58 -----
 .../examples/pipeline/HelloWorldBuilderRunner.java |   1 -
 .../examples/pipeline/AdvancedClinicalToFhir.piper |   1 +
 .../ctakes/examples/pipeline/ApacheConDemo.piper   |   4 +-
 .../examples/pipeline/ApacheConDemoBasic.piper     |   3 +-
 .../examples/pipeline/ApacheConDemoRelation.piper  |   2 +
 .../examples/pipeline/ApacheConDemoSection.piper   |   2 +
 .../examples/pipeline/AssertionDefaults.piper      |   4 +-
 .../ctakes/examples/pipeline/BigPipeline.piper     |   5 -
 .../ctakes/examples/pipeline/Cased2020aa.piper     |   2 +
 .../ctakes/examples/pipeline/FhirToOutput.piper    |   1 +
 .../ctakes/examples/pipeline/HelloWorld.piper      |   2 +-
 .../examples/pipeline/HelloWorldAssertProps.piper  |   3 +-
 .../ctakes/examples/pipeline/HelloWorldCui.piper   |   3 +-
 .../ctakes/examples/pipeline/HelloWorldProps.piper |   3 +-
 .../examples/pipeline/HelloWorldTkProps.piper      |   3 +-
 .../examples/pipeline/PbjSentencePrinter.piper     |  45 ++--
 .../ctakes/examples/pipeline/PbjThirdStep.piper    |   5 +-
 .../ctakes/examples/pipeline/PbjWordFinder.piper   |  45 ++--
 .../examples/pipeline/PbjWordFinderInOne.piper     |  39 ++-
 .../ctakes/examples/pipeline/ProcessDir.piper      |   3 +-
 .../examples/pipeline/ThreadSafeFullPipeline.piper |   2 +-
 .../ctakes/examples/pipeline/XmiToPretty.piper     |   2 +
 .../bit/parameter/DefaultParameterHolder.java      |  14 +-
 ctakes-lvg/README                                  |   3 +
 ctakes-ne-contexts/README                          |  95 -------
 ctakes-ne-contexts/README.md                       |   9 +
 .../ne/contexts/pipeline/NeContextsSubPipe.piper   |   3 +-
 ctakes-pbj/README.md                               | 158 +++---------
 .../apache/ctakes/pbj/pipeline/PbjStarter.piper    |  25 +-
 .../apache/ctakes/pbj/pipeline/PbjStopper.piper    |  13 +-
 ctakes-pos-tagger/README                           | 203 ---------------
 ctakes-pos-tagger/README.md                        |   4 +
 ctakes-preprocessor/README                         |  51 ----
 ctakes-relation-extractor/README.md                |   2 +
 .../pipeline/DefaultRelationPipeline.piper         |   2 +-
 .../extractor/pipeline/RelationSubPipe.piper       |   3 +-
 .../pipeline/SectionedRelationPipeline.piper       |   4 +-
 .../extractor/pipeline/TsRelationSubPipe.piper     |   3 +-
 .../pipeline/TsSectionedRelationPipeline.piper     |   4 +-
 ctakes-side-effect/README                          |  19 --
 ctakes-side-effect/README.md                       |  13 +
 ctakes-smoking-status/README                       | 286 ---------------------
 ctakes-smoking-status/README.md                    |  15 ++
 ctakes-temporal/README.md                          |  65 +++++
 .../pipeline/DefaultRelationTemporalPipeline.piper |   7 +-
 .../pipeline/DefaultTemporalPipeline.piper         |   6 +-
 .../SectionedRelationTemporalPipeline.piper        |   7 +-
 .../pipeline/SectionedTemporalPipeline.piper       |   7 +-
 .../ctakes/temporal/pipeline/TemporalSubPipe.piper |   3 +-
 .../TsDefaultRelationTemporalPipeline.piper        |   7 +-
 .../pipeline/TsDefaultTemporalPipeline.piper       |   4 +-
 .../TsSectionedRelationTemporalPipeline.piper      |   8 +-
 .../pipeline/TsSectionedTemporalPipeline.piper     |   8 +-
 .../temporal/pipeline/TsTemporalSubPipe.piper      |   3 +-
 ctakes-user-resources/README.md                    |  10 +
 ctakes-web-rest/{README => README.md}              |  40 +--
 ctakes-ytex-uima/{README => README.md}             |   5 +-
 ctakes-ytex-web/README.md                          |  15 ++
 ctakes-ytex-web/README.txt                         |  17 --
 ctakes-ytex/{README => README.md}                  |  45 ++--
 115 files changed, 654 insertions(+), 1770 deletions(-)

diff --git a/.asf.yaml b/.asf.yaml
index 9e9396a..d83c022 100644
--- a/.asf.yaml
+++ b/.asf.yaml
@@ -17,17 +17,10 @@
 
 github:
   description: "Apache cTAKES is a Natural Language Processing (NLP) platform for clinical text."
-  homepage: https://ctakes.apache.org
   labels:
-    - ctakes
-    - nlp
-    - cnlp
     - clinical
-    - text
-    - natural
-    - language
-    - processing
-    - apache
+    - nlp
+    - bioinformatics
   features:
     wiki: true
     issues: true
diff --git a/ctakes-assertion/README.md b/ctakes-assertion/README.md
new file mode 100644
index 0000000..e216777
--- /dev/null
+++ b/ctakes-assertion/README.md
@@ -0,0 +1,9 @@
+The assertion annotators provide a mechanism for examining and documenting the real-world implications for annotations in text.  
+For example, one might assume that a mention of "diabetes" in text implies that patient has diabetes.
+However, the assertion module will consider whether a named entity or event is negated, uncertain,
+used in a generic way, or in the context of a person's history.
+Additionally, the subject of the statement may be someone other than the patient
+(e.g., the patient's father, for "father has hx of diabetes").
+Each of these attributes illustrate how the "assertion" value of a named entity might be marked.  
+The annotators set the value of their attribute using constants in
+```org.apache.ctakes.typesystem.type.constants.CONST```
diff --git a/ctakes-assertion/src/user/resources/org/apache/ctakes/assertion/pipeline/AssertionSubPipe.piper b/ctakes-assertion/src/user/resources/org/apache/ctakes/assertion/pipeline/AssertionSubPipe.piper
index 8b7f889..07816e0 100644
--- a/ctakes-assertion/src/user/resources/org/apache/ctakes/assertion/pipeline/AssertionSubPipe.piper
+++ b/ctakes-assertion/src/user/resources/org/apache/ctakes/assertion/pipeline/AssertionSubPipe.piper
@@ -1,4 +1,5 @@
-// Commands and parameters to create a default entity attributes processing sub-pipeline.  This is not a full pipeline.
+// Commands and parameters to create a default entity attributes processing sub-pipeline.
+// This is not a full pipeline.
 
 // Add the Dependency parser for use by assertion
 addDescription ClearNLPDependencyParserAE
diff --git a/ctakes-assertion/src/user/resources/org/apache/ctakes/assertion/pipeline/AttributeCleartkSubPipe.piper b/ctakes-assertion/src/user/resources/org/apache/ctakes/assertion/pipeline/AttributeCleartkSubPipe.piper
index 64d4ad0..f5e8e1f 100644
--- a/ctakes-assertion/src/user/resources/org/apache/ctakes/assertion/pipeline/AttributeCleartkSubPipe.piper
+++ b/ctakes-assertion/src/user/resources/org/apache/ctakes/assertion/pipeline/AttributeCleartkSubPipe.piper
@@ -1,4 +1,5 @@
-// Commands and parameters to create a default entity attributes processing sub-pipeline.  This is not a full pipeline.
+// Commands and parameters to create a default entity attributes processing sub-pipeline.
+// This is not a full pipeline.
 
 // Add the Dependency parser for use by SubjectCleartkAnalysisEngine.
 //   If you remove the Subject annotator you might be able to remove the dependency parser.
diff --git a/ctakes-assertion/src/user/resources/org/apache/ctakes/assertion/pipeline/TsAttributeCleartkSubPipe.piper b/ctakes-assertion/src/user/resources/org/apache/ctakes/assertion/pipeline/TsAttributeCleartkSubPipe.piper
index a1f4c80..50dc342 100644
--- a/ctakes-assertion/src/user/resources/org/apache/ctakes/assertion/pipeline/TsAttributeCleartkSubPipe.piper
+++ b/ctakes-assertion/src/user/resources/org/apache/ctakes/assertion/pipeline/TsAttributeCleartkSubPipe.piper
@@ -1,4 +1,5 @@
-// Commands and parameters to create a default entity attributes processing sub-pipeline.  This is not a full pipeline.
+// Commands and parameters to create a thread-safe default entity attributes processing sub-pipeline.
+// This is not a full pipeline.
 
 // Add the Dependency parser for use by cleartk
 addDescription concurrent.ThreadSafeClearNlpDepParser
diff --git a/ctakes-assertion/src/user/resources/org/apache/ctakes/assertion/pipeline/WindowedAttributeCleartkSubPipe.piper b/ctakes-assertion/src/user/resources/org/apache/ctakes/assertion/pipeline/WindowedAttributeCleartkSubPipe.piper
index e33a6e2..62623bf 100644
--- a/ctakes-assertion/src/user/resources/org/apache/ctakes/assertion/pipeline/WindowedAttributeCleartkSubPipe.piper
+++ b/ctakes-assertion/src/user/resources/org/apache/ctakes/assertion/pipeline/WindowedAttributeCleartkSubPipe.piper
@@ -1,4 +1,4 @@
-// Commands and parameters to create a default entity attributes processing sub-pipeline.  This is not a full pipeline.
+// Commands and parameters to create a default entity attributes processing sub-pipeline for large files.  This is not a full pipeline.
 
 // Add the Dependency parser for use by cleartk
 addDescription ClearNLPDependencyParserAE
diff --git a/ctakes-chunker/README b/ctakes-chunker/README
deleted file mode 100644
index c61aa61..0000000
--- a/ctakes-chunker/README
+++ /dev/null
@@ -1,138 +0,0 @@
-Contents
-- Listing of README's in this project
-- Introduction
-- Building a model
-- Tagging text - Running the Chunker analysis engine
-	- Chunker.xml
-	- ChunkerAggregate.xml
-	- ChunkerCPE.xml
-- Running the Chunk Adjuster analysis engine
-	- ChunkAdjuster.xml
-	- AdjustNounPhraseToIncludeFollowingNP.xml
-	- AdjustNounPhraseToIncludeFollowingPPNP.xml
-
-###################################
-Listing of README's in this project
-###################################
-
- - data/chunk/genia/README - how to prepare Genia chunk training data
- - data/chunk/ptb/README - how to prepare PTB chunk training data
- - data/treebank/genia/README - how to prepare Genia Treebank data for ChunkLink
- - resources/models/README - how to build a chunker model
- - scripts/perl/README - information on obtaining the chunklink script
- - target/test-classes/data/README - a description of the files used to unit test the Chunker annotator
- 
-############
-Introduction
-############
-
-Throughout this document when we refer to a "chunker" we often mean a shallow 
-parser - i.e. a component that tags noun phrases, verb phrases, etc.  
-
-This project supports three tasks:
-1) Building a model from training data
-2) Tagging text, using a trained model
-3) Adjusting the end offset of certain chunks so they envelop other chunks,
-   for certain patterns of chunks.
-  
-This project provides a UIMA wrapper around the popular OpenNLP chunker. 
-The UIMA examples project provides default wrappers for several of the 
-components in OpenNLP, but not for the chunker.  We have borrowed from 
-the UIMA examples project liberally.  Our wrapper works with our 
-type system.  Additionally, we added features and supporting components.
-We also documented how to generate training data and how to build a chunker model. 
-
-A chunker model is included with this project.
-
-The model derives from a combination of GENIA, Penn Treebank (Wall Street Journal) and anonymized
-clinical data per Safe Harbor HIPAA guidelines. Prior to model building, the clinical data was 
-deidentified for patient names to preserve patient confidentiality. Any person name in the model 
-will originate from non-patient data sources.
-
-################
-Building a model 
-################
-
-If you wish to build your own mode you will need to follow these steps:
-1) obtain training data - see data/chunk/genia/README and data/chunk/ptb/README
-2) build a model from your training data - see resources/models/README
-
-##################################################
-Tagging text - Running the Chunker analysis engine
-##################################################
-
-%%%%%%%%%%%%%
-Chunker.xml
-
-The file desc/Chunker.xml provides a descriptor for the Chunker analysis 
-engine which is the UIMA component we have written that wraps the OpenNLP 
-chunker / shallow parser.  Open this file using the Component Descriptor 
-Editor as described in the tutorial.  Click on the tab labeled "Overview" 
-to observe that the class called by this descriptor is 
-"org.apache.ctakes.chunker.ae.Chunker".  Click on the tab labeled 
-"Parameter Settings" to view the parameters required by the POSTagger 
-component.  The descriptor file does not document the parameters because 
-they are documented in the api javadocs for the class 
-org.apache.ctakes.chunker.ae.Chunker.  Please consult that documentation for 
-additional details.  The parameters are:
-- ModelFile - the file that contains the chunker tagging model
-- ChunkerCreatorClass - the full class name of an implementation of the 
-                        interface org.apache.ctakes.chunker.ae.ChunkerCreator
-
-%%%%%%%%%%%%%%%%%%%%%%
-ChunkerAggregate.xml
-
-The file desc/ChunkerAggregate.xml provides a descriptor that defines a 
-pipeline for shallow parsing so that all the necessary inputs (e.g. tokens, 
-sentences, and pos tags) have been added to the CAS.  Open this file using 
-the Component Descriptor Editor as described in the tutorial.  Click on 
-the tab labeled "Overview" to observe that the engine type is "Aggregate".  
-Click on the tab labeled "Aggregate" to see the components that need to be 
-run before the Chunker can run.  Click on the tab labeled "Parameter Settings"
-to see that the same two parameters need to be set from the Chunker.xml file
-in addition to the three parameters required by the POSTagger (see 
-"POS tagger/README").  If you assign these parameters acceptable values, 
-you can run open and run desc/ChunkerAggregate.xml using the CAS Visual
-Debugger as described in the tutorial.  
-
-%%%%%%%%%%%%%%%%
-ChunkerCPE.xml
-
-The file desc/ChunkerCPE.xml provides an xml-specification of a component 
-processing engine (CPE) which can be opened, edited, and run using the 
-UIMA CPE GUI as described in the tutorial.  Open this file using the UIMA 
-CPE GUI and set the parameters for the collection reader to point to a local
-collection of files that you want shallow parsed.  Set the parameters for 
-the Chunker as appropriate for your environment and, finally, set the output
-directory of the XCAS Writer CAS Consumer.  The results of running the 
-pipeline are written to the output directory as XCAS files.  These files 
-can be viewed in the CAS Visual Debugger as described in the tutorial.  
-
-	     
-##################################################
-Running the Chunk Adjuster analysis engine
-##################################################
-
-%%%%%%%%%%%%%%%%%
-ChunkAdjuster.xml
-
-Example of descriptor for the ChunkAdjuster.
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-AdjustNounPhraseToIncludeFollowingNP.xml
-
-Descriptor for the ChunkAdjuster, with parameters set so that consecutive
-noun phrase (NP) chunks are pseudo-merged -- the end-offset of the first NP 
-is changed to match the end-offset of the last NP in a consecutive list of NPs.
- 
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-AdjustNounPhraseToIncludeFollowingPPNP.xml
-
-Descriptor for the ChunkAdjuster, with parameters set so that a sequence of NP PP NP chunks   
-are pseudo-merged -- the end-offset of the first NP is changed to match the end-offset
-of the last NP in NP PP NP.  This adjustment is applied repeatedly, so for a pattern
-of NP PP NP PP NP, the end offset for the first NP is set to match the end offset
-of the last NP. 
- 
-  
\ No newline at end of file
diff --git a/ctakes-chunker/README.md b/ctakes-chunker/README.md
new file mode 100644
index 0000000..c6dcf4c
--- /dev/null
+++ b/ctakes-chunker/README.md
@@ -0,0 +1,2 @@
+In cTAKES when we refer to a "chunker" we often mean a shallow parser, i.e. a component that tags noun phrases, verb phrases, etc.  
+This project provides a [Apache UIMA](https://uima.apache.org/) wrapper around the popular [Apache OpenNLP](https://opennlp.apache.org/) chunker. 
\ No newline at end of file
diff --git a/ctakes-chunker/src/user/resources/org/apache/ctakes/chunker/pipeline/ChunkerSubPipe.piper b/ctakes-chunker/src/user/resources/org/apache/ctakes/chunker/pipeline/ChunkerSubPipe.piper
index 523bd4d..8da91b2 100644
--- a/ctakes-chunker/src/user/resources/org/apache/ctakes/chunker/pipeline/ChunkerSubPipe.piper
+++ b/ctakes-chunker/src/user/resources/org/apache/ctakes/chunker/pipeline/ChunkerSubPipe.piper
@@ -1,4 +1,5 @@
-// Commands and parameters to create a default chunker processing sub-pipeline.  This is not a full pipeline.
+// Commands and parameters to create a default chunker processing sub-pipeline.
+//  This is not a full pipeline.
 
 add Chunker
 addDescription adjuster.ChunkAdjuster NP,NP 1
diff --git a/ctakes-chunker/src/user/resources/org/apache/ctakes/chunker/pipeline/TsChunkerSubPipe.piper b/ctakes-chunker/src/user/resources/org/apache/ctakes/chunker/pipeline/TsChunkerSubPipe.piper
index 9f81bdc..7283bda 100644
--- a/ctakes-chunker/src/user/resources/org/apache/ctakes/chunker/pipeline/TsChunkerSubPipe.piper
+++ b/ctakes-chunker/src/user/resources/org/apache/ctakes/chunker/pipeline/TsChunkerSubPipe.piper
@@ -1,4 +1,5 @@
-// Commands and parameters to create a default chunker processing sub-pipeline.  This is not a full pipeline.
+// Commands and parameters to create a thread-safe default chunker processing sub-pipeline.
+// This is not a full pipeline.
 
 add concurrent.ThreadSafeChunker
 addDescription adjuster.ChunkAdjuster NP,NP 1
diff --git a/ctakes-clinical-pipeline/README.md b/ctakes-clinical-pipeline/README.md
new file mode 100644
index 0000000..b819cbb
--- /dev/null
+++ b/ctakes-clinical-pipeline/README.md
@@ -0,0 +1,6 @@
+The Default Clinical Pipeline produces the most commonly desired output from cTAKES.  
+This includes annotations for Anatomical sites, Signs/Symptoms,
+Procedures, Diseases/Disorders and Medications.
+For each annotation there are normalized UMLS CUIs, plus values for negation, uncertainty and subject.  
+The Default ClinicalPipeline is a great place for the new user of a binary installation to start.
+New developers should look at the ctakes-examples project to start.
\ No newline at end of file
diff --git a/ctakes-clinical-pipeline/src/user/resources/org/apache/ctakes/clinical/pipeline/DefaultFastPipeline.piper b/ctakes-clinical-pipeline/src/user/resources/org/apache/ctakes/clinical/pipeline/DefaultFastPipeline.piper
index 874effb..08612f8 100644
--- a/ctakes-clinical-pipeline/src/user/resources/org/apache/ctakes/clinical/pipeline/DefaultFastPipeline.piper
+++ b/ctakes-clinical-pipeline/src/user/resources/org/apache/ctakes/clinical/pipeline/DefaultFastPipeline.piper
@@ -1,4 +1,4 @@
-// Commands and parameters to create a default plaintext document processing pipeline with UMLS lookup
+// Commands and parameters to create a plaintext document processing pipeline with UMLS entity lookup.
 
 // Write nice big banners when ctakes starts and finishes.
 set WriteBanner=yes
diff --git a/ctakes-clinical-pipeline/src/user/resources/org/apache/ctakes/clinical/pipeline/SectionedFastPipeline.piper b/ctakes-clinical-pipeline/src/user/resources/org/apache/ctakes/clinical/pipeline/SectionedFastPipeline.piper
index 68952e3..0d78b4a 100644
--- a/ctakes-clinical-pipeline/src/user/resources/org/apache/ctakes/clinical/pipeline/SectionedFastPipeline.piper
+++ b/ctakes-clinical-pipeline/src/user/resources/org/apache/ctakes/clinical/pipeline/SectionedFastPipeline.piper
@@ -1,4 +1,4 @@
-// Clinical Pipeline with sectionization, paragraph and list detection
+// Commands and parameters to create a plaintext document processing pipeline with Sections, paragraphs and lists.
 
 // Advanced Tokenization: Regex sectionization, Paragraphs, Lists
 load FullTokenizerPipeline
diff --git a/ctakes-clinical-pipeline/src/user/resources/org/apache/ctakes/clinical/pipeline/TsDefaultFastPipeline.piper b/ctakes-clinical-pipeline/src/user/resources/org/apache/ctakes/clinical/pipeline/TsDefaultFastPipeline.piper
index a18153d..098f6b8 100644
--- a/ctakes-clinical-pipeline/src/user/resources/org/apache/ctakes/clinical/pipeline/TsDefaultFastPipeline.piper
+++ b/ctakes-clinical-pipeline/src/user/resources/org/apache/ctakes/clinical/pipeline/TsDefaultFastPipeline.piper
@@ -1,4 +1,4 @@
-// Commands and parameters to create a default plaintext document processing pipeline with UMLS lookup
+// Commands and parameters to create a thread-safe plaintext document processing pipeline with UMLS lookup.
 
 // set the thread count
 threads 3
diff --git a/ctakes-clinical-pipeline/src/user/resources/org/apache/ctakes/clinical/pipeline/TsSectionedFastPipeline.piper b/ctakes-clinical-pipeline/src/user/resources/org/apache/ctakes/clinical/pipeline/TsSectionedFastPipeline.piper
index 2e47066..5fe1106 100644
--- a/ctakes-clinical-pipeline/src/user/resources/org/apache/ctakes/clinical/pipeline/TsSectionedFastPipeline.piper
+++ b/ctakes-clinical-pipeline/src/user/resources/org/apache/ctakes/clinical/pipeline/TsSectionedFastPipeline.piper
@@ -1,4 +1,4 @@
-// Thread Safe Clinical Pipeline with sectionization, paragraph and list detection
+// Commands and parameters to create a thread-safe plaintext document processing pipeline with Sections, paragraphs and lists.
 
 // set the thread count
 threads 3
diff --git a/ctakes-constituency-parser/README b/ctakes-constituency-parser/README
deleted file mode 100644
index 9a99530..0000000
--- a/ctakes-constituency-parser/README
+++ /dev/null
@@ -1,5 +0,0 @@
-
-The model in parsermodel is trained on Mipacq data (clinical notes, clinical questions, medpedia, etc.)
-as well as the Penn Treebank (Wall Street Journal).  This model performs about 1.5 better labeled F-score
-on some preliminary runs.  fastModel is trained only on clinical data but is a much smaller model and
-runs a lot faster.
diff --git a/ctakes-constituency-parser/READMEmd b/ctakes-constituency-parser/READMEmd
new file mode 100644
index 0000000..6a337bf
--- /dev/null
+++ b/ctakes-constituency-parser/READMEmd
@@ -0,0 +1,5 @@
+This parser is a wrapper around the [Apache OpenNLP](https://opennlp.apache.org/) parser.  
+The model in parsermodel is trained on Mipacq data (clinical notes, clinical questions, medpedia, etc.) 
+as well as the Penn Treebank (Wall Street Journal).
+This model performs about 1.5 better labeled F-score on some preliminary runs.
+fastModel is trained only on clinical data but is a much smaller model and runs a lot faster.
diff --git a/ctakes-context-tokenizer/README b/ctakes-context-tokenizer/README
deleted file mode 100644
index 133cd6f..0000000
--- a/ctakes-context-tokenizer/README
+++ /dev/null
@@ -1,52 +0,0 @@
-Contents
-- Introduction
-- Running the context dependent tokenizer
-	- ContextDependentTokenizerAnnotator.xml
-	- TestTAE.xml
- 
-############
-Introduction
-############
-
-This annotator creates annotations from one or more tokens, using surrounding tokens as clues. 
-An example of an annotation created from multiple tokens is a range that includes 2 numbers 
-and a dash (e.g. 2-3).
-
-See the CdtTypeSystem.xml descriptor for the list of annotation types this annotator might create.  
-
-This annotator depends on finite state machine (FSM) code in the project named core. 
-
-############################################################################
-Running the context dependent tokenizer
-############################################################################
-   
-
-%%%%%%%%%%%%%%%%%%%%%%%%%
-ContextDependentTokenizerAnnotator.xml
-
-The analysis engine descriptor has no parameters.
-Include this analysis engine in your pipeline if you wish to have the following annotations created
-  DateAanotation
-  FractionAnnotation
-  MeasurementAnnotation
-  PersonTitleAnnotation
-  RangeAnnotation
-  RomanNumeralAnnotation
-  TimeAnnotation
-
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-TestTAE.xml  
-
-The TestTAE descriptor is an aggregate analysis engine that can be used to run a short pipeline
-that takes plaintext as input and annotates for tokens, sentences, and for the annotations created
-by this context dependent tokenizer annotator:
-  DateAanotation
-  FractionAnnotation
-  MeasurementAnnotation
-  PersonTitleAnnotation
-  RangeAnnotation
-  RomanNumeralAnnotation
-  TimeAnnotation
- 
-This aggregate does not override any parameters or resource bindings.
diff --git a/ctakes-context-tokenizer/README.md b/ctakes-context-tokenizer/README.md
new file mode 100644
index 0000000..a561b32
--- /dev/null
+++ b/ctakes-context-tokenizer/README.md
@@ -0,0 +1,9 @@
+This annotator creates annotations from one or more tokens, using surrounding tokens as clues.
+- DateAnnotation
+- FractionAnnotation
+- MeasurementAnnotation
+- PersonTitleAnnotation
+- RangeAnnotation
+- RomanNumeralAnnotation
+- TimeAnnotation
+An example of an annotation created from multiple tokens is a range that includes 2 numbers and a dash (e.g. 2-3).
diff --git a/ctakes-core/README b/ctakes-core/README
deleted file mode 100644
index ef740bb..0000000
--- a/ctakes-core/README
+++ /dev/null
@@ -1,99 +0,0 @@
-
-Contents
-- Introduction
-- Analysis engines (annotators)
-	- CopyAnnotator.xml
-	- NullAnnotator.xml
-	- OverlapAnnotator.xml
-	- SentenceDetectorAnnotator.xml
-	- SimpleSegmentAnnotator.xml
-	- TokenizerAnnotator.xml
-	  
-
-############
-Introduction
-############
-
-This project contains several annotators, including:
-	- a sentence detector annotator (a wrapper around the OpenNLP sentence detector)
-	- a tokenizer
-	- an annotator that does not update the CAS in any way, which can be useful if you are using the UIMA
-	  CPE GUI and you are required to specify an analysis engine but you don't actually want to specify one.
-	- an annotator that creates a single Segment annotation encompassing the entire document text, which can
-	  be used when processing a plaintext document which therefore doesn't have section (aka segment) tags. 
-
-Of particular interest is that
-	- End-of-line characters are considered end-of-sentence markers. 
-
-A sentence detector model is included with this project.
-
-The model derives from a combination of GENIA, Penn Treebank (Wall Street Journal) and anonymized
-clinical data per Safe Harbor HIPAA guidelines. Prior to model building, the clinical data was 
-deidentified for patient names to preserve patient confidentiality. Any person name in the model 
-will originate from non-patient data sources.
-   
-
-#############################
-Analysis engines (annotators)
-#############################
-
-%%%%%%%%%%%%%%%%%
-CopyAnnotator.xml
-
-This is a utility annotator that copies data from an existing JCas object into a new JCas object.
-
-%%%%%%%%%%%%%%%%%
-NullAnnotator.xml
-
-%%%%%%%%%%%%%%%%%%%%
-OverlapAnnotator.xml
-
-An annotator that modifies one annotation (begin and end offsets) or deletes one (or both) of 
-the annotations, when two annotations overlap. The action taken depends on the configuration parameters.
-
-It can extend an annotation to encompass overlapping annotations.
-
-It can be configured to delete annotations of type A that are subsumed by other annotations of type A 
-if you only want the longest annotations of the given type to be kept.
-
-See the javadoc for org.apache.ctakes.core.ae.OverlapAnnotator for more details.
-
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-SentenceDetectorAnnotator.xml
-
-A wrapper around the OpenNLP sentence detector, that creates Sentence annotations based on the 
-location of end-of-line characters and on the output of the OpenNLP sentence detector.
-This annotator considers an end-of-line character as an end-of-sentence marker.
-Optionally can skip certain sections of the document.
-
-Parameters:
-  SegmentsToSkip - (optional) the list of sections not to create Sentence annotations for.  
-
-Resources:
-  MaxentModelFile - (required) the Maxent model sentence detector.
-  
-  
-%%%%%%%%%%%%%%%%%%%%%%%%%%
-SimpleSegmentAnnotator.xml
-
-Creates a single Segment annotation, encompassing the entire document.  
-For use prior to annotators that require a Segment annotation, when the the pipeline does not
-contain a different annotator that creates Segment annotations.
-This annotator is used for plaintext files, but not for CDA documents, as the
-CdaCasInitializer annotator creates Segment annotations.
-
-Parameters:
-  SegmentID - (optional) the identifier to use for the Segment annotation created.   
-
-%%%%%%%%%%%%%%%%%%%%%%
-TokenizerAnnotator.xml
-
-Tokenizes text.    
-See classes org.apache.ctakes.core.ae.TokenizerAnnotatorPTB and org.apache.ctakes.core.nlp.tokenizer.Tokenizer
-for implementation details.
-
-Parameters:
-  SegmentsToSkip - (optional) the list of sections not to create token annotations for.
-
-
diff --git a/ctakes-core/README.md b/ctakes-core/README.md
new file mode 100644
index 0000000..3df5f3b
--- /dev/null
+++ b/ctakes-core/README.md
@@ -0,0 +1 @@
+Contains code and resources required by all or most other cTAKES modules.
\ No newline at end of file
diff --git a/ctakes-core/src/user/resources/org/apache/ctakes/core/pipeline/DefaultTokenizerPipeline.piper b/ctakes-core/src/user/resources/org/apache/ctakes/core/pipeline/DefaultTokenizerPipeline.piper
index 6259d5a..2e53e78 100644
--- a/ctakes-core/src/user/resources/org/apache/ctakes/core/pipeline/DefaultTokenizerPipeline.piper
+++ b/ctakes-core/src/user/resources/org/apache/ctakes/core/pipeline/DefaultTokenizerPipeline.piper
@@ -1,4 +1,4 @@
-// Commands and parameters to create a default token processing pipeline
+// Commands and parameters for a small tokenization pipeline.
 
 add SimpleSegmentAnnotator
 add SentenceDetector
diff --git a/ctakes-core/src/user/resources/org/apache/ctakes/core/pipeline/FullTokenizerPipeline.piper b/ctakes-core/src/user/resources/org/apache/ctakes/core/pipeline/FullTokenizerPipeline.piper
index 9f9409d..e88592f 100644
--- a/ctakes-core/src/user/resources/org/apache/ctakes/core/pipeline/FullTokenizerPipeline.piper
+++ b/ctakes-core/src/user/resources/org/apache/ctakes/core/pipeline/FullTokenizerPipeline.piper
@@ -1,4 +1,4 @@
-// Commands and parameters to create a token processing pipeline with sections, paragraphs and lists
+// Commands and parameters for a small tokenization pipeline with sections, paragraphs and lists.
 
 // Annotate sections by known regex
 add BsvRegexSectionizer
diff --git a/ctakes-core/src/user/resources/org/apache/ctakes/core/pipeline/TsDefaultTokenizerPipeline.piper b/ctakes-core/src/user/resources/org/apache/ctakes/core/pipeline/TsDefaultTokenizerPipeline.piper
index 4c3225c..6342a6c 100644
--- a/ctakes-core/src/user/resources/org/apache/ctakes/core/pipeline/TsDefaultTokenizerPipeline.piper
+++ b/ctakes-core/src/user/resources/org/apache/ctakes/core/pipeline/TsDefaultTokenizerPipeline.piper
@@ -1,4 +1,4 @@
-// Commands and parameters to create a default token processing pipeline
+// Commands and parameters for a small thread-safe tokenization pipeline.
 
 add SimpleSegmentAnnotator
 add concurrent.ThreadSafeSentenceDetector
diff --git a/ctakes-core/src/user/resources/org/apache/ctakes/core/pipeline/TsFullTokenizerPipeline.piper b/ctakes-core/src/user/resources/org/apache/ctakes/core/pipeline/TsFullTokenizerPipeline.piper
index 554614f..29ac5f5 100644
--- a/ctakes-core/src/user/resources/org/apache/ctakes/core/pipeline/TsFullTokenizerPipeline.piper
+++ b/ctakes-core/src/user/resources/org/apache/ctakes/core/pipeline/TsFullTokenizerPipeline.piper
@@ -1,4 +1,4 @@
-// Commands and parameters to create a token processing pipeline with sections, paragraphs and lists
+// Commands and parameters for a small thread-safe tokenization pipeline with sections, paragraphs and lists.
 
 // Annotate sections by known regex
 add BsvRegexSectionizer
diff --git a/ctakes-coreference/README b/ctakes-coreference/README
deleted file mode 100644
index 9f62d93..0000000
--- a/ctakes-coreference/README
+++ /dev/null
@@ -1,76 +0,0 @@
-This is the README for the Coreference Resolution module in the cTakes project.
-
-This module performs coreference resolution for several types of coreference,
-excluding person mentions and some rare pronouns.
-
-Installation:
-This module contains a number of references to other cTAKES modules, especially
-the Constituency Parser.  The links inside this project use relative path names
-so they should be portable as long as all modules are placed in the same directory.
-
-Types:
-
-Most basically, the output of this module will be several data types added to 
-the CAS representing the output of the system.  These types are as follows:
-
-Markable - Subtyped into NEMarkable (Named entities), PronounMarkable (pronouns),
-and DemMarkable (certain demonstrative and relative pronouns), these are automatically
-discovered and taken as input to the coreference resolution algorithm.  These are types
-required above the SHARP types for entities due to some special considerations with
-span differences and differing type inheritances.
-
-CoreferenceRelation - A type containing two Markables that are believed to
-co-refer.  A CoreferenceRelation has two arguments of type RelationArgument,
-with a role field containing a value of either "anaphor" or "antecedent."  There
-is also an "argument" field which contains the Markable fulfilling the role.
-
-CollectionTextRelation - A linked list containing chains of Annotations that the classifier
-says refer to the same entity.  This is derived from the set of CoreferenceRelation
-elements described above.  It contains a list of UIMA type NonEmptyFSList, as well
-as a size field.  For singletons there are lists of length 1.  For actual chains
-the size will be different, and each node in the list is of type NonEmptyFSList.
-That type has a head and tail field.  The head points to the data for the node,
-which is a Markable, and the tail points to the next element in the list, or
-to a node of type EmptyFSList when the chain is complete.
-
-UIMA Annotators:
-This module is released with several UIMA processing classes which can be included
-in pipelines.
-
-desc/analysis_engine/CorefUMLSProcessor.xml:
-An end-to-end aggregate annotator mainly used for demo/debugging.  You can use this in 
-the CVD (CAS VIsual Debugger) to test your setup with the following:
-        - Run launcher resources/launcher/*cvd*
-        - Load descriptor desc/analysis_engine/CorefUMLSProcessor.xml
-        - Open file resources/testfakenote.txt
-        - Run AE (Ctrl-R)
-        - Inspect results
-            - Should be 13 markables, 10 nes, 2 pronouns, and 1 dem (under Annotation index)
-            - Should be 9 CollectionTextRelation - most are 1 element (singletons).
-            - Chain 3 has 3 elements: "immense leg pain", "the pain", and "pain".
-            - Chain 6 has 2 elements: "a small lesion..." and "the lesion"
-            - Chain 8 has 2 elements: "imaging" and "which"
-            - These chains are decomposed in the CoreferenceRelation index into pairs. 
-
-
-
-desc/collection_processing_engine/Coref-resolver_CPE.xml:
-This is a collection processing engine.  It wraps the above AE with a collection
-reader and consumer.  CPEs can be run with resources/launch/UIMA_CPE_coref-resolver.launch
-eclipse launch configuration.  File->Load the CPE above, then the CPE GUI will have
-text boxes with associated file chooser buttons for the input and output files.
-
-The remaining descriptor files are mostly not meant to be used independently.  Please
-feel free to email the authors if you are curious about their usage and want help
-figuring it out.
-
-If you want to use the coreference module for a pipeline of your own, the recommended
-method is to make a copy of CorefUMLSProcessor.xml and add any other modules you 
-require to that pipeline.  Future release will contain standalone pipelines with
-the minimum set of requirements, but in fact the CorefDBProcessor is pretty close
-to being that already -- corefererence resolution is simply dependent on a lot of
-earlier tasks.
-
-
-
-
diff --git a/ctakes-coreference/README.md b/ctakes-coreference/README.md
new file mode 100644
index 0000000..bea9b64
--- /dev/null
+++ b/ctakes-coreference/README.md
@@ -0,0 +1,29 @@
+Performs coreference resolution for several types of coreference, excluding person mentions and some rare pronouns.
+
+Most basically, the output of this module will be several data types added to 
+the CAS representing the output of the system.  These types are as follows:
+
+Markable - Subtyped into NEMarkable (Named entities), PronounMarkable (pronouns),
+and DemMarkable (certain demonstrative and relative pronouns), these are automatically
+discovered and taken as input to the coreference resolution algorithm.  These are types
+required above the SHARP types for entities due to some special considerations with
+span differences and differing type inheritances.
+
+CoreferenceRelation - A type containing two Markables that are believed to
+co-refer.  A CoreferenceRelation has two arguments of type RelationArgument,
+with a role field containing a value of either "anaphor" or "antecedent."  There
+is also an "argument" field which contains the Markable fulfilling the role.
+
+CollectionTextRelation - A linked list containing chains of Annotations that the classifier
+says refer to the same entity.  This is derived from the set of CoreferenceRelation
+elements described above.  It contains a list of UIMA type NonEmptyFSList, as well
+as a size field.  For singletons there are lists of length 1.  For actual chains
+the size will be different, and each node in the list is of type NonEmptyFSList.
+That type has a head and tail field.  The head points to the data for the node,
+which is a Markable, and the tail points to the next element in the list, or
+to a node of type EmptyFSList when the chain is complete.
+
+
+
+
+
diff --git a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/CorefSubPipe.piper b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/CorefSubPipe.piper
index d06f5d1..ed2468a 100644
--- a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/CorefSubPipe.piper
+++ b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/CorefSubPipe.piper
@@ -1,4 +1,5 @@
-// Commands and parameters to create a default coreference processing sub-pipeline.  This is not a full pipeline.
+// Commands and parameters to create a default coreference processing sub-pipeline.
+// This is not a full pipeline.
 
 // A Dependency Parser is necessary, but is usually added for assertion so don't add one here
 
diff --git a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/DefaultAdvancedPipeline.piper b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/DefaultAdvancedPipeline.piper
index 1f4dc04..38800ee 100644
--- a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/DefaultAdvancedPipeline.piper
+++ b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/DefaultAdvancedPipeline.piper
@@ -1,6 +1,4 @@
-// Default Clinical Pipeline with degree-of and location-of relations
-// with events, times, event-event and event-time relations plus event-document creation time relations
-// with coreference resolution
+// Pipeline with degree-of and location-of relations, events, times, temporal relations, document creation time relations and coreferences.
 
 // Default Relation and Temporal pipeline
 load DefaultRelationTemporalPipeline
diff --git a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/DefaultCorefPipeline.piper b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/DefaultCorefPipeline.piper
index a1798b7..f1e6a87 100644
--- a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/DefaultCorefPipeline.piper
+++ b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/DefaultCorefPipeline.piper
@@ -1,6 +1,6 @@
-// Default Clinical Pipeline with  coreference resolution
+// Pipeline with  coreference resolution.
 
-// Default Clinical Pipeline
+// Pipeline
 load DefaultFastPipeline
 
 // Coreference resolution
diff --git a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/DefaultRelationCorefPipeline.piper b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/DefaultRelationCorefPipeline.piper
index 6dd1e32..085ce55 100644
--- a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/DefaultRelationCorefPipeline.piper
+++ b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/DefaultRelationCorefPipeline.piper
@@ -1,7 +1,6 @@
-// Default Clinical Pipeline with degree-of and location-of relations
-// with coreference resolution
+// Pipeline with degree-of and location-of relations and coreference resolution.
 
-// Default Clinical Pipeline with degree-of and location-of relations
+// Pipeline with degree-of and location-of relations
 load DefaultRelationPipeline
 
 // Coreference resolution
diff --git a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/DefaultTemporalCorefPipeline.piper b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/DefaultTemporalCorefPipeline.piper
index 848b65d..a26c60f 100644
--- a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/DefaultTemporalCorefPipeline.piper
+++ b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/DefaultTemporalCorefPipeline.piper
@@ -1,5 +1,4 @@
-// Default Clinical Pipeline with events, times, event-event and event-time relations plus event-document creation time relations
-// and coreferences
+// Pipeline with events, times, temporal relations, document creation time relations and coreferences.
 
 // Default Temporal pipeline
 load DefaultTemporalPipeline
diff --git a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/SectionedAdvancedPipeline.piper b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/SectionedAdvancedPipeline.piper
index ecc8d82..31a4378 100644
--- a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/SectionedAdvancedPipeline.piper
+++ b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/SectionedAdvancedPipeline.piper
@@ -1,6 +1,5 @@
-// Clinical Pipeline with sectionization, paragraph and list detection and degree-of and location-of relations
-// with events, times, event-event and event-time relations plus event-document creation time relations
-// with coreference resolution
+// Pipeline with section, paragraph and list detection, degree-of and location-of relations ...
+// events, times, temporal relations, document creation time relations and coreference resolution.
 
 // Sectioned Relation and Temporal pipeline
 load SectionedRelationTemporalPipeline
diff --git a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/SectionedCorefPipeline.piper b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/SectionedCorefPipeline.piper
index 6bbe692..6f28ab6 100644
--- a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/SectionedCorefPipeline.piper
+++ b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/SectionedCorefPipeline.piper
@@ -1,6 +1,6 @@
-// Clinical Pipeline with sectionization, paragraph and list detection and coreference resolution
+// Pipeline with section, paragraph and list detection and coreference resolution.
 
-// Default Clinical Pipeline with sectionization, paragraph and list detection
+// Pipeline with section, paragraph and list detection
 load SectionedFastPipeline
 
 // Coreference resolution
diff --git a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/SectionedRelationCorefPipeline.piper b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/SectionedRelationCorefPipeline.piper
index 196ff61..32ddb31 100644
--- a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/SectionedRelationCorefPipeline.piper
+++ b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/SectionedRelationCorefPipeline.piper
@@ -1,7 +1,6 @@
-// Clinical Pipeline with sectionization, paragraph and list detection and degree-of and location-of relations
-// with coreference resolution
+// Pipeline with section, paragraph and list detection, degree-of and location-of relations and coreferences.
 
-// Clinical Pipeline with sectionization, paragraph and list detection with degree-of and location-of relations
+// Pipeline with section, paragraph and list detection with degree-of and location-of relations
 load SectionedRelationPipeline
 
 // Coreference resolution
diff --git a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/SectionedTemporalCorefPipeline.piper b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/SectionedTemporalCorefPipeline.piper
index 4699cb1..f3d93b8 100644
--- a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/SectionedTemporalCorefPipeline.piper
+++ b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/SectionedTemporalCorefPipeline.piper
@@ -1,7 +1,6 @@
-// Clinical Pipeline with sectionization, paragraph and list detection with
-// events, times, event-event and event-time relations plus event-document creation time relations
+// Pipeline with section, paragraph and list detection, events, times, temporal relations and document creation time relations.
 
-// Clinical Pipeline with sectionization, paragraph and list detection and temporal
+// Pipeline with section, paragraph and list detection and temporal
 load SectionedTemporalPipeline
 
 // Coreference resolution
diff --git a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsCorefSubPipe.piper b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsCorefSubPipe.piper
index 6475a18..d4ea0a3 100644
--- a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsCorefSubPipe.piper
+++ b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsCorefSubPipe.piper
@@ -1,4 +1,5 @@
-// Commands and parameters to create a default coreference processing sub-pipeline.  This is not a full pipeline.
+// Commands and parameters to create a thread-safe default coreference processing sub-pipeline.
+// This is not a full pipeline.
 
 // A Dependency Parser is necessary, but is usually added for assertion so don't add one here
 
diff --git a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsDefaultAdvancedPipeline.piper b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsDefaultAdvancedPipeline.piper
index c3e3c2b..18cd445 100644
--- a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsDefaultAdvancedPipeline.piper
+++ b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsDefaultAdvancedPipeline.piper
@@ -1,6 +1,5 @@
-// Thread Safe Default Clinical Pipeline with degree-of and location-of relations
-// with events, times, event-event and event-time relations plus event-document creation time relations
-// with coreference resolution
+// Thread-safe Pipeline with degree-of and location-of relations, events, times, temporal relations, document creation time relations and coreferences.
+
 
 // Default Relation and Temporal pipeline
 load TsDefaultRelationTemporalPipeline
diff --git a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsDefaultCorefPipeline.piper b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsDefaultCorefPipeline.piper
index 92c3a61..d773498 100644
--- a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsDefaultCorefPipeline.piper
+++ b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsDefaultCorefPipeline.piper
@@ -1,6 +1,6 @@
-// Thread Safe Default Clinical Pipeline with  coreference resolution
+// Thread-safe Pipeline with  coreference resolution.
 
-// Default Clinical Pipeline
+// Pipeline
 load TsDefaultFastPipeline
 
 // Coreference resolution
diff --git a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsDefaultRelationCorefPipeline.piper b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsDefaultRelationCorefPipeline.piper
index b479c3e..dd0584d 100644
--- a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsDefaultRelationCorefPipeline.piper
+++ b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsDefaultRelationCorefPipeline.piper
@@ -1,7 +1,7 @@
-// Thread Safe Default Clinical Pipeline with degree-of and location-of relations
-// with coreference resolution
+// Thread-safe Pipeline with degree-of and location-of relations and coreference resolution.
 
-// Default Clinical Pipeline with degree-of and location-of relations
+
+// Pipeline with degree-of and location-of relations
 load TsDefaultRelationPipeline
 
 // Coreference resolution
diff --git a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsDefaultTemporalCorefPipeline.piper b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsDefaultTemporalCorefPipeline.piper
index c297035..04db93a 100644
--- a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsDefaultTemporalCorefPipeline.piper
+++ b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsDefaultTemporalCorefPipeline.piper
@@ -1,5 +1,5 @@
-// Thread Safe Default Clinical Pipeline with events, times, event-event and event-time relations plus event-document creation time relations
-// and coreferences
+// Thread-safe Pipeline with events, times, temporal relations, document creation time relations and coreferences.
+
 
 // Default Temporal pipeline
 load TsDefaultTemporalPipeline
diff --git a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsSectionedAdvancedPipeline.piper b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsSectionedAdvancedPipeline.piper
index 111c2f5..e369259 100644
--- a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsSectionedAdvancedPipeline.piper
+++ b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsSectionedAdvancedPipeline.piper
@@ -1,6 +1,5 @@
-// Thread Safe Clinical Pipeline with sectionization, paragraph and list detection and degree-of and location-of relations
-// with events, times, event-event and event-time relations plus event-document creation time relations
-// with coreference resolution
+// Thread-safe Pipeline with section, paragraph and list detection, degree-of and location-of relations ...
+// events, times, temporal relations, document creation time relations and coreference resolution.
 
 // Sectioned Relation and Temporal pipeline
 load TsSectionedRelationTemporalPipeline
diff --git a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsSectionedCorefPipeline.piper b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsSectionedCorefPipeline.piper
index 06a6fe6..cd4000f 100644
--- a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsSectionedCorefPipeline.piper
+++ b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsSectionedCorefPipeline.piper
@@ -1,6 +1,6 @@
-// Thread Safe Clinical Pipeline with sectionization, paragraph and list detection and coreference resolution
+// Thread-safe Pipeline with section, paragraph and list detection and coreference resolution.
 
-// Default Clinical Pipeline with sectionization, paragraph and list detection
+// Pipeline with section, paragraph and list detection
 load TsSectionedFastPipeline
 
 // Coreference resolution
diff --git a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsSectionedRelationCorefPipeline.piper b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsSectionedRelationCorefPipeline.piper
index 96aa182..73b89ef 100644
--- a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsSectionedRelationCorefPipeline.piper
+++ b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsSectionedRelationCorefPipeline.piper
@@ -1,7 +1,7 @@
-// Thread Safe Clinical Pipeline with sectionization, paragraph and list detection and degree-of and location-of relations
-// with coreference resolution
+// Thread-safe Pipeline with section, paragraph and list detection, degree-of and location-of relations and coreferences.
 
-// Clinical Pipeline with sectionization, paragraph and list detection with degree-of and location-of relations
+
+// Pipeline with section, paragraph and list detection with degree-of and location-of relations
 load TsSectionedRelationPipeline
 
 // Coreference resolution
diff --git a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsSectionedTemporalCorefPipeline.piper b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsSectionedTemporalCorefPipeline.piper
index e9d32ea..7864201 100644
--- a/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsSectionedTemporalCorefPipeline.piper
+++ b/ctakes-coreference/src/user/resources/org/apache/ctakes/coreference/pipeline/TsSectionedTemporalCorefPipeline.piper
@@ -1,7 +1,7 @@
-// Thread Safe Clinical Pipeline with sectionization, paragraph and list detection with
-// events, times, event-event and event-time relations plus event-document creation time relations
+// Thread-safe Pipeline with section, paragraph and list detection, events, times, temporal relations and document creation time relations.
 
-// Clinical Pipeline with sectionization, paragraph and list detection and temporal
+
+// Pipeline with section, paragraph and list detection and temporal
 load TsSectionedTemporalPipeline
 
 // Coreference resolution
diff --git a/ctakes-dependency-parser/README.md b/ctakes-dependency-parser/README.md
new file mode 100644
index 0000000..7c4a146
--- /dev/null
+++ b/ctakes-dependency-parser/README.md
@@ -0,0 +1,17 @@
+Dependency parsers provide syntactic information about sentences. 
+Unlike deep parsers, they do not explicitly find phrases (e.g., NP or VP); rather, they find the dependencies between words.
+For example, "hormone replacement therapy" would have deep structure:  
+`````(NP (NML (NN hormone) (NN replacement)) (NN therapy))`````  
+but its dependency structure would show that "hormone" depends on "replacement" and "replacement" in turn depends on "therapyl". 
+Below, the first column of numbers indicates the ID of the word, and the second number indicates what it is dependent on.  
+```23 hormone hormone NN 24 NMOD 24 replacement replacement NN 25 NMOD 25 therapy therapy NN 22 PMOD```  
+Dependency parsers can be labeled as well, e.g., we could specify that "hormone" is in a noun-modifier (i.e., NMOD) relationship with "therapy" in the example above (the last column).  
+This project provides an [Apache UIMA](https://uima.apache.org/) wrapper and some utilities for [ClearParser](https://github.com/clearnlp),
+a transition-based dependency parser that achieves state-of-the-art accuracy and speed.  
+
+ClearParser is described in:  
+"K-best, Locally Pruned, Transition-based Dependency Parsing Using Robust Risk Minimization."
+Jinho D. Choi, Nicolas Nicolov, Collections of Recent Advances in Natural Language Processing V,
+205-216, John Benjamins, Amsterdam & Philadelphia, 2009.  
+
+The semantic role labeler assigns the predicate-argument structure of the sentence. (Who did what to whom when and where.) 
\ No newline at end of file
diff --git a/ctakes-dictionary-lookup-fast/README b/ctakes-dictionary-lookup-fast/README
deleted file mode 100644
index b1be202..0000000
--- a/ctakes-dictionary-lookup-fast/README
+++ /dev/null
@@ -1,2 +0,0 @@
-New Dictionary Lookup Module for Apache cTakes.
-Please check the doc/ directory for documentation.
\ No newline at end of file
diff --git a/ctakes-dictionary-lookup-fast/README.md b/ctakes-dictionary-lookup-fast/README.md
new file mode 100644
index 0000000..3f14ec4
--- /dev/null
+++ b/ctakes-dictionary-lookup-fast/README.md
@@ -0,0 +1,94 @@
+The fast dictionary lookup annotator identifies terms in text and normalizes them to codes in an ontology:
+UMLS CUI, Snomed-CT, RxNorm, etc.
+The fast dictionary lookup module comes with multiple possible pre-packaged configurations and is also customizable and extendable.  
+<details>
+<summary>Process Overview</summary>
+The Fast Dictionary Lookup module has six basic processes performed by three components, as well as a parser that can configure the actual Dictionaries.
+
+- A Parse Dictionary Descriptor file
+- B Create Dictionaries and Concept Factories
+
+1.	Get _Lookup Windows_ from **CAS**
+2.	For each _Lookup window_, get candidate _Lookup Tokens_
+3.	For each _Lookup Token_, get matches in Dictionary Index
+4.	For each _Token_ match, check _Lookup Window_ for _Full Text_ match
+5.	For each _Full Text_ match, create _Concepts_
+6.	Store appropriate _Concepts_ in **CAS** as **Annotations**
+
+![Structure Diagram](images/EnumeratedFlow2.png)
+</details>
+
+<details>
+<summary>Configuration</summary>
+There are options available to change the type of term matching used as well as the persistence of terms.
+Changes in configuration are made in two places:  
+
+1.	The main descriptor ...```-fast/desc/analysis_engine/UmlsLookupAnnotator.xml```
+2.	The resource (dictionary) configuration file ```resources/.../dictionary/lookup/fast/sno_rx_16ab.xml``` 
+(The file name might be different if you created your own custom dictionary)
+</details>
+
+<details>
+<summary>Text Exact Match</summary>
+Because the UMLS dictionary contains rows with different combinations of lexical elements per term, 
+using a direct string match of text in note to text of term is a valid candidate for term matching.  
+This is different from the complex mechanism in the current (first word) lookup, and makes for simpler code and greater accuracy. 
+This precise specification (and improved lookup speed) enables the use of an entire sentence as a lookup window rather than just a noun phrase.
+Usage of Sentence as a lookup window allows all possible tokens to be used for not only lookup keys, but also for term matching.  
+For proper accuracy, custom dictionaries should also contain multiple entries for variations of term syntax. 
+Note that term matching is attempted using the actual text in the note and also per-token cTAKES-generated lexical variants 
+of the text in the note.  
+This is the behavior of the ```DefaultJCasTermAnnotator``` class, which is the one used in the ```UmlsLookupAnnotator.xml``` descriptor.
+</details>
+
+<details>
+<summary>Text Overlap Match</summary>
+To better approximate the original lookup annotator, one lookup method finds overlapping terms in addition to exact matching terms.
+This allows matches on discontiguous spans.
+For instance, for the text “blood, urine test” the exact match will find only one procedure: “urine test”. 
+The overlap match will find both “urine test” and “blood     test”. 
+This is the behavior of the OverlapJCasTermAnnotator class, which is the one used in the ```UmlsOverlapLookupAnnotator.xml``` descriptor.
+</details>
+
+<details>
+<summary>All Terms Persistence</summary>
+All terms discovered by the matchers can be stored in the CAS by a consumer, regardless of any property of the term. 
+This means that for the text “lung cancer” the specific disease term “lung cancer” and broader term “cancer”. 
+This can be useful for future searches on general concepts, 
+e.g. searching via the CUI for “cancer” and getting all instances of “cancer” found in texts “lung cancer”, “skin cancer”, “stomach cancer”, etc. 
+This is the behavior of the ```DefaultTermConsumer``` class.
+</details>
+
+<details>
+<summary>Most Precise Terms Persistence</summary>
+Matched terms can be stored only by the longest overlapping span discovered for a semantic group.
+This keeps, for instance, the disease “lung cancer” but not “cancer”. 
+Using semantic groups means that both the disease “lung cancer” and the anatomical site “lung” are persisted even though the spans overlap. 
+When using the overlap matching method, any discontiguous spans are accounted for. 
+So, for “blood, urine test” both the discontiguous spanned term “blood   test” and the contiguous spanned term “urine test” are valid. 
+To persist only the most precise terms, edit the xml configuration file for your dictionary (default is ```sno_rx_16ab.xml```),
+specifically within the section rareWordConsumer change the selected implementation. 
+By default it is ```DefaultTermConsumer```, but you will want to use the commented-out ```PrecisionTermConsumer```.
+</details>
+
+<details>
+<summary>Dictionary Stores</summary>
+The default configuration uses a dictionary that contains a subset of the UMLS in an hsql database. 
+Custom dictionaries can be added using another hsql database, or using a bar-separated value (BSV) (a.k.a. pipe-separated) flat file. 
+If you use a BSV file you do not need to tokenize the terms. 
+Tokenization will be done automatically at runtime.
+</details>
+
+<details>
+<summary>Lookup Window</summary>
+By default the new lookup uses Sentence as the lookup window. 
+The primary reasons for this are:
+
+1. Not all terms are within Noun Phrases
+2. Some Noun Phrases overlapped, causing repeated lookups (in my 3.0 candidate trials)
+3. Not all cTakes Noun Phrases are accurate. 
+
+Because the lookup is fast, using a full Sentence for lookup doesn't seem to hurt much. 
+However, you can always switch it back to see if precision is increased enough to warrant the decrease in recall. 
+This is changed in ```UmlsLookupAnnotator.xml```.
+</details>
\ No newline at end of file
diff --git a/ctakes-dictionary-lookup-fast/src/user/resources/org/apache/ctakes/dictionary/lookup/fast/pipeline/DictionarySubPipe.piper b/ctakes-dictionary-lookup-fast/src/user/resources/org/apache/ctakes/dictionary/lookup/fast/pipeline/DictionarySubPipe.piper
index 871afdd..043d09c 100644
--- a/ctakes-dictionary-lookup-fast/src/user/resources/org/apache/ctakes/dictionary/lookup/fast/pipeline/DictionarySubPipe.piper
+++ b/ctakes-dictionary-lookup-fast/src/user/resources/org/apache/ctakes/dictionary/lookup/fast/pipeline/DictionarySubPipe.piper
@@ -1,4 +1,5 @@
-//  Commands and parameters to create a default dictionary lookup sub-pipeline.  This is not a full pipeline.
+//  Commands and parameters to create a dictionary lookup sub-pipeline.
+// This is not a full pipeline.
 
 // path to the xml file containing information for dictionary lookup configuration.
 cli LookupXml=l
diff --git a/ctakes-dictionary-lookup-fast/src/user/resources/org/apache/ctakes/dictionary/lookup/fast/pipeline/TsDictionarySubPipe.piper b/ctakes-dictionary-lookup-fast/src/user/resources/org/apache/ctakes/dictionary/lookup/fast/pipeline/TsDictionarySubPipe.piper
index 6f7cf50..ce4790d 100644
--- a/ctakes-dictionary-lookup-fast/src/user/resources/org/apache/ctakes/dictionary/lookup/fast/pipeline/TsDictionarySubPipe.piper
+++ b/ctakes-dictionary-lookup-fast/src/user/resources/org/apache/ctakes/dictionary/lookup/fast/pipeline/TsDictionarySubPipe.piper
@@ -1,4 +1,5 @@
-//  Commands and parameters to create a default dictionary lookup sub-pipeline.  This is not a full pipeline.
+//  Commands and parameters to create a default dictionary lookup sub-pipeline.
+//  This is not a full pipeline.
 
 // path to the xml file containing information for dictionary lookup configuration.
 cli LookupXml=l
diff --git a/ctakes-dictionary-lookup/README b/ctakes-dictionary-lookup/README.md
similarity index 58%
rename from ctakes-dictionary-lookup/README
rename to ctakes-dictionary-lookup/README.md
index a4db325..94d8c61 100644
--- a/ctakes-dictionary-lookup/README
+++ b/ctakes-dictionary-lookup/README.md
@@ -1,148 +1,83 @@
-
-Contents
-- Introduction
-- Implementation overview
-- Sample dictionaries included
-- Creating your own dictionaries
-- Configuring the annotator to use your dictionary
-- Running the analysis engine (annotator)
-	- AggregateAE.xml
-	- DictionaryLookupannotator.xml
-	- DictionaryLookupannotatorCSV.xml
-	- DictionaryLookupannotatorDB.xml
-
-############
-Introduction
-############
-
-The dictionary lookup annotator finds the entries from one or more dictionaries that match the
-document text in some way.  Within this annotator, these matches are called lookup hits.
-
-The dictionary lookup annotator is very customizable. 
-
+<details>
+<summary>The dictionary lookup annotator finds the entries from one or more dictionaries that match the
+document text in some way.</summary>summary>
+Within this annotator, these matches are called lookup hits.  
+The dictionary lookup annotator is very customizable.  
 It can look for matches where the words in the dictionary entries appear in the same order as
-the words in the document text, or it can look for permutations of the words from the dictionary.
-
+the words in the document text, or it can look for permutations of the words from the dictionary.  
 It can look just for exact matches of the words, or it can also look for matches to the 
-canonical forms of the words.
-
+canonical forms of the words.  
 Searches for a lookup hit are limited to within windows, where the window type is defined in
 the LookupDescriptorFile. A window can be the words that fall within the same Sentence, the same
 Chunk, the same LookupWindowAnnotation or any other annotation.  See the clinical documents 
 pipeline project for an example of an analysis engine (LookupWindowAnnotator.xml) that
-that creates LookupWindowAnnotations.
-
-Note: Dictionary entries need to have been tokenized the way the pipeline tokenizes the document text.
-
-
-#######################
-Implementation overview
-#######################
-
+that creates LookupWindowAnnotations.  
+Note: Dictionary entries need to have been tokenized the way the pipeline tokenizes the document text.  
 The behavior of the dictionary lookup annotator is controlled by the parameters and resources 
 defined in the analysis engine descriptor, and by the contents of the resource called the 
-LookupDescriptorFile. 
-
-For example, if the analysis engine descriptor "DictionaryLookup.xml" contains 
-a resource named LookupDescriptorFile with value "lookup/LookupDesc.xml", then the parameter
-settings and resources named within "DictionaryLookup.xml", together with the values within
-"lookup/LookupDesc.xml" will control the actions of the dictionary lookup annotator.
-
-The lookupInitializer and lookupConsumer classes are specified within the LookupDescriptorFile.
-
+LookupDescriptorFile.  
+For example, if the analysis engine descriptor ```DictionaryLookup.xml``` contains 
+a resource named LookupDescriptorFile with value ```lookup/LookupDesc.xml```, then the parameter
+settings and resources named within ```DictionaryLookup.xml```, together with the values within
+"lookup/LookupDesc.xml" will control the actions of the dictionary lookup annotator.  
+The lookupInitializer and lookupConsumer classes are specified within the LookupDescriptorFile.  
 The algorithm used for looking up the terms is defined by the lookupInitializer, which
-creates the lookup hits.
-
-The lookupConsumer adds annotations to the CAS for some or all of the lookup hits.
-
+creates the lookup hits.  
+The lookupConsumer adds annotations to the CAS for some or all of the lookup hits.  
 An example adding only some of the lookup hits to the CAS is if you have a dictionary of RxNorm 
 terms with their RxNorm codes, and a dictionary of terms from the OrangeBook, and want to create 
-annotations for those terms that are in the OrangeBook that also have an RxNorm code.
-
-This can be done using class org.apache.ctakes.dictionary.lookup.ae.FirstTokenPermLookupInitializerImpl 
+annotations for those terms that are in the OrangeBook that also have an RxNorm code.  
+This can be done using class ```org.apache.ctakes.dictionary.lookup.ae.FirstTokenPermLookupInitializerImpl```
 as the lookupInitializer, and using class OrangeBookFilterConsumerImpl as the lookupConsumer,
 provided you have the RxNorm dictionary, and you configure the LookupDescriptorFile resource
-to use your RxNorm dictionary.
-
-
+to use your RxNorm dictionary.  
 Note: The analysis engine descriptors for this annotator use elements of type 
 configurableDataResourceSpecifier.
 These cannot be modified from the Parameters or Resources tabs of the Component Descriptor 
 Editor (at least not in UIMA 2.2). To view these values or edit them, use the Sources tab or 
-open the descriptor with a Text Editor.
- 
-
-Note: Dictionary entries need to have been tokenized the way the pipeline tokenizes the document text.
-
+open the descriptor with a Text Editor.  
+Note: Dictionary entries need to have been tokenized the way the pipeline tokenizes the document text.  
 For example, the lookup algorithm will not find a lookup hit if a dictionary entry is 
 "ear, skin" but the document text contains the same text ("ear, skin") and the pipeline 
-has tokenized that text as the 3 tokens "ear" "," "skin".
-
+has tokenized that text as the 3 tokens "ear" "," "skin".  
 To find a lookup hit for the 3 tokens, the dictionary entry should be tokenized,
-with a space before the comma: "ear , skin" 
-
+with a space before the comma: "ear , skin"  
 To determine the LookupDescriptorFile for an analysis engine, open the analysis engine descriptor 
 (e.g. DictionaryLookupannotator.xml) and note the URL for the LookupDescriptorFile resource 
-(e.g. lookup/LookupDesc.xml).
-
+(e.g. lookup/LookupDesc.xml).  
 A LookupDescriptorFile such as lookup/LookupDesc.xml, found in resources/, 
 defines the dictionary(s) used, and the classes that interact with the 
 dictionary(s). The implementation tag identifies the type of dictionary:
 lucene index (luceneImpl), database (jdbcImpl), or delimited flatfile (csvImpl).
-See class org.apache.ctakes.dictionary.lookup.ae.LookupParseUtilities.java for implementation details.
-
-
+See class org.apache.ctakes.dictionary.lookup.ae.LookupParseUtilities.java for implementation details.  
 To better understand the dictionary lookup annotator code you could start by reading the javadocs
 for the classes DictionaryLookupAnnotator.java and FirstTokenPermutationImpl.java.   
 
-#######################################
-Sample dictionaries included
-#######################################
-
-This project includes two sample dictionaries.
-
+This project includes two sample dictionaries.  
 A sample database (a Lucene index) containing a few drug names is included
-for running the examples.
-  
+for running the examples.  
 A sample database (using 2 Lucene indexes) containing a few anatomical sites, procedures, 
-and disorders/diseases is included for running the examples.
-
-The programs used to create these Lucene indexes are
+and disorders/diseases is included for running the examples.  
+The programs used to create these Lucene indexes are  
 scripts/java/edu/mayo/bmi/dictionarytools/CreateLuceneIndexForExampleDrugs.java
 scripts/java/edu/mayo/bmi/dictionarytools/CreateLuceneIndexForSnomedLikeSample.java
 
-Note: To view the contents of a Lucene index, you could use a tool such as Luke.
-
-#######################################
-Creating your own dictionaries
-#######################################
-
-Note: To view the contents of a Lucene index, you could use a tool such as Luke.
-
-%%%%%%%%%%%%%%%%%%%%%
-Drugs 
+#### Creating your own dictionaries
 
 To create a more complete dictionary of drug concepts, you could download a copy of the UMLS 
 Metathesaurus and build upon the program mentioned above to create a lucene index of the 
-complete RxNorm or another source of drug concepts.
-
+complete RxNorm or another source of drug concepts.  
 Or you could use a different program in that same package that reads from a pipe-delimited file:
-scripts/java/edu/mayo/bmi/dictionarytools/CreateLuceneIndexFromDelimitedFile
-
-The pipe-delimited file should contain lines in the following format.
-CUI|drug name aka description|terminology aka source|codeInThatSource|PreferredIndicator|TUI
-Where PreferredIndicator = P if the name is the preferred name for the drug.
-
+scripts/java/edu/mayo/bmi/dictionarytools/CreateLuceneIndexFromDelimitedFile  
+The pipe-delimited file should contain lines in the following format.   
+CUI|drug name aka description|terminology aka source|codeInThatSource|PreferredIndicator|TUI  
+Where PreferredIndicator = P if the name is the preferred name for the drug.  
 For example, if you want include terms from semantic type "Biomedical or Dental Material" (TUI T122), 
-one line in the file you create should be:
-C1154185|Topical Spray|RXNORM|346165|P|T122
-
+one line in the file you create should be:  
+C1154185|Topical Spray|RXNORM|346165|P|T122  
 The CreateLuceneIndexFromDelimitedFile class could then be used to create a lucene index from the 
 data in the file.
 
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-Anatomical sites, procedures, signs/symptoms, diseases/disorders
-
 To create a more complete dictionary of anatomical sites, procedures, signs/symptoms,
 and/or diseases/disorders, you could download a copy of the UMLS Metathesaurus and build 
 upon (add code to) the CreateLuceneIndexForSnomedLikeSample class to create 2 lucene 
@@ -154,33 +89,20 @@ Alternatively you could create and populate a database with the following two ta
       with columns "fword"  "cui"  "tui"  "text"
   umls_snomed_map
       with columns "cui"  "code"
- 
 
-################################################
-Configuring the annotator to use your dictionary
-################################################
+#### Configuring the annotator to use your dictionary
 
 These steps are not necessary in order to run the pipeline with the very small sample dictionaries
-that are included with this project.
-
+that are included with this project.  
 If you created your own dictionary(s) as outlined above, here is how you could configure this
-annotator to use your dictionary(s).
-
-%%%%%%%%%%%%%%%%%%%%%
-Drugs 
-
+annotator to use your dictionary(s).  
 If you created a lucene index directory called drug_index, within descriptor DictionaryLookupAnnotator.xml  
 you could update the value of the IndexDirectory for external resource RxnormIndex to reference the location 
 of your drug_index directory.  Recall you need to use a text editor or you need to be on tab Source 
-to edit this portion of that descriptor since it is within a configurableDataResourceSpecifier.
-
+to edit this portion of that descriptor since it is within a configurableDataResourceSpecifier.   
 Alternatively, you could simply replace the contents of directory
 dictionary lookup/resources/lookup/drug_index
-with the contents of the lucene index directory you created.
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-Anatomical sites, procedures, signs/symptoms, diseases/disorders
-
+with the contents of the lucene index directory you created.  
 If you created 2 lucene index directories using CreateLuceneIndexForSnomedLikeSample.java,
 you could simply replace the contents of the two directories
 dictionary lookup/resources/lookup/snomed-like_sample
@@ -200,44 +122,4 @@ outlined above, you could do the following steps
     2b) Password
     2c) DriverClassName
     2d) URL
-
-
-#######################################
-Running the analysis engine (annotator)
-#######################################
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%
-AggregateAE.xml
-
-The file desc/analysis_engine/AggregateAE.xml defines a "pipeline" for 
-testing the installation of the PEAR file for this annotator.
-
-This descriptor is typically not used in a more complete pipeline - one of the 
-DictionaryLookupannotator*.xml descriptors is normally included in a more complete pipeline.
-
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-DictionaryLookupAnnotator.xml
-
-Open this descriptor in the Component Descriptor editor, and view the Resources tab
-to see that there are three Lucene indexes used by this analysis engine.
-Unlike most resources, these cannot be edited from this tab.  Open the Source tab
-to view the configurationParameterSettings.  There are three IndexDirectory entries, 
-whose values give the path to the directory for the lucene index.
-
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-DictionaryLookupannotatorCSV.xml
-
-This is an example of how to use a dictionary contained in a delimited file rather 
-than a database or a lucene index.
-This is only recommended for small dictionaries.
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-DictionaryLookupannotatorDB.xml
-
-This is a skeleton of how you could use a dictionary contained in a database that
-can be accessed via a jdbc driver instead of using a lucene index or flatfile.
-
-
-
+</details>
diff --git a/ctakes-distribution/README.md b/ctakes-distribution/README.md
new file mode 100644
index 0000000..c57452b
--- /dev/null
+++ b/ctakes-distribution/README.md
@@ -0,0 +1,9 @@
+Builds a binary installation of the cTAKES application.
+The installation is placed in a zip file in the ```target/``` directory. 
+The scripts in the ```bin/``` directory are meant to be run from within a binary installation. 
+They will not work in the source project.  
+To use these scripts, build a binary installation by running
+>  mvn package
+
+and then unzip the ```apache-ctakes-*-bin.zip``` or ```apache-ctakes-*.tar.z``` file in the ```ctakes-distribution/target/``` 
+directory into a new directory that is _not_ within the cTAKES source directories.
\ No newline at end of file
diff --git a/ctakes-drug-ner/README b/ctakes-drug-ner/README
deleted file mode 100644
index 35897de..0000000
--- a/ctakes-drug-ner/README
+++ /dev/null
@@ -1,105 +0,0 @@
-Contents
-- Introduction
-- Running the Drug NER pipeline 
-	- AggregateTAE.xml  for CDA documents conforming to the provided DTD.
-	- AggregatePlaintextProcessor.xml  for plaintext documents.
-- Fixes
-	- Version 1.2.1
- 
-############
-Introduction
-############
-
-This project adds the ability to identify attributes of  drug mentions such as Dosage, Frequency, Frequency Unit, 
-Route and Strength from either plaintext or CDA documents. It also provides the ability to specify which sections 
-of a note contain drugs in a list format versus drug mentions within the narrative of the note. This allows for 
-customized processing done on different sections and generally improves the quality of the annotations. 
-This project utilizes various cTAKES components and hence requires cTAKES to be installed prior to using this component.
-
-
-############################################################################
-Running the ctakes-clinical-pipeline
-############################################################################
-
-This project (or PEAR file), the "Drug NER", relies on other projects/PEAR files such as 
-'ctakes-clinical-pipeline', 'context dependent tokenizer', 'core', 'dictionary lookup',
-'LVG' and 'NE contexts'.
-
-
-The pipeline can process two types of documents
- - plaintext files
- - Clinical Document Architecture (CDA) XML files that conform to the DTD provided 
-   
-
-%%%%%%%%%%%%%%%%%%%%%%%%%
-AggregateTAE.xml  for CDA documents conforming to the provided DTD.
-
-The file desc/analysis_engine/AggregateTAE.xml is the aggregate
-analysis engine to use to run the entire pipeline, including the 
-CdaCasInitialzer analysis engine, which reads CDA documents that conform
-to the DTD provided, and create Segment annotations based on the sections
-within the CDA document.
-
-Open this file using the Component Descriptor Editor as described in the tutorial.
-Click on the tab labeled "Aggregate" to observe that the Component Engine Flow (pipeline) 
-defined by this descriptor includes CdaCasInitialzer as the first component.
-Observe that part of speech tagging (POSTagger) comes before chunking (Chunker), etc.
- 
-Click on the tab labeled "Parameter Settings" to view the parameters set in this
-descriptor.  The 'medicationRelatedSection' is *not* set (generally set to 
-20104, 20133, 20147 for Mayo Corpus) in the default implementation. If this parameter is left blank, 
-all sections will be treated as narrative sections and if these sections do contain Drugs in list format 
-the accuracy for identifying Drug mentions and its attributes may not be acceptable. 
-It is recommended to specify section ids that contain drugs in a list format if 
-such sections are available.
-
-Another parameter that relates to aforementioned 'medicationRelatedSection' is 'sectionOverrideSet'.
-This parameter specifies the section ids where DrugLookupWindow annotations will span the complete
-span of text of the specified section. The 'sectionOverrideSet' is *not* set (generally set to 
-20104, 20133, 20147 for Mayo Corpus) in the default implementation. If this parameter is left blank, 
-all sections will be treated as narrative sections and if these sections do contain Drugs in list format 
-the accuracy for identifying Drug mentions and its attributes may not be acceptable. 
-It is recommended to specify section ids that contain drugs in a list format if 
-such sections are available.
-
-If you are not planning to use CDA documents as input, but rather plain text documents, and you 
-prefer the entire document's contents be handled as lists, rather than narrative, then 'SIMPLE_SEGMENT'
-can be entered into the 'medicationRelatedSection' or 'sectionOverrideSet' (see the tutorial for 
-additional information on adding the 'SIMPLE_SEGMENT' to the Compenent Engine Flow (pipeline)).
-
-The parameters are:
-DrugMentionAnnotator.xml
-- medicationRelatedSection -  IDs of sections generated by your Segment Annotator where
-                              drug mentions appear in a list format.
-
-DrugCNP2LookupWindow.xml
-- sectionOverrideSet - IDs of sections (or segments) where the complete section will be treated
-                       as DrugLookupWindow which is designed to process medications or drugs in
-                       'list format'.
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-AggregatePlaintextProcessor.xml  for plaintext documents.
-
-The file desc/analysis_engine/AggregatePlaintextProcessor.xml is the aggregate
-analysis engine to use to run the entire pipeline, including the 
-SimpleSegmentAnnotator analysis engine, which creates a Segment annotation that
-wraps the entire plaintext document.  Other annotators in the pipeline require
-at least 1 Segment annotation.
-
-Click on the tab labeled "Parameter Settings" to view the parameters set in this
-descriptor.  The 'medicationRelatedSection' is set to 20104, 20133, 20147. These
-are section ids specific to Mayo's CDA documents. These section ids must be changed 
-to match the ids generated by your Segment Annotator. 
-
-The parameters are:
-- SegmentID - the identifier or name to assign to the Segment annotation 
-- medicationRelatedSection -  IDs of sections generated by your Segment Annotator where
-                              drug mentions appear in a list format.
-
-############
-Fixes
-############
-
-Version 1.2.1 - 
-	- Fix problem where drug mentions are not aligned correctly with named entity parent
-	- Fix issue where drug change status increase/decrease/change not correctly creating a noChange mention and/or assigned incorrect attributes.    
\ No newline at end of file
diff --git a/ctakes-drug-ner/README.md b/ctakes-drug-ner/README.md
new file mode 100644
index 0000000..191b4be
--- /dev/null
+++ b/ctakes-drug-ner/README.md
@@ -0,0 +1,5 @@
+Can identify attributes of  drug mentions such as Dosage, Frequency, Frequency Unit, Route and Strength 
+from either plaintext or CDA documents. 
+It also provides the ability to specify which sections of a note contain drugs in a list format versus drug mentions 
+within the narrative of the note.
+This allows for customized processing done on different sections and generally improves the quality of the annotations.
diff --git a/ctakes-examples/src/main/java/org/apache/ctakes/examples/pipeline/HelloWorldAggregatePipeline.java b/ctakes-examples/src/main/java/org/apache/ctakes/examples/pipeline/HelloWorldAggregatePipeline.java
deleted file mode 100644
index c950f51..0000000
--- a/ctakes-examples/src/main/java/org/apache/ctakes/examples/pipeline/HelloWorldAggregatePipeline.java
+++ /dev/null
@@ -1,58 +0,0 @@
-package org.apache.ctakes.examples.pipeline;
-
-import org.apache.ctakes.clinicalpipeline.ClinicalPipelineFactory;
-import org.apache.ctakes.examples.ae.ConfigParameterExample;
-import org.apache.ctakes.typesystem.type.textsem.IdentifiedAnnotation;
-import org.apache.uima.fit.factory.AggregateBuilder;
-import org.apache.uima.fit.factory.JCasFactory;
-import org.apache.uima.fit.pipeline.SimplePipeline;
-import org.apache.uima.fit.util.JCasUtil;
-import org.apache.uima.jcas.JCas;
-
-import java.io.FileWriter;
-
-/**
- * Build and run a pipeline using uimafit {@link AggregateBuilder}, {@link SimplePipeline} and {@link JCasUtil}
- * <p>
- * Example of a running a pipeline programatically w/o uima xml descriptor xml files
- * Adds the default Tokenization pipeline and adding the Example HelloWorld Annotator
- */
-
-public class HelloWorldAggregatePipeline {
-
-
-   public static void main( String[] args ) throws Exception {
-
-      String note = "Hello World!";
-      JCas jcas = JCasFactory.createJCas();
-      jcas.setDocumentText( note );
-
-      AggregateBuilder builder = new AggregateBuilder();
-      // Get a simple pre-defined existing pipeline for Tokenization
-
-      // You can consider using ClinicalPipelineFactory.getDefaultPipeline();
-      // Which will include the UMLS Lookup, but you'll need to set your
-      // -Dctakes.umlsuser and -Dctakes.umlspw in your environment
-      builder.add( ClinicalPipelineFactory.getTokenProcessingPipeline() );
-
-      //Add the new HelloWorld Example:
-      builder.add( ConfigParameterExample.createAnnotatorDescription() );
-
-      //Run the Aggregate Pipeline
-      SimplePipeline.runPipeline( jcas, builder.createAggregateDescription() );
-
-      //Print out the IdentifiedAnnotation objects
-      for ( IdentifiedAnnotation entity : JCasUtil.select( jcas, IdentifiedAnnotation.class ) ) {
-         System.out.println( "Entity: " + entity.getCoveredText() + " === Polarity: " + entity.getPolarity() );
-      }
-
-      //Example to save the Aggregate descriptor to an xml file for external
-      //use such as the UIMA CVD/CPE
-      if ( args.length > 0 ) {
-         builder.createAggregateDescription().toXML( new FileWriter( args[ 0 ] ) );
-      }
-   }
-
-}
-
-
diff --git a/ctakes-examples/src/main/java/org/apache/ctakes/examples/pipeline/HelloWorldBuilderRunner.java b/ctakes-examples/src/main/java/org/apache/ctakes/examples/pipeline/HelloWorldBuilderRunner.java
index 9de7347..11eb3c8 100644
--- a/ctakes-examples/src/main/java/org/apache/ctakes/examples/pipeline/HelloWorldBuilderRunner.java
+++ b/ctakes-examples/src/main/java/org/apache/ctakes/examples/pipeline/HelloWorldBuilderRunner.java
@@ -40,7 +40,6 @@ final public class HelloWorldBuilderRunner {
          PipelineBuilder builder = new PipelineBuilder();
          builder
                // Add a simple pre-defined existing pipeline for Tokenization.
-               // Equivalent of ClinicalPipelineFactory.getTokenProcessingPipeline()
                .add( SimpleSegmentAnnotator.class )
                .add( SentenceDetector.class )
                .add( TokenizerAnnotatorPTB.class )
diff --git a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/AdvancedClinicalToFhir.piper b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/AdvancedClinicalToFhir.piper
index e139ba8..c98dc0e 100644
--- a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/AdvancedClinicalToFhir.piper
+++ b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/AdvancedClinicalToFhir.piper
@@ -1,3 +1,4 @@
+// Pipeline that has a lot of annotation engines and writes files in FHIR format.
 
 load SectionedRelationTemporalPipeline
 
diff --git a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/ApacheConDemo.piper b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/ApacheConDemo.piper
index 9b35a8e..365950a 100644
--- a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/ApacheConDemo.piper
+++ b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/ApacheConDemo.piper
@@ -1,4 +1,6 @@
-// Run using -p ApacheConDemo -i org/apache/ctakes/examples/notes/apache_con -o {your output directory}
+// Demo pipeline for case-sensitive dictionary lookup with custom reader.
+
+// Run using -p ApacheConDemo -i org/apache/ctakes/examples/notes/apache_con -o (your output directory)
 
 // Use our simple extension of AbstractFileTreeReader.
 reader ApacheConDemoReader
diff --git a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/ApacheConDemoBasic.piper b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/ApacheConDemoBasic.piper
index 9eb49fc..5d35e31 100644
--- a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/ApacheConDemoBasic.piper
+++ b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/ApacheConDemoBasic.piper
@@ -1,8 +1,9 @@
+// Demo pipeline with a simple custom reader, custom annotation engine and custom writer.
 
 // Run using command line parameters
 // -p ApacheConDemoBasic
 // -i org/apache/ctakes/examples/notes/apache_con/Patient123
-// -o {your output directory}
+// -o (your output directory)
 
 // Use our simple extension of AbstractFileTreeReader.
 reader ApacheConDemoReader
diff --git a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/ApacheConDemoRelation.piper b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/ApacheConDemoRelation.piper
index 8310a73..9adfc74 100644
--- a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/ApacheConDemoRelation.piper
+++ b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/ApacheConDemoRelation.piper
@@ -1,3 +1,5 @@
+// Demo pipeline with coreference resolution and a custom writer.
+
 // use the standard tokenizer pipeline:
 load DefaultTokenizerPipeline
 
diff --git a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/ApacheConDemoSection.piper b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/ApacheConDemoSection.piper
index c8925bb..a8eb7c9 100644
--- a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/ApacheConDemoSection.piper
+++ b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/ApacheConDemoSection.piper
@@ -1,3 +1,5 @@
+// Demo pipeline with a custom writer.
+
 // Annotate sections by known regex
 //add BsvRegexSectionizer
 add SimpleSegmentAnnotator
diff --git a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/AssertionDefaults.piper b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/AssertionDefaults.piper
index e6c6903..508b49a 100644
--- a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/AssertionDefaults.piper
+++ b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/AssertionDefaults.piper
@@ -1,4 +1,6 @@
-# Parameters for AssertionAnalysisEngine and ConceptConverterAnalysisEngine
+// Piper file that sets parameters for a pipeline but does not add components.
+
+// Parameters for AssertionAnalysisEngine and ConceptConverterAnalysisEngine
 set assertionModelResource=file:org/apache/ctakes/assertion/models/i2b2.model
 set scopeModelResource=file:org/apache/ctakes/assertion/models/scope.model
 set cueModelResource=file:org/apache/ctakes/assertion/models/cue.model
diff --git a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/BigPipeline.piper b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/BigPipeline.piper
index b086b1d..84369da 100644
--- a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/BigPipeline.piper
+++ b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/BigPipeline.piper
@@ -1,9 +1,4 @@
-
-/////////////////////////////////////////////////////////
-//
 //     An example pipeline that does a lot of stuff.
-//
-/////////////////////////////////////////////////////////
 
 // Write big "Welcome", "Starting", "Finished" Banners in log.
 set WriteBanner=yes
diff --git a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/Cased2020aa.piper b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/Cased2020aa.piper
index 3df4b84..2fd1953 100644
--- a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/Cased2020aa.piper
+++ b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/Cased2020aa.piper
@@ -1,3 +1,5 @@
+// Demo pipeline for case-sensitive dictionary lookup.
+
 // Load a simple token processing pipeline from another pipeline file
 load DefaultTokenizerPipeline
 
diff --git a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/FhirToOutput.piper b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/FhirToOutput.piper
index cce8cde..70f5d18 100644
--- a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/FhirToOutput.piper
+++ b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/FhirToOutput.piper
@@ -1,3 +1,4 @@
+// Pipeline that simply reads a FHIR json file and writes a marked-up html file.
 
 package org.apache.ctakes.fhir.cr
 
diff --git a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/HelloWorld.piper b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/HelloWorld.piper
index 5d11772..2360223 100644
--- a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/HelloWorld.piper
+++ b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/HelloWorld.piper
@@ -1,4 +1,4 @@
-// This file contains commands and parameters to run the ctakes-examples "Hello World" pipeline
+// Commands and parameters to run the ctakes-examples "Hello World" pipeline.
 
 // Load a simple token processing pipeline from another pipeline file
 load DefaultTokenizerPipeline.piper
diff --git a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/HelloWorldAssertProps.piper b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/HelloWorldAssertProps.piper
index 3368352..04444fe 100644
--- a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/HelloWorldAssertProps.piper
+++ b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/HelloWorldAssertProps.piper
@@ -1,5 +1,4 @@
-// This file contains commands and parameters to run the ctakes-examples "Hello World" pipeline
-// with Entity Property output
+// Commands and parameters to run the "Hello World" pipeline with Entity Property output.
 
 // Load a simple token processing pipeline from another file
 load org/apache/ctakes/examples/pipeline/HelloWorld.piper
diff --git a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/HelloWorldCui.piper b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/HelloWorldCui.piper
index 7805deb..f867a4b 100644
--- a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/HelloWorldCui.piper
+++ b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/HelloWorldCui.piper
@@ -1,5 +1,4 @@
-// This file contains commands and parameters to run the ctakes-examples "Hello World" pipeline
-// with UMLS Concept Unique Identifiers (CUI) output
+// Commands and parameters to run the "Hello World" pipeline with UMLS Concept Unique Identifiers (CUI) output.
 
 // Load a simple token processing pipeline from another pipeline file
 load org/apache/ctakes/core/pipeline/DefaultTokenizerPipeline.piper
diff --git a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/HelloWorldProps.piper b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/HelloWorldProps.piper
index b762292..fc72783 100644
--- a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/HelloWorldProps.piper
+++ b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/HelloWorldProps.piper
@@ -1,5 +1,4 @@
-// This file contains commands and parameters to run the ctakes-examples "Hello World" pipeline
-// with Entity Property output
+// Commands and parameters to run the "Hello World" pipeline with Entity Property output
 
 // Load a simple token processing pipeline from another file
 load org/apache/ctakes/examples/pipeline/HelloWorld.piper
diff --git a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/HelloWorldTkProps.piper b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/HelloWorldTkProps.piper
index 12c753e..643da1b 100644
--- a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/HelloWorldTkProps.piper
+++ b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/HelloWorldTkProps.piper
@@ -1,5 +1,4 @@
-// This file contains commands and parameters to run the ctakes-examples "Hello World" pipeline
-// with Entity Property output
+// Commands and parameters to run the "Hello World" pipeline with Entity Property output.
 
 // Load a simple token processing pipeline from another file
 load org/apache/ctakes/examples/pipeline/HelloWorld.piper
diff --git a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/PbjSentencePrinter.piper b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/PbjSentencePrinter.piper
index f0d388e..d5fa66f 100644
--- a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/PbjSentencePrinter.piper
+++ b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/PbjSentencePrinter.piper
@@ -1,28 +1,27 @@
-#
-#  This is an example piper file that will spin up a complete pbj pipeline.
-#
-#  This piper will start the Apache Artemis broker pointed to by the -a parameter on the command line.
-#  It will pause for 5 seconds to allow Artemis to fully launch.
-#
-#  This piper will then launch another instance of Apache cTAKES.
-#  That instance of cTAKES will run the third and final bit of the entire PBJ pipeline.
-#
-#  This piper will then launch a python PBJ bit of the entire pipeline.
-#
+// An example piper file that will spin up a complete pbj pipeline.
+//
+//  This piper will start the Apache Artemis broker pointed to by the -a parameter on the command line.
+//  It will pause for 5 seconds to allow Artemis to fully launch.
+//
+//  This piper will then launch another instance of Apache cTAKES.
+//  That instance of cTAKES will run the third and final bit of the entire PBJ pipeline.
+//
+//  This piper will then launch a python PBJ bit of the entire pipeline.
+//
 set SetJavaHome=no
 
-#
-#  To run this pipeline from the command line, use the parameters:
-#  -p SentencePrinter
-#  -v {python environment Directory}
-#  -a {Artemis Broker Directory}
-#  -i {Input Document Directory}
-#  -o {Output Directory}
-#
-#  A standard command-line option is the specification of whether or not to pip the ctakes-pbj package.
-#  By default ctakes-pbj will be pip ed at the beginning of a run.  You can turn this off with:
-#  --pipPbj no
-#
+//
+//  To run this pipeline from the command line, use the parameters:
+//  -p SentencePrinter
+//  -v {python environment Directory}
+//  -a {Artemis Broker Directory}
+//  -i {Input Document Directory}
+//  -o {Output Directory}
+//
+//  A standard command-line option is the specification of whether or not to pip the ctakes-pbj package.
+//  By default ctakes-pbj will be pip ed at the beginning of a run.  You can turn this off with:
+//  --pipPbj no
+//
 
 
 //  Sets up required parameters, starts your Artemis Broker, pips the PBJ project.
diff --git a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/PbjThirdStep.piper b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/PbjThirdStep.piper
index 3f203a4..02a4a6d 100644
--- a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/PbjThirdStep.piper
+++ b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/PbjThirdStep.piper
@@ -1,6 +1,5 @@
-#
-#  This piper file just listens to a queue and saves cas information to output files.
-#
+//  This piper file just listens to a queue and saves cas information to output files.
+
 
 // Get cas from Artemis.
 reader PbjReceiver ReceiveQueue=PyToJava
diff --git a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/PbjWordFinder.piper b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/PbjWordFinder.piper
index 9cbfff4..3bf003f 100644
--- a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/PbjWordFinder.piper
+++ b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/PbjWordFinder.piper
@@ -1,28 +1,27 @@
-#
-#  This is an example piper file that will spin up a complete pbj pipeline.
-#
-#  This piper will start the Apache Artemis broker pointed to by the -a parameter on the command line.
-#  It will pause for 5 seconds to allow Artemis to fully launch.
-#
-#  This piper will then launch another instance of Apache cTAKES.
-#  That instance of cTAKES will run the third and final bit of the entire PBJ pipeline.
-#
-#  This piper will then launch a python PBJ bit of the entire pipeline.
-#
+//  This is an example piper file that will spin up a complete pbj pipeline.
+//
+//  This piper will start the Apache Artemis broker pointed to by the -a parameter on the command line.
+//  It will pause for 5 seconds to allow Artemis to fully launch.
+//
+//  This piper will then launch another instance of Apache cTAKES.
+//  That instance of cTAKES will run the third and final bit of the entire PBJ pipeline.
+//
+//  This piper will then launch a python PBJ bit of the entire pipeline.
+//
 set SetJavaHome=no
 
-#
-#  To run this pipeline from the command line, use the parameters:
-#  -p WordFinder
-#  -v {python environment Directory}
-#  -a {Artemis Broker Directory}
-#  -i {Input Document Directory}
-#  -o {Output Directory}
-#
-#  A standard command-line option is the specification of whether or not to pip the ctakes-pbj package.
-#  By default ctakes-pbj will be pip ed at the beginning of a run.  You can turn this off with:
-#  --pipPbj no
-#
+//
+//  To run this pipeline from the command line, use the parameters:
+//  -p WordFinder
+//  -v {python environment Directory}
+//  -a {Artemis Broker Directory}
+//  -i {Input Document Directory}
+//  -o {Output Directory}
+//
+//  A standard command-line option is the specification of whether or not to pip the ctakes-pbj package.
+//  By default ctakes-pbj will be pip ed at the beginning of a run.  You can turn this off with:
+//  --pipPbj no
+//
 
 
 //  Sets up required parameters, starts your Artemis Broker, pips the PBJ project.
diff --git a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/PbjWordFinderInOne.piper b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/PbjWordFinderInOne.piper
index 070c55e..0efa597 100644
--- a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/PbjWordFinderInOne.piper
+++ b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/PbjWordFinderInOne.piper
@@ -1,25 +1,24 @@
-#
-#  This is an example piper file that will spin up a complete pbj pipeline.
-#
-#  This piper will start the Apache Artemis broker pointed to by the -a parameter on the command line.
-#  It will pause for 5 seconds to allow Artemis to fully launch.
-#
-#  This piper will then launch a python PBJ bit of the entire pipeline.
-#
+//  This is an example piper file that will spin up a complete pbj pipeline.
+//
+//  This piper will start the Apache Artemis broker pointed to by the -a parameter on the command line.
+//  It will pause for 5 seconds to allow Artemis to fully launch.
+//
+//  This piper will then launch a python PBJ bit of the entire pipeline.
+//
 set SetJavaHome=no
 
-#
-#  To run this pipeline from the command line, use the parameters:
-#  -p WordFinder
-#  -v {python environment Directory}
-#  -a {Artemis Broker Directory}
-#  -i {Input Document Directory}
-#  -o {Output Directory}
-#
-#  A standard command-line option is the specification of whether or not to pip the ctakes-pbj package.
-#  By default ctakes-pbj will be pip ed at the beginning of a run.  You can turn this off with:
-#  --pipPbj no
-#
+//
+//  To run this pipeline from the command line, use the parameters:
+//  -p WordFinder
+//  -v {python environment Directory}
+//  -a {Artemis Broker Directory}
+//  -i {Input Document Directory}
+//  -o {Output Directory}
+//
+//  A standard command-line option is the specification of whether or not to pip the ctakes-pbj package.
+//  By default ctakes-pbj will be pip ed at the beginning of a run.  You can turn this off with:
+//  --pipPbj no
+//
 
 
 //  Sets up required parameters, starts your Artemis Broker, pips the PBJ project.
diff --git a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/ProcessDir.piper b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/ProcessDir.piper
index 00c6137..373ddb2 100644
--- a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/ProcessDir.piper
+++ b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/ProcessDir.piper
@@ -1,5 +1,4 @@
-// This file contains commands and parameters to run the ctakes-examples "Hello World" pipeline
-// with Entity Property output
+// Commands and parameters to run the "Hello World" pipeline with Entity Property output.
 
 readFiles org/apache/ctakes/examples/notes
 
diff --git a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/ThreadSafeFullPipeline.piper b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/ThreadSafeFullPipeline.piper
index 6d2af99..7a0d16e 100644
--- a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/ThreadSafeFullPipeline.piper
+++ b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/ThreadSafeFullPipeline.piper
@@ -1,4 +1,4 @@
-// Pipeline for: sections, paragraphs, sentences, lists, entities and attributes, relations, temporal info, coreferences
+// Pipeline for: sections, paragraphs, sentences, lists, entities and attributes, relations, temporal info, coreferences.
 
 // set the thread count
 threads 3
diff --git a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/XmiToPretty.piper b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/XmiToPretty.piper
index 89c8bb4..f6171e0 100644
--- a/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/XmiToPretty.piper
+++ b/ctakes-examples/src/user/resources/org/apache/ctakes/examples/pipeline/XmiToPretty.piper
@@ -1,3 +1,5 @@
+// Pipeline with an XMI reader component to feed ctakes XMI files as input instead of plain text files.
+
 // Read XMI File using -i from the command line to specify input file
 reader XmiTreeReader
 
diff --git a/ctakes-gui/src/main/java/org/apache/ctakes/gui/pipeline/bit/parameter/DefaultParameterHolder.java b/ctakes-gui/src/main/java/org/apache/ctakes/gui/pipeline/bit/parameter/DefaultParameterHolder.java
index eef09bd..7cb314a 100644
--- a/ctakes-gui/src/main/java/org/apache/ctakes/gui/pipeline/bit/parameter/DefaultParameterHolder.java
+++ b/ctakes-gui/src/main/java/org/apache/ctakes/gui/pipeline/bit/parameter/DefaultParameterHolder.java
@@ -6,6 +6,7 @@ import org.apache.uima.fit.descriptor.ConfigurationParameter;
 
 import javax.annotation.concurrent.Immutable;
 import java.util.ArrayList;
+import java.util.Comparator;
 import java.util.List;
 import java.util.Map;
 
@@ -28,7 +29,7 @@ final public class DefaultParameterHolder implements ParameterHolder {
    public DefaultParameterHolder( final Class<?> pipeBitClass ) {
       _typeMap = ParameterMapper.createParameterTypeMap( pipeBitClass );
       _parameters = new ArrayList<>( _typeMap.keySet() );
-      _parameters.sort( ( p1, p2 ) -> p1.name().compareToIgnoreCase( p2.name() ) );
+      _parameters.sort( new ParamComparator() );
    }
 
    /**
@@ -87,4 +88,15 @@ final public class DefaultParameterHolder implements ParameterHolder {
       return _parameters.get( index ).defaultValue();
    }
 
+   static private final class ParamComparator implements Comparator<ConfigurationParameter>  {
+      @Override
+      public int compare( final ConfigurationParameter param1, final ConfigurationParameter param2 ) {
+         if ( param1.mandatory() == param2.mandatory() ) {
+            return String.CASE_INSENSITIVE_ORDER.compare( param1.name(), param2.name() );
+         }
+         return param1.mandatory() ? -1 : 1;
+      }
+   }
+
+
 }
diff --git a/ctakes-lvg/README b/ctakes-lvg/README
index 0431e33..5f70162 100644
--- a/ctakes-lvg/README
+++ b/ctakes-lvg/README
@@ -1,3 +1,6 @@
+# This module has been deprecated.  It is much faster to precompute lexical variants for your dictionary.
+
+
 
 Contents
 - Introduction
diff --git a/ctakes-ne-contexts/README b/ctakes-ne-contexts/README
deleted file mode 100644
index 459a497..0000000
--- a/ctakes-ne-contexts/README
+++ /dev/null
@@ -1,95 +0,0 @@
-
-Contents
-- Introduction
-- Negation Annotator
-	- NegationAnnotator.xml
-	- updating negex patterns
-- Status Annotator 
-
-############
-Introduction
-############
-
-The context annotator provides a mechanism for examining the context of existing annotations, finding 
-events of interest in the context, and acting on those events in some way.  The negation and status 
-annotators both take advantage of this infrastructure by examining the context of named entities 
-(e.g. disorders and findings) to see if they should be considered as negated (e.g. "no chest pain") 
-or if their status should be modified (e.g. "myocardial infarction" should have status "history of").  
-
-In fact, the "negation annotator" is really just the context annotator configured to deal with negations.  
-
-Similarly, the "status annotator" is the context annotator configured to identify the status of named entities.  
-
-To better understand the context annotator code you should start by reading the javadocs for the class 
-org.apache.ctakes.necontexts.ContextAnnotator.java.  It provides a nice conceptual overview of how the code works.  
-
-##################
-Negation Annotator
-##################
-What follows is an explanation of how negation is performed using the context annotator.  
-
-The negation detection annotator is a pattern-based (no maxent models required/used) approach that uses 
-finite state machines and is roughly based on the popular Negex algorithm introduced by Wendy Chapman.  
-
-%%%%%%%%%%%%%%%%%%%%%
-NegationAnnotator.xml
-
-We will start by examining the descriptor file desc/NegationAnnotator.xml.  Open this file with the Component 
-Descriptor Editor.  Select the first tab labeled "Overview" and observe that the analysis engine that is 
-specified is org.apache.ctakes.necontexts.ContextAnnotator.  There is no "negation annotator" analysis 
-engine - we simply configure the ContextAnnotator for the task.  Next select the tab labeled "Parameter Settings".
-
-We will discuss each setting in turn:
- 
- - MaxLeftScopeSize = 10
-   The maximum number of annotations that will make up the left-hand side context is ten.  
-   Increase or decrease this parameter setting to increase or decrease the left hand side context.
- - MaxRightScopeSize = 10
-   The maximum number of annotations that will make up the right-hand side context is ten.  
-   Increase or decrease this parameter setting to increase or decrease the right-hand side context.
- - ScopeOrder = LEFT, RIGHT
-   The context annotator will look for signs of negation on the left-hand side of a named entity first and then 
-   the right-hand side.
- - ContextAnalyzerClass = org.apache.ctakes.necontexts.negation.NegationContextAnalyzer 
-   The context analyzer looks at the context (e.g. the 10 words on the left or right of the named entity) and 
-   determines if the named entity should be negated.  If it should, then the negation context analyzer will 
-   generate a context hit to be consumed by the context hit consumer (see below.)
- - ContextHitConsumerClass = org.apache.ctakes.necontexts.negation.NegationContextHitConsumer
-   The context hit consumer handles context hits generated by the context analyzer.  In this case, the negation 
-   context hit consumer simply sets the certainty of a named entity to -1 which indicates that it has been negated.
- - WindowAnnotationClass = edu.mayo.bmi.uima.common.type.Sentence
-   When the context annotator collects the context annotations for a named entity, it will not look beyond the 
-   boundaries of the sentence that the named entity is found in.
- - FocusAnnotationClass = edu.mayo.bmi.uima.common.type.NamedEntity
-   The negation annotator is concerned with negating named entities and thus the focus annotation type 
-   (the annotations for which a context is generated and examined) specifies named entities.
- - ContextAnnotationClass = edu.mayo.bmi.uima.common.type.BaseToken
-   The context of the named entities is a list of tokens - this is what the context analyzer is going to examine.  
-
-So, the work of negating a named entity is done by 
- 1) finding negations by the NegationContextAnalyzer 
- 2) updating the status of NamedEntities by the NegationContextHitConsumer.  
- 
-The former is a pretty lightweight wrapper around another class which has all of the negation pattern finding 
-logic - org.apache.ctakes.core.fsm.machine.NegationFSM.  If you want to update the pattern matching of negation detection, 
-then you would have to do it in that class.  
-
-%%%%%%%%%%%%%%%%%%%%%%%
-updating negex patterns
-
-Updating the negation detection patterns will involve either 1) trial and error experimentation or 2) understanding how
-the the NegationFSM works.  The rules, patterns, words that identify negation are hard-coded into the class 
-org.apache.ctakes.core.fsm.machine.NegationFSM which is found in the core project.  I would suggest starting off with the 
-trial-and-error approach.  For example, if you wanted to add "impossible" to the lexicon of negation words, 
-then you could try adding it to the the _negAdjectivesSet and test the behavior.  
-
-
-################
-Status Annotator
-################
-
-The way the status annotator works mirrors very closely how the negation annotator works.  
-You are encouraged to read the above section, examine the parameter settings given for desc/StatusAnnotator.xml, 
-and look at org.apache.ctakes.core.fsm.machine.StatusIndicatorFSM.  
-
-
diff --git a/ctakes-ne-contexts/README.md b/ctakes-ne-contexts/README.md
new file mode 100644
index 0000000..f1f0cb0
--- /dev/null
+++ b/ctakes-ne-contexts/README.md
@@ -0,0 +1,9 @@
+The context annotator provides a mechanism for examining the context of existing annotations, finding 
+events of interest in the context, and acting on those events in some way.  The negation and status 
+annotators both take advantage of this infrastructure by examining the context of named entities 
+(e.g. disorders and findings) to see if they should be considered as negated (e.g. "no chest pain") 
+or if their status should be modified (e.g. "myocardial infarction" should have status "history of").
+In fact, the "negation annotator" is really just the context annotator configured to deal with negations.
+Similarly, the "status annotator" is the context annotator configured to identify the status of named entities.  
+To better understand the context annotator code you should start by reading the javadocs for the class 
+```org.apache.ctakes.necontexts.ContextAnnotator.java```.  It provides a nice conceptual overview of how the code works.  
diff --git a/ctakes-ne-contexts/src/user/resources/org/apache/ctakes/ne/contexts/pipeline/NeContextsSubPipe.piper b/ctakes-ne-contexts/src/user/resources/org/apache/ctakes/ne/contexts/pipeline/NeContextsSubPipe.piper
index 0925cf9..9d5372f 100644
--- a/ctakes-ne-contexts/src/user/resources/org/apache/ctakes/ne/contexts/pipeline/NeContextsSubPipe.piper
+++ b/ctakes-ne-contexts/src/user/resources/org/apache/ctakes/ne/contexts/pipeline/NeContextsSubPipe.piper
@@ -1,4 +1,5 @@
-// Commands and parameters to create a default entity attributes processing sub-pipeline.  This is not a full pipeline.
+// Partial pipeline to add assertion (e.g. negation, uncertainty) attributes based upon context.
+//  This is not a full pipeline.
 
 // Add the context annotator for simple annotation properties
 // The default call sets it to detect negation
diff --git a/ctakes-pbj/README.md b/ctakes-pbj/README.md
index 0cc4639..ca1b542 100644
--- a/ctakes-pbj/README.md
+++ b/ctakes-pbj/README.md
@@ -1,138 +1,40 @@
-# cTAKES Installation Instructions:
+A Python Bridge to Java (PBJ). 
+<details>
+<summary>Problem Statement</summary>
+Solutions start with identifying the problem. 
+Our problem is the lack of a standardized path to move information from cTAKES to a python program (and back again).
+Having that ability is very important as most modern Machine Learning is done in Python.
+</details>
 
-### Windows
--install tortoiseSVN https://tortoisesvn.net/downloads.html  <br/>
--Make sure to check "command line client tools" when downloading tortoiseSVN<br/>
--Once tortoiseSVN is downloaded, open IntelliJ settings, go to the Version control tab on the left hand side. Select the subversion tab, then in the "path to Subversion executable" field fill in : `C:\Program Files\TortoiseSVN\bin\svn.exe` <br/>
--Download ctakes project using the `get from VCS` button on the "Welcome to IntelliJ" page.
--Select the svn option from the Version Control dropdown and add https://svn.apache.org/repos/asf/ctakes/trunk/ then checkout<br/> 
--Select the 1.8 working format of cTakes <br/>
--Go back to the "Welcome to IntelliJ" page and use the `get from VCS` button again, this time we want to use git. <br/>
--Copy this link "https://github.com/Johnsd11/ctakes-pbj-v-1.0" and then save the repo in cTakes under the folder "ctakes-pbj" <br/>
+<details>
+<summary>Solution</summary>
+The information that we want to move is stored in an object called a CAS (Common Analysis System). 
+All objects within the CAS are of a Type defined in an extensible Type System. 
+For instance a discovered instance of "cancer" is stored in the CAS as an object of Type "DiseaseOrderMention".  
 
+The next step was for us to choose a method of delivery for our path of information.
+We were looking for something that could handle multiple sub-pipelines, allow for parallel sub-pipelines, 
+and a method that is fast, reusable, and easy to use.  
 
-### Mac and Linux
--Install Subversion using homebrew then type the command `brew install subversion`(for mac and linux) <br/>
--Download ctakes project using the `get from VCS` button on the "Welcome to IntelliJ" page.
--Select the svn option from the Version Control dropdown and add https://svn.apache.org/repos/asf/ctakes/trunk/ then checkout<br/> 
--Select the 1.8 working format of cTakes <br/>
--Go back to the "Welcome to IntelliJ" page and use the `get from VCS` button again, this time we want to use git. <br/>
--Copy this link "https://github.com/Johnsd11/Ctakes_PBJ" and then save the repo in cTakes under the folder "ctakes-pbj" <br/>
+[Apache ActiveMQ](https://activemq.apache.org/components/artemis/) Message Broker combined with
+[dkpro-cassis](https://github.com/dkpro/dkpro-cassis) became apparent as the ideal solution to our problem, 
+allowing what we hoped for above and more.
+</details>
 
+<details>
+<summary>How it Works</summary>
 
-### Windows
--install maven using a package manager: chocolatey<br/>
-https://www.how2shout.com/how-to/download-and-install-maven-on-windows-10-or-11-via-command-line.html<br/>
+![](images/step_1.png)
 
+![](images/step_2.png)
 
-### Mac and Linux
--install maven using brew : `brew install maven` <br/>
+![](images/step_3.png)
 
----
+![](images/step_4.png)
+</details>
 
--Search for and open `pom.xml` for ctakes trunk<br/>
-    - Once in the file scroll down until you come across the `<modules>` list<br/>
-    - add this line `<module>ctakes-pbj</module>` anywhere on the list<br/>
-    - Next look for the `<dependency>` list<br/>
-    - add these lines <br/>
-    `<dependency>` <br/>
-         `<groupId>org.apache.ctakes</groupId>`<br/> 
-         `<artifactId>ctakes-pbj</artifactId>`<br/>
-         `<version>${project.version}</version>`<br/>
-    `</dependency>`<br/>
--Next open the maven tab on the top right of the intellij window, click Apache cTAKES, Lifecycle, install<br/>
--After this step, the ctakes-pbj directory will appear to have a blue square on it in the left hand side of IntelliJ that displays project structure.
+<details>
+<summary>Other Configurations</summary>
 
-
-
-### Configurations
--add python plugin from the IntelliJ plugins store <br/>
--Set Project SDK: corretto-1.8<br/>
--Set Project language level: SDK default (8)<br/>
--install the latest version of java<br/>
--open Project Structure, navigate to modules tab on the left side, find ctakes-pbj, click on it and then press the plus sign and add python 3.8 to it<br/>
--**IMPORTANT:** You need to make sure that you follow the step above first before you mark the python and java directories as source roots. <br/>
--Make sure to mark the ctakes-pbj/src/main/python and ctakes-pbj/src/main/java directories as a source roots <br/>
-  
-
- # Artemis Instructions For making a Broker:
--First download ActiveMQ Artemis here: https://activemq.apache.org/components/artemis/download/<br/>
--Naviagate to the downloaded apache-artemis folder in your command line<br/>
--from there cd into bin, then while in bin, type "./artemis create mybroker" for MAC or for windows "artemis create mybroker"<br/>
--This will prompt a Username and Password which can be anything you want<br/>
--It will also prompt something called `--allow-anonymous`, Press `Y` <br/>
--From here you can now cd into mybroker/bin<br/>
--Once you are in bin again you can run "./artemis run" for MAC or "artemis run" for windows to start the broker<br/>
--Here are more directions if you need more help or clarification<br/>
--https://activemq.apache.org/components/artemis/documentation/1.0.0/running-server.html<br/>
-  
-# Running an Example
--You can start running an example by creating an application configuration<br/>
--You can call it whatever you want, we called it "StartAllExample"<br/>
--Copy down the information you see in the picture below <br/>
-![step3](https://user-images.githubusercontent.com/34665038/181270724-c1dbc854-397a-4b1f-b5db-e194adf074d5.png)<br/>
--p "org/apache/ctakes/pbj/pipeline/StartAllExample" <br/>
--i "org/apache/ctakes/examples/notes/annotated" <br/>
--a "[Destination of your Artemis Broker]" <br/>
--d "[Destinaiton of your python.exe]" <br/>
-![step1](https://user-images.githubusercontent.com/34665038/181271047-cf112a93-0d8c-4734-aa21-1281377e6762.png)<br/>
-
-## End-to-end PBJ Examples
-### Temporal Example
-- You first need to get the API side up and running. To do this you need to follow the steps listed [here.](https://github.com/Machine-Learning-for-Medical-Language/cnlp_transformers)
-- Once that is running you need to then create this configuration for StartTemporalExample.piper file.<br/>
--p<br/>
-org/apache/ctakes/pbj/pipeline/StartTemporalExample<br/>
--i<br/>
-(input)<br/>
--a<br/>
-(folder where your Artemis broker is)<br/>
--d<br/>
-(enviroment) <br/>
--o<br/>
-(output)<br/>
---key<br/>
-(UMLS key)<br/>
-- You should now be able to run that piper file while the API side is running. You can look at the output of running the piper file in "temporal_py.log" as well
-as the output file that you put into the configuration.<br/>
-
-### Negation Example
-- You first need to get the API side up and running. To do this you need to follow the steps listed [here.](https://github.com/Machine-Learning-for-Medical-Language/cnlp_transformers)
-- Once that is running you need to then create this configuration for StartNegationExample.piper file.<br/>
--p<br/>
-org/apache/ctakes/pbj/pipeline/StartNegationExample<br/>
--i<br/>
-(input)<br/>
--a<br/>
-(folder where your Artemis broker is)<br/>
--d<br/>
-(enviroment) <br/>
--o<br/>
-(output)<br/>
---key<br/>
-(UMLS key)<br/>
-- You should now be able to run that piper file while the API side is running. You can look at the output of running the piper file in "negation_py.log" as well
-as the output file that you put into the configuration.<br/>
-
-### DTR Example
-- You first need to get the API side up and running. To do this you need to follow the steps listed [here.](https://github.com/Machine-Learning-for-Medical-Language/cnlp_transformers)
-- Once that is running you need to then create this configuration for StartDtrExample.piper file.<br/>
--p<br/>
-org/apache/ctakes/pbj/pipeline/StartDtrExample<br/>
--i<br/>
-(input)<br/>
--a<br/>
-(folder where your Artemis broker is)<br/>
--d<br/>
-(enviroment) <br/>
--o<br/>
-(output)<br/>
---key<br/>
-(UMLS key)<br/>
-- You should now be able to run that piper file while the API side is running. You can look at the output of running the piper file in "dtr_py.log" as well
-as the output file that you put into the configuration.<br/>
-
-  
-  
-
-    
+![](images/other_configs.png)
+</details>
diff --git a/ctakes-pbj/src/user/resources/org/apache/ctakes/pbj/pipeline/PbjStarter.piper b/ctakes-pbj/src/user/resources/org/apache/ctakes/pbj/pipeline/PbjStarter.piper
index 774a08a..e34a0e5 100644
--- a/ctakes-pbj/src/user/resources/org/apache/ctakes/pbj/pipeline/PbjStarter.piper
+++ b/ctakes-pbj/src/user/resources/org/apache/ctakes/pbj/pipeline/PbjStarter.piper
@@ -1,16 +1,15 @@
-#
-#  This is a piper file that will perform initial steps required for running a ctakes-pbj pipeline.
-#
-# Add "load PbjStarter" to the beginning of your piper file.
-# 
-#  This piper will start the Apache Artemis broker pointed to by the -a parameter on the command line.
-#  It will pause for 5 seconds to allow artemis to fully launch.
-#
-#  This piper will then pip the python package requirements for ctakes-pbj
-#  in an environment pointed to by the -v parameter on the command line.
-#
-#  To skip the step of runnning a pip of ctakes-pbj, set --pipPbj to "no"
-#
+//  This is a piper file that will perform initial steps required for running a ctakes-pbj pipeline.
+//
+// Add "load PbjStarter" to the beginning of your piper file.
+//
+//  This piper will start the Apache Artemis broker pointed to by the -a parameter on the command line.
+//  It will pause for 5 seconds to allow artemis to fully launch.
+//
+//  This piper will then pip the python package requirements for ctakes-pbj
+//  in an environment pointed to by the -v parameter on the command line.
+//
+//  To skip the step of runnning a pip of ctakes-pbj, set --pipPbj to "no"
+//
 
 // Set the command line parameter -a to accept the directory of the Artemis broker.
 cli ArtemisBroker=a
diff --git a/ctakes-pbj/src/user/resources/org/apache/ctakes/pbj/pipeline/PbjStopper.piper b/ctakes-pbj/src/user/resources/org/apache/ctakes/pbj/pipeline/PbjStopper.piper
index 3a2e20e..a8ffeec 100644
--- a/ctakes-pbj/src/user/resources/org/apache/ctakes/pbj/pipeline/PbjStopper.piper
+++ b/ctakes-pbj/src/user/resources/org/apache/ctakes/pbj/pipeline/PbjStopper.piper
@@ -1,10 +1,9 @@
-#
-#  This is a piper file that will perform final steps required for stopping a ctakes-pbj pipeline.
-#
-# Add "load PbjStopper" to the end of your piper file.
-#
-#  This piper will stop the Apache Artemis broker pointed to by the -a parameter on the command line.
-#
+//  This is a piper file that will perform final steps required for stopping a ctakes-pbj pipeline.
+//
+// Add "load PbjStopper" to the end of your piper file.
+//
+//  This piper will stop the Apache Artemis broker pointed to by the -a parameter on the command line.
+//
 
 // Set the command line parameter -a to accept the directory of the Artemis installation.
 cli ArtemisBroker=a
diff --git a/ctakes-pos-tagger/README b/ctakes-pos-tagger/README
deleted file mode 100644
index 2ff8504..0000000
--- a/ctakes-pos-tagger/README
+++ /dev/null
@@ -1,203 +0,0 @@
-Contents
-- Listing of README's in this project
-- Introduction
-- Building a model
-- Building a tag dictionary
-- Running the POSTagger analysis engine
-	- POSTagger.xml
-	- POSTaggerAggregate.xml
-	- POSTaggerCPE.xml
-- Evaluating a POS tagger
-
-
-###################################
-Listing of README's in this project
-###################################
-
- - data/pos/training/README - describes how to create training data for the 
-                              part-of-speech (POS) tagger.
- - resources/models/README - describes how the pos-tagging models were created
- - test/data/README - describes data used for the unit tests	
-
-
-############
-Introduction
-############
-
-This project provides a UIMA wrapper around the popular OpenNLP part-of-speech 
-tagger. The UIMA examples project provides a default wrapper from which we have 
-borrowed liberally.  We have created our own wrapper so that it will work better
-with our type system and to add features and supporting components.  
-Additionally, both the OpenNLP package and the UIMA examples OpenNLP wrappers 
-lack documentation for how to do things like generate training data, build a 
-part-of-speech tagging model, and build a tag dictionary.  The latter in 
-particular can be very confusing if you are new to OpenNLP.  We have 
-attempted to provide all of the necessary documentation here.
-
-A part-of-speech tagging model is included with this project.
-
-The model derives from a combination of GENIA, Penn Treebank (Wall Street Journal) and anonymized
-clinical data per Safe Harbor HIPAA guidelines. Prior to model building, the clinical data was 
-deidentified for patient names to preserve patient confidentiality. Any person name in the model 
-will originate from non-patient data sources.
- 
-
-################
-Building a model 
-################
-
-If you wish to build your own part-of-speech model that works with the OpenNLP 
-part-of-speech tagger you will need to follow these steps:
-1) obtain training data - see data/pos/training/README
-2) build a model using the training data - see resources/models/README
-
-
-#########################
-Building a tag dictionary 
-#########################
-
-One thing that can be confusing about the OpenNLP part-of-speech tagger is that 
-there are two data structures with similar sounding names - Dictionary and 
-TagDictionary.  In short, the Dictionary construct is one that can and should 
-be ignored while the TagDictionary is one that needs a bit of attention.
-
-A tag dictionary is used when tagging text, not during the training of a POS model.  
-
-Unfortunately, OpenNLP does not provide a mechanism for creating a tag 
-dictionary, so we have provided one.  It can be run with the following command:
-
-java org.apache.ctakes.postagger.TagDictionaryCreator <training-data> 
-                                                        <tag-dictionary> 
-                                                         <case-sensitive>
-														 
-  where <training-data> is a file containing pos-of-speech tagged training data 
-                        as described in data/pos/training/README
-  where <tag-dictionary> is the file that will be created, and where the 
-                         tag dictionary will be written to
-  where <case-sensitive> is either 'true' or 'false' depending on whether the 
-  						 tag dictionary should be case sensitive or not.
-
-For relevant material about the difference between Dictionary and TagDictionary 
-see the following:
-https://sourceforge.net/forum/forum.php?thread_id=1720863&forum_id=9943
-https://sourceforge.net/forum/forum.php?thread_id=1894043&forum_id=9943
-DefaultPOSContextGenerator.getContext(int, Object[], String[])
-
-OpenNLP provides a default tag dictionary for the English part-of-speech model 
-called tag.bin.gz which can be downloaded from:
-http://opennlp.sourceforge.net/models/english/parser/tagdict
-You should use this tag dictionary only if you are using the model from:
-http://opennlp.sourceforge.net/models/english/parser/tag.bin.gz
-
-If we want to use the tag dictionary in a case insensitive way, then entries 
-in the tag dictionary which are not all lowercased will be ignored because 
-the tag dictionary fails to lowercase entries read in from the file.  
-It only lowercases the words that are compared against the dictionary when 
-"CaseSensitive" is set to false.  Therefore, if you want the tag dictionary 
-to be used in a case insensitive way, be sure to build the tag dictionary 
-using 'false' as the third argument (as described above).  
-
-
-#####################################
-Running the POSTagger analysis engine
-#####################################
-
-%%%%%%%%%%%%%
-POSTagger.xml
-
-The file desc/POSTagger.xml provides a descriptor for the POSTagger analysis 
-engine which is the UIMA component we have written that wraps the OpenNLP 
-part-of-speech tagger.  Open this file using the Component Descriptor Editor as
-described in the tutorial.  Click on the tab labeled "Overview" to observe that 
-the class called by this descriptor is "org.apache.ctakes.postagger.POSTagger".
-Click on the tab labeled "Parameter Settings" to view the parameters required 
-by the POSTagger component.  The descriptor file does not document the 
-parameters because they are documented in the api javadocs for the class 
-org.apache.ctakes.postagger.POSTagger.  Please consult that documentation for 
-additional details.  The parameters are:
- - PosModelFile - the file that contains the part-of-speech tagging model
- - TagDictionary - the file that contains the tag dictionary (if available)
- - CaseSensitive - determines whether to use the TagDictionary in a case 
-					sensitive way or not.
-
-%%%%%%%%%%%%%%%%%%%%%%
-POSTaggerAggregate.xml
-
-The descriptor desc/POSTaggerAggregate.xml defines a pipeline for part-of-speech
-tagging that creates all the necessary inputs (e.g. token and sentence
-annotations).
-
-Open it using the Component Descriptor Editor as described in the tutorial.
-Click on the tab labeled "Overview" to observe that the engine type is 
-"Aggregate".  
-Click on the tab labeled "Aggregate" to see the components that need to be run 
-before the POSTagger can run.  
-Click on the tab labeled "Parameter Settings" to see that the same three 
-parameters need to be set from the POSTagger.xml file.  If you set these 
-parameters to acceptable values, you can open and run
-desc/POSTaggerAggregate.xml using the CAS Visual Debugger.  
-
-%%%%%%%%%%%%%%%%
-POSTaggerCPE.xml
-
-The file desc/POSTaggerCPE.xml provides an xml-specification of a component 
-processing engine (CPE) which can be opened, edited, and run using the UIMA 
-CPE GUI as described in the tutorial.  Open this file using the UIMA CPE GUI 
-and set the parameters for the collection reader to point to a local collection
-of files that you want part-of-speech tagged.  Set the parameters for the 
-POSTagger as appropriate for your environment and, finally, set the output 
-directory of the XCAS Writer CAS Consumer.  
-
-The results of running the pipeline are written to the output directory 
-as XCAS files.
-  
-These files can be viewed in the CAS Visual Debugger.  
-
-#######################
-Evaluating a POS tagger
-#######################
-
-There are two ways a POS tagger should be evaluated:
-
-1) Use gold standard tokens
-
-Run the POS tagger using gold standard tokens and calculate the percentage of 
-part-of-speech labels that have been correctly assigned.
-
-If this is gold standard sentence:
-The_DT major_JJ inducible_JJ protein_NN complex_NN that_WDT binds_VBZ ._.
-
-And if this is the output for that sentence:
-The_DT major_JJ inducible_NN protein_NN complex_NN that_WDT binds_VBD ._.
-
-The accuracy should be 6/8 = 75%.
-
-2) Use tokenizer generated tokens
-
-Run the tokenizer and use this as input to the POS tagger.  In this scenario, we calculate 
-f-measure in the following way:
-
-true positive - a token that has the correct boundary and part-of-speech label 
-false positive - a tagged token that does not have the correct boundary and/or
-                 part-of-speech label 
-false negative - a token in the gold standard data that was not correctly generated by 
-                 the tokenizer/POS tagger
-
-If this is gold standard sentence:
-This_DT complex_NN is_VBZ not_RB cyclosporin_JJ -sensitive_JJ ._.
-
-And if this is the output for that sentence:
-This_DT complex_JJ is_VBZ not_RB cyclosporin-sensitive_JJ ._.
-
-true positives = 4
-false positives = 2
-false negatives = 3
-
-f-measure = (2 * recall * precision) / (precision + recall) 
-          = (2*TP) / (2*TP + FP + FN) 
-          
-f-measure = (2*4) / (2*4 + 2 + 3) = 8 / 13 = .615
-
-In fact, if you do the evaluation this way for the "gold standard tokens" evaluation, then 
-you will get the same answer as the accuracy calculation given above. 
- 
\ No newline at end of file
diff --git a/ctakes-pos-tagger/README.md b/ctakes-pos-tagger/README.md
new file mode 100644
index 0000000..ffd48d6
--- /dev/null
+++ b/ctakes-pos-tagger/README.md
@@ -0,0 +1,4 @@
+Provides a UIMA wrapper around the popular OpenNLP part-of-speech tagger.  
+The UIMA examples project provides a default wrapper from which we have borrowed liberally.
+We have created our own wrapper so that it will work better with our type system and to add features and supporting components.
+ 
\ No newline at end of file
diff --git a/ctakes-preprocessor/README b/ctakes-preprocessor/README
deleted file mode 100644
index dccef74..0000000
--- a/ctakes-preprocessor/README
+++ /dev/null
@@ -1,51 +0,0 @@
-
-Contents
-- Introduction
-- Running the analysis engine
-	- AggregateAE.xml
-	- CdaCasInitializer.xml analysis engine descriptor
-
-############
-Introduction
-############
-
-The CdaCasInitializer annotator transforms a Common Data Architecture (CDA) document into plain text,
-provided the CDA document conforms to the DTD resources.
-
-As part of the conversion to plaintext, section (segment) markers are inserted into the text, 
-hyphens are inserted into words that should be hyphenated.
-The resulting text in stored in a new View, which has its own Sofa. 
-
-Sections are detected and Segment (aka section) annotations are added to the CAS. 
-Document level data is extracted and stored in the CAS as Property annotations.
-
-This does not handle all CDA documents -- the CDA document must conform to the DTD. 
-resources/cda/NotesIIST_RTF.DTD
-
-
-#######################################
-Running the analysis engine (annotator)
-#######################################
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%
-AggregateAE.xml
-
-The file desc/AggregateAE.xml defines a "pipeline" for preprocessing documents.
-The "pipeline" is a simple pipeline with only one delegate analysis engine (one 
-annotator), the CdaCasInitializer, and is included for testing.  Typically the 
-CdaCasInitializer.xml descriptor is included in a more complete pipeline rather
-than using the AggregateAE.xml descriptor that is in this project.
-
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%
-CdaCasInitializer.xml
-
-The CdaCasInitializer descriptor defines the analysis engine (annotator) for 
-preprocessing documents. 
-
-It takes no parameters.
-
-It creates a plaintext view from a CDA view. 
-The plaintext view can then annotated for tokens, parts of speech, chunks, etc.
- 
- 
diff --git a/ctakes-relation-extractor/README.md b/ctakes-relation-extractor/README.md
new file mode 100644
index 0000000..6237d9d
--- /dev/null
+++ b/ctakes-relation-extractor/README.md
@@ -0,0 +1,2 @@
+The relation extractor is designed to annotation relations between certain Event, Entity and Modifier annotations.  
+There are currently models trained for detecting body site and severity using machine learning with a model trained on manually annotated clinical data.
diff --git a/ctakes-relation-extractor/src/user/resources/org/apache/ctakes/relation/extractor/pipeline/DefaultRelationPipeline.piper b/ctakes-relation-extractor/src/user/resources/org/apache/ctakes/relation/extractor/pipeline/DefaultRelationPipeline.piper
index d6fe144..3d625f5 100644
--- a/ctakes-relation-extractor/src/user/resources/org/apache/ctakes/relation/extractor/pipeline/DefaultRelationPipeline.piper
+++ b/ctakes-relation-extractor/src/user/resources/org/apache/ctakes/relation/extractor/pipeline/DefaultRelationPipeline.piper
@@ -1,4 +1,4 @@
-// Default Clinical Pipeline with degree-of and location-of relations
+// Clinical Pipeline with degree-of and location-of relations.
 
 // Default Clinical Pipeline
 load DefaultFastPipeline
diff --git a/ctakes-relation-extractor/src/user/resources/org/apache/ctakes/relation/extractor/pipeline/RelationSubPipe.piper b/ctakes-relation-extractor/src/user/resources/org/apache/ctakes/relation/extractor/pipeline/RelationSubPipe.piper
index 82dc26d..efb01fd 100644
--- a/ctakes-relation-extractor/src/user/resources/org/apache/ctakes/relation/extractor/pipeline/RelationSubPipe.piper
+++ b/ctakes-relation-extractor/src/user/resources/org/apache/ctakes/relation/extractor/pipeline/RelationSubPipe.piper
@@ -1,4 +1,5 @@
-// Commands and parameters to create a default relation extraction sub-pipeline.  This is not a full pipeline.
+// Commands and parameters to create a default relation extraction sub-pipeline.
+// This is not a full pipeline.
 
 // Modifiers. Use addLogged to log start and finish of processing.  There aren't default models, so set specifically
 add ModifierExtractorAnnotator classifierJarPath=/org/apache/ctakes/relation/extractor/models/modifier_extractor/model.jar
diff --git a/ctakes-relation-extractor/src/user/resources/org/apache/ctakes/relation/extractor/pipeline/SectionedRelationPipeline.piper b/ctakes-relation-extractor/src/user/resources/org/apache/ctakes/relation/extractor/pipeline/SectionedRelationPipeline.piper
index 190b8e2..6407071 100644
--- a/ctakes-relation-extractor/src/user/resources/org/apache/ctakes/relation/extractor/pipeline/SectionedRelationPipeline.piper
+++ b/ctakes-relation-extractor/src/user/resources/org/apache/ctakes/relation/extractor/pipeline/SectionedRelationPipeline.piper
@@ -1,6 +1,6 @@
-// Clinical Pipeline with sectionization, paragraph and list detection and degree-of and location-of relations
+// Clinical Pipeline with section, paragraph and list detection and degree-of and location-of relations
 
-// Default Clinical Pipeline with sectionization, paragraph and list detection
+// Default Clinical Pipeline with section, paragraph and list detection
 load SectionedFastPipeline
 
 // degree-of, relation-of
diff --git a/ctakes-relation-extractor/src/user/resources/org/apache/ctakes/relation/extractor/pipeline/TsRelationSubPipe.piper b/ctakes-relation-extractor/src/user/resources/org/apache/ctakes/relation/extractor/pipeline/TsRelationSubPipe.piper
index 52fdd20..581bfdf 100644
--- a/ctakes-relation-extractor/src/user/resources/org/apache/ctakes/relation/extractor/pipeline/TsRelationSubPipe.piper
+++ b/ctakes-relation-extractor/src/user/resources/org/apache/ctakes/relation/extractor/pipeline/TsRelationSubPipe.piper
@@ -1,4 +1,5 @@
-// Commands and parameters to create a default relation extraction sub-pipeline.  This is not a full pipeline.
+// Commands and parameters to create a relation extraction sub-pipeline.
+//  This is not a full pipeline.
 
 // Modifiers. Use addLogged to log start and finish of processing.  There aren't default models, so set specifically
 add concurrent.ThreadSafeModifierExtractor classifierJarPath=/org/apache/ctakes/relation/extractor/models/modifier_extractor/model.jar
diff --git a/ctakes-relation-extractor/src/user/resources/org/apache/ctakes/relation/extractor/pipeline/TsSectionedRelationPipeline.piper b/ctakes-relation-extractor/src/user/resources/org/apache/ctakes/relation/extractor/pipeline/TsSectionedRelationPipeline.piper
index 287b2f7..272707a 100644
--- a/ctakes-relation-extractor/src/user/resources/org/apache/ctakes/relation/extractor/pipeline/TsSectionedRelationPipeline.piper
+++ b/ctakes-relation-extractor/src/user/resources/org/apache/ctakes/relation/extractor/pipeline/TsSectionedRelationPipeline.piper
@@ -1,6 +1,6 @@
-// Thread Safe Clinical Pipeline with sectionization, paragraph and list detection and degree-of and location-of relations
+// Thread Safe Clinical Pipeline with section, paragraph and list detection and degree-of and location-of relations.
 
-// Default Clinical Pipeline with sectionization, paragraph and list detection
+// Default Clinical Pipeline with section, paragraph and list detection
 load TsSectionedFastPipeline
 
 // degree-of, relation-of
diff --git a/ctakes-side-effect/README b/ctakes-side-effect/README
deleted file mode 100644
index 767f985..0000000
--- a/ctakes-side-effect/README
+++ /dev/null
@@ -1,19 +0,0 @@
-Drug Side Effect Extraction
-===========================
-This side effect extraction system extracts physician-asserted drug side effects from clinical notes. Alternatively, the system can extract sentences that possibly contain both side effects and causative drugs, which cover higher number of side effect occurrences but needs human validation to extract individual causative drugs and side effects.
-The detailed method used here can be found in:
-S Sohn, JP A Kocher, CG Chute, GK Savova, "Drug side effect extraction from clinical narratives of psychiatry and psychology patients" JAMIA doi:10.1136/amiajnl-2011-000351
-The performance reported in the paper is based on a variation of cTAKES. So the actual performance of this release is slightly different from it. Also, note that this release uses LibSVM for side effect sentence classification instead of C4.5, which was used in the paper, due to a license issue.  
-
-The default cTAKES is shipped with a sample dictionary. To achieve the full function of it, it is necessary to create a more complete dictionary (refer to Creating your own dictionary in cTAKES User Guide). This side effect extraction also requires Drug NER. 
-
-How to 
-------
-�	Run side effect extraction
-Use SideEffectCPE.xml for plain text with Mayo section tags or SideEffect_CDA_CPE.xml for CDA documents.
-
-�	Run both side effect and side effect sentence extraction	
-Use SideEffectSentenceCPE.xml for plain text with Mayo section tags or SideEffectSentence_CDA_CPE.xml for CDA documents.
-
-�	Customize side effect extraction rules
-The method, getSideEffectsWithPrioritizedRule() in SideEffectAnnotator.java contains the list of rules used for side effect extraction. A user can modify existing rules or create new rules. 
diff --git a/ctakes-side-effect/README.md b/ctakes-side-effect/README.md
new file mode 100644
index 0000000..e6c3901
--- /dev/null
+++ b/ctakes-side-effect/README.md
@@ -0,0 +1,13 @@
+This side effect extraction system extracts physician-asserted drug side effects from clinical notes.
+Alternatively, the system can extract sentences that possibly contain both side effects and causative drugs,
+which cover higher number of side effect occurrences but needs human validation to extract individual causative drugs and side effects.
+The detailed method used here can be found in:  
+S Sohn, JP A Kocher, CG Chute, GK Savova, "Drug side effect extraction from clinical narratives of psychiatry and psychology patients"
+JAMIA doi:10.1136/amiajnl-2011-000351  
+The performance reported in the paper is based on a variation of cTAKES. 
+So the actual performance of this release is slightly different from it. 
+Also, note that this release uses LibSVM for side effect sentence classification instead of C4.5, which was used in the paper,
+due to a license issue.  
+The default cTAKES is shipped with a sample dictionary. 
+To achieve the full function of it, it is necessary to create a more complete dictionary (refer to Creating your own dictionary in cTAKES User Guide).
+This side effect extraction also requires Drug NER. 
diff --git a/ctakes-smoking-status/README b/ctakes-smoking-status/README
deleted file mode 100644
index 74bdb5f..0000000
--- a/ctakes-smoking-status/README
+++ /dev/null
@@ -1,286 +0,0 @@
-Contents
-- Disclaimer
-- Introduction
-- Overview of spoking status pipeline
-- Prerequisite steps
-- Getting Started (test sample run)
-- Verify Results  (test sample run)
-- How to use the trained libSVM model
-- Description of shipped resources
-- Debugging issues
-- Release Notes
-	
-##########
-Disclaimer
-##########
-
-This should be considered a beta release of this annotator.  See the 'Clinical Text Analysis and Knowledge Extraction System User Guide' documentation located in the cTAKES '/docs/userguide/cTAKES_userguide.htm' for detailed 
-install and setup information pertaining to all the cTAKES components.
-
-############  
-Introduction
-############
-
-This is version 1.2 of the cTAKES smoking status annotator.  The pipeline has been tested on flat text files and CDA documents.  The sample provided uses a bar (|) delimited file with multiple records (and patients) per file.  The dictionary
-lookup annotator is limited to smoking status dictionaries provided in the '/resources/ss/data/*.dictionary' files.  Specific details can be found in the 'smokingStatus_AMIA2009.pdf' and the 'smokingStatus_Overview.html' files.
-
-#####################################
-Overview of spoking status pipeline
-#####################################
-
-The smoking status pipeline processes patient records into five pre-determined categories - past smoker (P), current smoker (C), smoker (S), non-smoker (N), and unknown (U). The definition of smoking status was adapted from I2B2 
-Natural Language Processing Challenges for Clinical Records [1]: 
-
-"	PAST SMOKER (P): A patient whose record asserts either that they are a past smoker or that they were a smoker a year or more ago but who have not smoked for at least one year.
-"	CURRENT SMOKER (C): A patient whose record asserts that they are a current smoker (or that they smoked without indicating that they stopped more than a year ago) or that they were a smoker within the past year.
-"	SMOKER (S): A patient who is either a CURRENT or a PAST smoker but, whose medical record does not provide enough information to classify the patient as either a CURRENT or a PAST smoker.
-"	NON-SMOKER (N): A patient whose record indicates that they have never smoked.
-"	UNKNOWN (U): The patient's record does not mention anything about smoking.
-
-
-The algorithm for classifying at the document level is as follows:
-
-If (exist any sentence classified as C)
-Label that doc as C
-   Else If (exist a sentence classified as P)
-Label that doc as P
-   Else If (exist a sentence classified as S)
-Label that doc as S
-   Else If (exist a sentence classified as N)
-Label that doc as N
-        Else (i.e., all sentences are classified as U)
-Label that doc as U
-
-The algorithm for classifying at the patient level is as follows:
-
-If (exist a doc classified as C or P)
-	If (exist C but no P)
-		Label that patient as C
-	Else If (exist P but no C)
-		Label that patient as P
-	Else (i.e., exist both C and P)
-		If (freq of C >= freq of P)
-			Label that patient as C
-		Else Label that patient as P
-Else If (exist a doc classified as S)
-	Label that patient as S
-Else If (exist a doc classified as N)
-	Label that patient as N
-Else (i.e., all docs are classified as U)
-	Label that patient as U
-
-
-See the 'smokingStatus_AMIA2009.pdf' for a more detailed discussion.
-
-##################
-Prerequisite steps
-##################
-
-	- Install all the cTAKES components, dependencies (e.g. JVM, UIMA, and Eclipse(optional)).
-    
-	- Make sure the ctakes-clinical-pipeline of cTAKES and the Apache UIMA are setup correctly by running the CAS Visual Debugger (CVD) as 
-	described in the 'Clinical Text	Analysis and Knowledge Extraction System User Guide' 1.2. Install from PEAR packages.
-  
-	- Install the 'smoking status.pear' after completing the installation of the core and related pears, as per above.
-	NOTE: Do not utilize the 'Run your AE in the CAS Visual Debugger'(CVD) step as in other cTAKES module installations.  Instead use the 
-	'Getting Started' section below for verification purposes.  The AE infrastructure of the 'SimulatedProdSmokingAE' indirectly utilizes other
-	AEs not directly in the flow, therefore, the results of running the CVD from the pear installer are very unpredictable.
-
-#################################
-Getting Started (test sample run)
-#################################
-
-Reference the '/smoking status/doc/smokingStatus_Overview.html' and '/smoking status/doc/smokingStatus_AMIA2009.pdf.pdf' for additional documentation for this 
-pipeline.
-
-This pipeline utilizes three main flows inherent in the UIMA infrastructure to parse, analyze and summarize the radiology notes PAD classification.
-The Component Processing Engine (CPE) responsible for putting the different flows together to create, modify, and deploy the system.  
-
-Step 0: From command prompt set the UIMA_HOME class path to the location where you installed the Apache UIMA api:
-
-	 <Windows> 'set UIMA_HOME=<<path to apache-uima>>'
-	 <Linux> 'export UIMA_HOME=<<path to apache-uima>>'
-
-Step 1: From the <pipeline-root> in a terminal or command window run the following command to bring up the CPE environment:
-
-	<Windows> 
-
-java -cp ^
-"%UIMA_HOME%/lib/uima-core.jar;^
-%UIMA_HOME%/lib/uima-cpe.jar;^
-%UIMA_HOME%/lib/uima-tools.jar;^
-%UIMA_HOME%/lib/uima-document-annotation.jar;^
-%UIMA_HOME%/lib/uima-examples.jar;^
-smoking status/bin;^
-chunker/bin;^
-ctakes-clinical-pipeline/bin;^
-context dependent tokenizer/bin;^
-core/bin;^
-dictionary lookup/bin;^
-document preprocessor/bin;^
-LVG/bin;^
-NE contexts/bin;^
-POS tagger/bin;^
-core/lib/log4j-1.2.8.jar;^
-core/lib/jdom.jar;^
-core/lib/lucene-1.4-final.jar;^
-core/lib/opennlp-tools-1.4.3.jar;^
-core/lib/maxent-2.5.0.jar;^
-core/lib/OpenAI_FSM.jar;^
-core/lib/trove.jar;^
-smoking status/lib/libsvm-2.91.jar;^
-smoking status/lib/lucene-core-3.0.2.jar;^
-LVG/lib/lvg2008dist.jar;^
-document preprocessor/lib/xercesImpl.jar;^
-document preprocessor/lib/xml-apis.jar;^
-document preprocessor/lib/xmlParserAPIs.jar;^
-chunker/resources;^
-ctakes-clinical-pipeline/resources;^
-context dependent tokenizer/resources;^
-core/resources;^
-dictionary lookup/resources;^
-document preprocessor/resources;^
-LVG/resources;^
-smoking status/resources;^
-POS tagger/resources;^
-NE contexts/resources" org.apache.uima.tools.cpm.CpmFrame
-
-	<Linux> 
-	
-java -cp \
-$UIMA_HOME/lib/uima-core.jar:\
-$UIMA_HOME/lib/uima-cpe.jar:\
-$UIMA_HOME/lib/uima-tools.jar:\
-$UIMA_HOME/lib/uima-examples.jar:\
-$UIMA_HOME/lib/uima-document-annotation.jar:\
-smoking\ status/bin:\
-chunker/bin:\
-clinical\ documents\ pipeline/bin:\
-context\ dependent\ tokenizer/bin:\
-core/bin:\
-dictionary\ lookup/bin:\
-document\ preprocessor/bin:\
-LVG/bin:\
-NE\ contexts/bin:\
-POS\ tagger/bin:\
-core/lib/log4j-1.2.8.jar:\
-core/lib/jdom.jar:\
-core/lib/lucene-1.4-final.jar:\
-core/lib/opennlp-tools-1.4.3.jar:\
-core/lib/maxent-2.5.0.jar:\
-core/lib/OpenAI_FSM.jar:\
-core/lib/trove.jar:\
-LVG/lib/lvg2008dist.jar:\
-smoking\ status/lib/libsvm-2.91.jar:\
-smoking\ status/lib/lucene-core-3.0.2.jar:\
-document\ preprocessor/lib/xercesImpl.jar:\
-document\ preprocessor/lib/xml-apis.jar:\
-document\ preprocessor/lib/xmlParserAPIs.jar:\
-chunker/resources:\
-clinical\ documents\ pipeline/resources:\
-context\ dependent\ tokenizer/resources:\
-core/resources:\
-dictionary\ lookup/resources:\
-document\ preprocessor/resources:\
-LVG/resources:\
-NE\ contexts/resources:\
-smoking\ status/resources:\
-POS\ tagger/resources \
-org.apache.uima.tools.cpm.CpmFrame	 
-
-Step 2: From the pull down menu open the �Sample_SmokingStatus_output_flatfile.xml� via 'File' => 'Open CPE Descriptor' => 'smoking status/desc/collection_processing _engine/Sample_SmokingStatus_output_flatfile.xml'.
-
-This will load the sample Collection Processing Engine (CPE) 'Sample_SmokingStatus_output_flatfile.xml'.  
-A sample CPE has been provided along with de-identified patient information to provide a means to test the pipeline after you have set up the environment. FYI.  '{inst-root-dir}/data/test' contains 5 sample notes representing one patients
-multiple visits to a health service provider.
-
-Step 3: In order to run this sample you will need to specify the Eclipse workspace in place of the '{inst-root-dir}' (<pipeline-root>) or the path where you installed 'smoking status' project. 
- 
-Step 4: Additionally, within the 'Output File:' field specify the path and file name to write the record level smoking status output on your system ('{inst-root-dir}/smoking status/data/test/output/record_resolution.txt' => outfile path and name ) 
-or the path where you installed will be used by default.
-  
-Step 5: By taking defaults for the rest of the values and, specifically, making sure the 'Run Patient Level Classification:' box is checked, an output file called 'record_resolution.txt_patientLevel.txt' ('{inst-root-dir}/<Output File path and name')
-will be generated holding the overall smoking classification for that patient.
-
-#################################
-Verify Results  (test sample run)
-#################################
-
-After running 'Step 5' from the section above there should be two files in the output directory specified in the 'Output File Name'; including the name you indicated for the file name (e.g. 'record_resolution.txt')
-and summary results file called 'record_resolution.txt_patientLevel.txt' or the name of the file you specified in the 'Final Classification Output File:' field.
-
-The output file will contain a 5 rows of data corresponding to each document contained in the '{inst-root-dir}/data/test' as follows:
-
-doc1_07543210_sample_current.txt|CURRENT_SMOKER
-doc1_07543210_sample_past_smoker.txt|PAST_SMOKER
-doc1_07543210_sample_unknown.txt|UNKNOWN
-doc2_07543210_sample_current.txt|CURRENT_SMOKER
-doc2_07543210_sample_past_smoker.txt|PAST_SMOKER
-
-Each field is delimited using the vertical bar (|).  The first column shows the patient number and known classification.  The second column contains the discovered smoking classification.
-
-The 'record_resolution.txt_patientLevel.txt' should contain the following:
-
-07543210|CURRENT_SMOKER
-
-###################################
-How to use the trained libSVM model
-###################################
-
-To use libSVM: In ClassifiableEntriesAnnotator.xml, set a parameter of UimaDescriptorStep2 to "ProductionPostSentenceAggregate_step2_libsvm.xml"
-Trained model of libSVM is in: resources/org/apache/ctakes/smoking/status/data/PCS/pcs_libsvm-2.91.model
-
-cf) libSVM Command used to create this trained model: java svm_train -s 0 -t 1 -g 1 -r 1 -d 1 training_data model_name
-
-The algorithm used in this smoking status classification is described in: 
-S. Sohn and GK. Savova, 'Mayo Clinic Smoking Status Classification System: Extensions and Improvements' AMIA 2009 Annual Symposium, San Francisco, pp 619-623, Nov. 2009. 
-(Please note that we replaced the Weka SVM classifier described in this paper with libSVM in the released pipeline.)
-
-################################
-Description of shipped resources
-################################
-
-data/context/negationContradictionWords.txt: If those words appear in the sentence along with a negation marker, the negation detection component is not triggered.
-data/KU/keywords.txt: a set of smoking-related keywords. If those keywords appear in the sentence, "known" is assigned. If not "unknown" is assigned.
-data/KU/unknown_words.txt: If those words appear along with smoking-related keywords, "known" is not assigned.
-data/smoker.dictionary and nonsmoker.dictionary: dictionaries to be used for name entities of SmokerNamedEntityAnnotation and NonSmokerNamedEntityAnnotation. Each includes smoker or nonsmoker keywords respectively.
-data/PCS/keywords_PCS: keywords used to build feature vectors of the PCS classifier
-data/PCS/pcs_libsvm-2.91.model: the trained model using libSVM for the PCS classification
-
-################
-Debugging issues
-################
- 
- Description: CPE gives 'null pointer exception'.
-  
- Issue: AWT and browser component become out of scope or corrupted.
- 
- Workaround: Use the CPE 'File' => 'Clear All' option and reload all the three panels respective annotators and values
- 
- Description: Get "CASRuntimeException: JCas type "org.apache.uima.examples.SourceDocumentInformation" used in Java code,  but was not declared in the XML type descriptor." type of error when deploying from CPE.
- 
- Issue: Accessing typesytems, annotators and/or resources outside of the project class path.
- 
- Workaround: Make sure the CPE is kicked off with the corresponding projects 'bin' and 'resources' specified in the class path 
-
- #############
- Release Notes
- #############
- 
-One of the next releases will look into addressing the following:
-  - class 'org.apache.ctakes.smokingstatus.machine.NegationFSM.java' must inherit from 'core/org.apache.ctakes.core.fsm.machine.NegationFSM.java'
-  - !!! smokingstatus negation removed as it was identical to that in ctakes-core.
-  - org.apache.ctakes.smokingstatus.context.negation.NegationContextAnalyzer - needs to use 'NE Contexts/org.apache.ctakes.necontexts.negation.NegationContextAnalyzer'
-  - !!! smokingstatus NegationContextAnalyzer removed as it was identical to that in ctakes-ne-contexts.
-  - ResolutionAnnotator.java references 'TypeSystemConst.NE_CERTAINTY_NEGATED' which has been commented out, uncomment in both places for next major release
-  - FIXED -Parameters probably need to be changed? /smoking status/desc/analysis_engine/ClassifiableEntriesAnnotator.xml
-  - FIXED - CdaCasInitializer.xml must be used from 'document preprocessor'
-  - FIXED - SimulatedProdSmokingTAE.xml -> ExternalBaseAggregateTAE.xml -> ./SimpleSegmentAnnotator.xml -- need to reference the one in core 
-    org.apache.ctakes.smokingstatus.ae.SimpleSegmentAnnotator - must use core/org.apache.ctakes.core.ae.SimpleSegmentAnnotator.java
-    
-   Version 1.2 Addendum
-   - FIXED - The LibSVM features in the previous cTAKES version are not fed into the system in correct order and cause incorrect "past smoker", "current smoker", and "smoker" classification. The new version fixed this problem. 
-   - FIXED - Subsections not being correctly handled causing misclassifications. 
-   - FIXED - Remove the type, SmokingSentence in SmokingProductionTypeSystem.xml. 
-   
-  
diff --git a/ctakes-smoking-status/README.md b/ctakes-smoking-status/README.md
new file mode 100644
index 0000000..2db10ad
--- /dev/null
+++ b/ctakes-smoking-status/README.md
@@ -0,0 +1,15 @@
+This is version 1.2 of the cTAKES smoking status annotator.
+The pipeline has been tested on flat text files and CDA documents.
+The sample provided uses a bar (|) delimited file with multiple records (and patients) per file. 
+The dictionary lookup annotator is limited to smoking status dictionaries provided in the '/resources/ss/data/*.dictionary' files. 
+
+The smoking status pipeline processes patient records into five pre-determined categories -
+past smoker (P), current smoker (C), smoker (S), non-smoker (N), and unknown (U).
+The definition of smoking status was adapted from I2B2 Natural Language Processing Challenges for Clinical Records. 
+
+- PAST SMOKER (P): A patient whose record asserts either that they are a past smoker or that they were a smoker a year or more ago but who have not smoked for at least one year. 
+- CURRENT SMOKER (C): A patient whose record asserts that they are a current smoker (or that they smoked without indicating that they stopped more than a year ago) or that they were a smoker within the past year.
+- SMOKER (S): A patient who is either a CURRENT or a PAST smoker but, whose medical record does not provide enough information to classify the patient as either a CURRENT or a PAST smoker.
+- NON-SMOKER (N): A patient whose record indicates that they have never smoked.
+- UNKNOWN (U): The patient's record does not mention anything about smoking.
+
diff --git a/ctakes-temporal/README.md b/ctakes-temporal/README.md
new file mode 100644
index 0000000..e08d5f0
--- /dev/null
+++ b/ctakes-temporal/README.md
@@ -0,0 +1,65 @@
+This module is dedicated to processing electronic medical records for meaningful events, temporal expressions, and their relations on a timeline.  
+
+Temporal relations are of prime importance in biomedicine as they are intrinsically linked to diseases,
+signs and symptoms, and treatments. 
+The identification of temporal relations in medical text has drawn growing attention because of its
+potential to dramatically increase the understanding of many medical phenomena such as disease progression,
+longitudinal effects of medications, and a patient's clinical course, and its many clinical applications 
+such as question answering[1, 2], clinical outcomes prediction[3], and the recognition of temporal patterns 
+and timelines[4, 5].
+
+<details>
+<summary>Key components</summary>
+
+**Event annotator**  
+A Begin-Inside-Outside (BIO) style sequence annotator for clinically meaningful events, 
+i.e. anything that would show up on a detailed timeline of the patient’s care or life.
+
+**Temporal expression annotators**  
+A series of BIO style sequence annotators that employed forward and backward search algorithms 
+and multiple learning methods (Support Vector Machine (SVM), Conditional Random Field (CRV) )
+for annotating temporal expressions which would provide concrete temporal references throughout 
+the document or section, e.g. “today”, “24 hours ago”, “postoperative”.
+More details can be found in [6].   
+
+**DocTimeRel annotator**  
+For every event, there is an SVM-based annotator that can automatically reason the temporal relation
+between the target event and the document creation time (DCT). 
+This module provided a basic and stable temporal solution that can position all events into coarse
+temporal bins, e.g. “before the DCT”, “after the DCT”, or “overlap the DCT”. 
+This annotator has proved helpful in solving real clinical temporal-sensitive tasks for multiple 
+institutions [5].
+
+**Temporal relation (TLINK) annotators**  
+SVM-based annotators for detecting within-sentence Event-Time relations and Event-Event relations.
+For i2b2 datasets there are also cross sentence Event-Time and Event-Event relation annotators.
+Multiple techniques have been implemented, including narrative container-based annotation
+concept [7], tree kernels [8] for syntactic similarity measurement,
+multi-layered temporal modeling [9], event expansion [10], and deep neural network methods [11, 12].
+</details>
+
+<details>
+<summary>Evaluation</summary>
+The SVM-based temporal relation annotators achieve an F-score of 0.589 which outperform the best
+system of Clinical TempEval 2016 [13], whose F-score was 0.573. State-of-the-art results for
+event-time relations have been achieved with our neural network approaches.
+</details>
+
+All the above annotators were trained and tested on colon cancer notes from the THYME data set [14].
+<details>
+<summary>References</summary>
+1.	Das, A.K. and M.A. Musen. A comparison of the temporal expressiveness of three database query methods. in Annual Symposium on Computer Applications in Medical Care. 1995. IEEE COMPUTER SOCIETY PRESS.
+2.	Kahn, M.G., L.M. Fagan, and S. Tu, Extensions to the time-oriented database model to support temporal reasoning in medical expert systems. Methods of information in medicine, 1990. 30(1): p. 4-14.
+3.	Schmidt, R., S. Ropele, C. Enzinger, et al., White matter lesion progression, brain atrophy, and cognitive decline: the Austrian stroke prevention study. Annals of neurology, 2005. 58(4): p. 610-616.
+4.	Zhou, L. and G. Hripcsak, Temporal reasoning with medical data—a review with emphasis on medical natural language processing. Journal of biomedical informatics, 2007. 40(2): p. 183-202.
+5.	Lin, C., E.W. Karlson, D. Dligach, et al., Automatic identification of methotrexate-induced liver toxicity in patients with rheumatoid arthritis from the electronic medical record. Journal of the American Medical Informatics Association, 2014: p. amiajnl-2014-002642.
+6.	Miller, T.A., S. Bethard, D. Dligach, et al., Extracting Time Expressions from Clinical Text, in Proceedings of BioNLP 15. 2015.
+7.	Miller, T.A., S. Bethard, D. Dligach, et al., Discovering narrative containers in clinical text, in ACL 2013. 2013: Sofia, Bulgaria. p. 18.
+8.	Lin, C., T. Miller, A. Kho, et al., Descending-Path Convolution Kernel for Syntactic Structures, in Proceedings of the 52nd Annual Meeting of the Association for Computational Linguistics (ACL). 2014: Baltimore, Maryland, USA. p. 81-86.
+9.	Lin, C., D. Dligach, T.A. Miller, et al., Multilayered temporal modeling for the clinical domain. J Am Med Inform Assoc, 2016. 23(2): p. 387-95.
+10.	Lin, C., T. Miller, D. Dligach, et al., Improving Temporal Relation Extraction with Training Instance Augmentation. BioNLP 2016, 2016: p. 108.
+11.	Dligach, D., T. Miller, C. Lin, et al., Neural temporal relation extraction., in European Chapter of the Association for Computational Linguistics (EACL 2017). 2017: Valencia, Spain.
+12.	Hartzell, E. and C. Lin. Enhancing Clinical Temporal Relation Discovery with Syntactic Embeddings from GloVe. in International Conference on Intelligent Biology and Medicine (ICIBM 2016). 2016. Houston, Texas, USA.
+13.	Bethard, S., G. Savova, W.-T. Chen, et al., Semeval-2016 task 12: Clinical tempeval. Proceedings of SemEval, 2016: p. 1052-1062.
+14.	Styler IV, W.F., S. Bethard, S. Finan, et al., Temporal annotation in the clinical domain. Transactions of the Association for Computational Linguistics, 2014. 2: p. 143-154.  
+</details>
\ No newline at end of file
diff --git a/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/DefaultRelationTemporalPipeline.piper b/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/DefaultRelationTemporalPipeline.piper
index b012f6e..06352e9 100644
--- a/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/DefaultRelationTemporalPipeline.piper
+++ b/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/DefaultRelationTemporalPipeline.piper
@@ -1,8 +1,7 @@
-// Default Clinical Pipeline with degree-of and location-of relations
-// with events, times, event-event and event-time relations plus event-document creation time relations
+// Clinical Pipeline with degree-of, location-of, events, times, temporal and event-doc creation time relations.
 
-// Default Clinical Pipeline with degree-of and location-of relations
+// Clinical Pipeline with degree-of and location-of relations.
 load DefaultRelationPipeline
 
-// event, time, event-event, event-time, dtr
+// events, times, event-event, event-time and event-doc creation time relations.
 load TemporalSubPipe
diff --git a/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/DefaultTemporalPipeline.piper b/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/DefaultTemporalPipeline.piper
index 76cac1c..5cd0aba 100644
--- a/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/DefaultTemporalPipeline.piper
+++ b/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/DefaultTemporalPipeline.piper
@@ -1,7 +1,7 @@
-// Default Clinical Pipeline with events, times, event-event and event-time relations plus event-document creation time relations
+// Clinical Pipeline with events, times, event-event and event-time relations plus event-document creation time relations.
 
-// Default Clinical Pipeline
+// Clinical Pipeline.
 load DefaultFastPipeline
 
-// event, time, event-event, event-time, dtr
+// events, times, event-event, event-time and event-doc creation time relations.
 load TemporalSubPipe
diff --git a/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/SectionedRelationTemporalPipeline.piper b/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/SectionedRelationTemporalPipeline.piper
index 999feb4..a230ed5 100644
--- a/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/SectionedRelationTemporalPipeline.piper
+++ b/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/SectionedRelationTemporalPipeline.piper
@@ -1,8 +1,7 @@
-// Clinical Pipeline with sectionization, paragraph and list detection and degree-of and location-of relations
-// with events, times, event-event and event-time relations plus event-document creation time relations
+// Clinical Pipeline with sections, paragraphs, lists, degree-of, location-of, events, times, temporal and event-doc creation time relations.
 
-// Clinical Pipeline with sectionization, paragraph and list detection with degree-of and location-of relations
+// Clinical Pipeline with section, paragraph and list detection with degree-of and location-of relations.
 load SectionedRelationPipeline
 
-// degree-of, relation-of
+// events, times, event-event, event-time and event-doc creation time relations.
 load TemporalSubPipe
diff --git a/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/SectionedTemporalPipeline.piper b/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/SectionedTemporalPipeline.piper
index 7417a3a..2754077 100644
--- a/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/SectionedTemporalPipeline.piper
+++ b/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/SectionedTemporalPipeline.piper
@@ -1,8 +1,7 @@
-// Clinical Pipeline with sectionization, paragraph and list detection with
-// events, times, event-event and event-time relations plus event-document creation time relations
+// Clinical Pipeline with sections, paragraphs, lists, events, times, temporal and event-doc creation time relations.
 
-// Default Clinical Pipeline with sectionization, paragraph and list detection
+// Clinical Pipeline with section, paragraph and list detection.
 load SectionedFastPipeline
 
-// event, time, event-event, event-time, dtr
+// events, times, event-event, event-time and event-doc creation time relations.
 load TemporalSubPipe
diff --git a/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/TemporalSubPipe.piper b/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/TemporalSubPipe.piper
index 385b2b9..59fe91d 100644
--- a/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/TemporalSubPipe.piper
+++ b/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/TemporalSubPipe.piper
@@ -1,4 +1,5 @@
-// Commands and parameters to create a default temporal processing sub-pipeline.  This is not a full pipeline.
+// Commands and parameters to create a temporal processing sub-pipeline.
+// This is not a full pipeline.
 
 // 'Generic' Events.  Use addDescription and let the EventAnnotator set itself up with defaults.
 addDescription EventAnnotator
diff --git a/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/TsDefaultRelationTemporalPipeline.piper b/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/TsDefaultRelationTemporalPipeline.piper
index 50a980b..f487386 100644
--- a/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/TsDefaultRelationTemporalPipeline.piper
+++ b/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/TsDefaultRelationTemporalPipeline.piper
@@ -1,8 +1,7 @@
-// Thread Safe Default Clinical Pipeline with degree-of and location-of relations
-// with events, times, event-event and event-time relations plus event-document creation time relations
+// Thread Safe Clinical Pipeline with degree-of and location-of relations, events, times, temporal abd event-doc creation time relations.
 
-// Default Clinical Pipeline with degree-of and location-of relations
+// Thread safe Clinical Pipeline with degree-of and location-of relations.
 load TsDefaultRelationPipeline
 
-// event, time, event-event, event-time, dtr
+// Thread safe events, times, event-event, event-time and event-doc creation time relations.
 load TsTemporalSubPipe
diff --git a/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/TsDefaultTemporalPipeline.piper b/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/TsDefaultTemporalPipeline.piper
index 15ad102..d1b30e1 100644
--- a/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/TsDefaultTemporalPipeline.piper
+++ b/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/TsDefaultTemporalPipeline.piper
@@ -1,7 +1,7 @@
 // Thread Safe Default Clinical Pipeline with events, times, event-event and event-time relations plus event-document creation time relations
 
-// Default Clinical Pipeline
+// Thread safe Clinical Pipeline.
 load TsDefaultFastPipeline
 
-// event, time, event-event, event-time, dtr
+// Thread safe events, times, event-event, event-time and event-doc creation time relations.
 load TsTemporalSubPipe
diff --git a/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/TsSectionedRelationTemporalPipeline.piper b/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/TsSectionedRelationTemporalPipeline.piper
index 2f96075..84b9931 100644
--- a/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/TsSectionedRelationTemporalPipeline.piper
+++ b/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/TsSectionedRelationTemporalPipeline.piper
@@ -1,8 +1,8 @@
-// Clinical Pipeline with sectionization, paragraph and list detection and degree-of and location-of relations
-// with events, times, event-event and event-time relations plus event-document creation time relations
+// Thread safe Clinical Pipeline with sections, paragraphs, lists, degree-of, location-of, events, times, temporal and event-doc creation time relations.
 
-// Clinical Pipeline with sectionization, paragraph and list detection with degree-of and location-of relations
+
+// Clinical Pipeline with section, paragraph and list detection with degree-of and location-of relations.
 load TsSectionedRelationPipeline
 
-// degree-of, relation-of
+// Thread safe events, times, event-event, event-time and event-doc creation time relations.
 load TsTemporalSubPipe
diff --git a/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/TsSectionedTemporalPipeline.piper b/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/TsSectionedTemporalPipeline.piper
index bea3f5e..aac8303 100644
--- a/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/TsSectionedTemporalPipeline.piper
+++ b/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/TsSectionedTemporalPipeline.piper
@@ -1,8 +1,8 @@
-// Thread Safe Clinical Pipeline with sectionization, paragraph and list detection with
-// events, times, event-event and event-time relations plus event-document creation time relations
+// Thread safe Clinical Pipeline with sections, paragraphs, lists, events, times, temporal and event-doc creation time relations.
 
-// Default Clinical Pipeline with sectionization, paragraph and list detection
+
+// Clinical Pipeline with section, paragraph and list detection.
 load TsSectionedFastPipeline
 
-// event, time, event-event, event-time, dtr
+// Thread safe events, times, event-event, event-time and event-doc creation time relations.
 load TsTemporalSubPipe
diff --git a/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/TsTemporalSubPipe.piper b/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/TsTemporalSubPipe.piper
index 4fa3216..94eeb00 100644
--- a/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/TsTemporalSubPipe.piper
+++ b/ctakes-temporal/src/user/resources/org/apache/ctakes/temporal/pipeline/TsTemporalSubPipe.piper
@@ -1,4 +1,5 @@
-// Commands and parameters to create a default temporal processing sub-pipeline.  This is not a full pipeline.
+// Commands and parameters to create a thread safe temporal processing sub-pipeline.
+// This is not a full pipeline.
 
 // 'Generic' Events.  Use addDescription and let the EventAnnotator set itself up with defaults.
 addDescription concurrent.ThreadSafeEventAnnotator
diff --git a/ctakes-user-resources/README.md b/ctakes-user-resources/README.md
new file mode 100644
index 0000000..8b4aeb0
--- /dev/null
+++ b/ctakes-user-resources/README.md
@@ -0,0 +1,10 @@
+This is not a normal module.  There should not be main code or main resources in this module.  
+This module creates a ctakes-user-resources jar that can be a dependency for other projects.  
+ 
+1.  We want to place user resources ( pipers, regex bsvs, stop words, etc.) in separate modules.  
+2.  For editable 'runtime' dev flexibility we want said resources in the resources/ directory upon compile. 
+3.  We want user resources to be available in binary installations under a common resources/ directory.  
+4.  Given #2 and #3 above, we do not want multiple copies of user resources in jars and resources/ dirs.  
+5.  There are external projects that depend upon user resources, so they must be available for 'getting'.  
+
+Note: External projects include Apache cTAKES projects such as ctakes-web-rest.  
diff --git a/ctakes-web-rest/README b/ctakes-web-rest/README.md
similarity index 67%
rename from ctakes-web-rest/README
rename to ctakes-web-rest/README.md
index 4d647c8..7bb0d6a 100644
--- a/ctakes-web-rest/README
+++ b/ctakes-web-rest/README.md
@@ -1,7 +1,3 @@
-* Project Apache cTAKES Web Rest
-* module: ctakes-web-rest
-
-
 The ctakes-web-rest module builds a standalone product, Apache cTaKES Web REST.  
 
 ctakes-web-rest is not compiled or built when the main Apache cTAKES code is built with maven.   
@@ -19,36 +15,22 @@ This configuration exists because:
 - building ctakes-web-rest with the main ctakes maven project adds to the build time.
 - building ctakes-web-rest with the main ctakes maven project adds to the disk footprint of the build.  i.e. it has its own huge target/ directory.
 - including ctakes-web-rest in the main Apache cTAKES binary distributable essentially puts two copies of cTAKES in the distributable.
-- building ctakes-web-rest with the main ctakes maven project will NOT put any changed code or resources in the war.
-- ^ Unless you mvn install.  Making ctakes-web-rest a separate build reinforces the separation.
-
-
+- building ctakes-web-rest with the main ctakes maven project will NOT put any changed code or resources in the war. 
+Unless you mvn install.  Making ctakes-web-rest a separate build reinforces the separation.
 
-This module performs natural language processing of input payload using REST API
-endpoint and extracts out clicnical information in JSON format.
+This module performs natural language processing of input payload using REST API endpoint and extracts out clicnical information in JSON format.
 
-Installation:
-
-[comment]: <> (1&#41; Build all the cTAKES modules as this module contains a number of references )
-
-[comment]: <> (to other cTAKES modules.)  
+<details>
+<summary>Installation</summary>
 
 1) Build this ctakes-web-rest module.
-
-2) Modify 'src\main\resources\org\apache\ctakes\dictionary\lookup\fast\customDictionary.xml'
+2) Modify ```src\main\resources\org\apache\ctakes\dictionary\lookup\fast\customDictionary.xml```
 to refer to the respective database where dictionary is loaded or use UMLS database.
-
-3) Build ctakes-web-rest module and deploy ctakes-web-rest.war available 
-under 'target' folder in Apache Tomcat.
-
+3) Build ctakes-web-rest module and deploy ```ctakes-web-rest.war``` available under ```target/``` folder in Apache Tomcat.
 4) Access the following URL to perform text analysis using cTAKES web application:
-
-    http://<host-name>:<port>/ctakes-web-rest/index.jsp
-
+    ```http://<host-name>:<port>/ctakes-web-rest/index.jsp```
 5) Access the following REST API endpoint to perform text analysis using default pipeline:
-
-    http://<host-name>:<port>/ctakes-web-rest/service/analyze?pipeline=Default
-
+    ```http://<host-name>:<port>/ctakes-web-rest/service/analyze?pipeline=Default```
 6) Access the following REST API endpoint to perform text analysis using full pipeline:
-
-    http://<host-name>:<port>/ctakes-web-rest/service/analyze?pipeline=Full
\ No newline at end of file
+    ```http://<host-name>:<port>/ctakes-web-rest/service/analyze?pipeline=Full```
+</details>
\ No newline at end of file
diff --git a/ctakes-ytex-uima/README b/ctakes-ytex-uima/README.md
similarity index 92%
rename from ctakes-ytex-uima/README
rename to ctakes-ytex-uima/README.md
index e5a66b5..be2838b 100644
--- a/ctakes-ytex-uima/README
+++ b/ctakes-ytex-uima/README.md
@@ -1,6 +1,3 @@
-############
-Introduction
-############
 Contains uima/ctakes-related ytex components:
 * DBCollectionReader - UIMA collection reader to retrieve documents from a database
 * DBConsumer - store annotations in a database
@@ -11,4 +8,4 @@ Contains uima/ctakes-related ytex components:
 * NamedEntityRegexAnnotator - use regular expressions for named entity recognition
 * SegmentRegexAnnotator - use regular expressions to identify document sections
 
-Go through the steps outlined in ctakes-ytex, then you'll be good to go for this project.
\ No newline at end of file
+Go through the steps outlined in ctakes-ytex, then you'll be good to go for this project.
diff --git a/ctakes-ytex-web/README.md b/ctakes-ytex-web/README.md
new file mode 100644
index 0000000..d35508c
--- /dev/null
+++ b/ctakes-ytex-web/README.md
@@ -0,0 +1,15 @@
+ctakes-ytex-web is a web application that provides the following:
+* searching the annotated corpus by concepts (implemented by queries to ytex tables)
+* computing the semantic similarity of concept pairs
+* provides Web & Restful services for computing semantic similarity
+
+ctakes-ytex-web just relies on ctakes-ytex and is independent of the rest of ctakes.
+Although this produces a war file (as it should), we don't actually deliver a WAR file with the ctakes distro.
+We package and install a ctakes-ytex-web.jar (notice the extension) file with the classes from this project. 
+We deliver the exploded web-app in the ctakes distro under desc/ctakes-ytex-web.
+All non-web app specific resources (properties files, spring config files) are in ctakes-ytex project/resources directory of ctakes.
+	
+To build and run the web app run the following (command line/eclipse):
+```mvn clean install jetty:run``` 
+
+This relies on you having correctly built and configured the ctakes-ytex.
diff --git a/ctakes-ytex-web/README.txt b/ctakes-ytex-web/README.txt
deleted file mode 100644
index 21da6b5..0000000
--- a/ctakes-ytex-web/README.txt
+++ /dev/null
@@ -1,17 +0,0 @@
-ctakes-ytex-web is a web application that provides the following:
-* searching the annotated corpus by concepts (implemented by queries to ytex tables)
-* computing the semantic similarity of concept pairs
-* provides Web & Restful services for computing semantic similarity
-
-ctakes-ytex-web just relies on ctakes-ytex (and is independent of the 
-rest of ctakes).  Although this produces a war file (as it should), we 
-don't actually deliver a WAR file with the ctakes distro. We package and 
-install a ctakes-ytex-web.jar (notice the extension) file with the classes from this project. 
-We deliver the exploded web-app in the ctakes distro under desc/ctakes-ytex-web.  All 
-non-web app specific resources (properties files, spring config files) are 
-in ctakes-ytex project/resources directory of ctakes.
-	
-To build and run the web app run the following (command line/eclipse):
-mvn clean install jetty:run 
-
-This relies on you having correctly built and configured the ctakes-ytex.
diff --git a/ctakes-ytex/README b/ctakes-ytex/README.md
similarity index 87%
rename from ctakes-ytex/README
rename to ctakes-ytex/README.md
index e5e3daf..e355e85 100644
--- a/ctakes-ytex/README
+++ b/ctakes-ytex/README.md
@@ -1,6 +1,3 @@
-############
-Overview
-############
 Contains the following components:
 * Semantic Similarity - compute the similarity between concepts
 * Word Sense Disambiguation - use semantic similarity to disambiguate terms that have multiple meanings
@@ -8,37 +5,38 @@ Contains the following components:
 * YTEX Database setup scripts
 * Java Data Loader - simple utility for loading delimited files into database tables
 
-############
-Cheat Sheet
-############
-To get started, do the following:
-* Create ytex.properties: create src\main\resources\org\apache\ctakes\ytex\ytex.properties (see examples in ctakes-ytex/src/main/resources/org/apache/ctakes/ytex)
+<details>
+<summary>Getting started</summary>
+
+* Create ytex.properties: `create src\main\resources\org\apache\ctakes\ytex\ytex.properties` (see examples in ctakes-ytex/src/main/resources/org/apache/ctakes/ytex)
 * Add jdbc drivers to maven repo: if you are using ms sql server / or oracle, add the jdbc driver(s) to your local maven repo (see comments in dependencies section of pom.xml)
 * Add ms sql auth dlls to path: if you are using ms sql server with integrated auth, make sure the ms sql jdbc auth directory is in your system PATH (sqljdbc_4.0\enu\auth\x64)
 * Unzip ctakes-ytex-resources.zip: extract to  ctakes-ytex-res/src/main
 * run the maven build from the command line for ctakes-ytex, ctakes-ytex-uima projects.  From the ctakes root directory:
-mvn -pl ctakes-ytex,ctakes-ytex-uima -DskipTests
+`mvn -pl ctakes-ytex,ctakes-ytex-uima -DskipTests`
 * set up your database: Open a shell/command prompt, set the CTAKES_HOME variable to be the checkout directory of ctakes (i.e. the parent of this file's directory), and run the ant script:
+
 Windows
-{{{
+
+```
 set CTAKES_HOME=xxx
 cd %CTAKES_HOME%\ctakes-ytex\scripts\data
 ant -Dconfig.local=..\..\target\classes all > ..\..\target\build.out 2>&1
-}}}
+```
 
 Linux
-{{{
+```
 CTAKES_HOME=xxx
 export CTAKES_HOME
 cd ${CTAKES_HOME}/ctakes-ytex/scripts/data
 ant -Dconfig.local=../../target/classes all > ../../target/build.out 2>&1
-}}}
+```
 
-You should be all set now
+You should be all set now.
+</details>
 
-############
-Developing
-############
+<details>
+<summary>Developing</summary>
 We have currently tested mysql and ms sql server, oracle is pending.  HSQL is used only for unit testing.  
 
 YTEX is driven by a property file, ytex.properties.  The property file used when running ytex java programs 
@@ -57,8 +55,10 @@ string in MRCONSO which will take a while.  If you have UMLS installed and want
 umls.schema/umls.catalog properties in ytex.properties.
 * Without UMLS - YTEX will load a pre-fabricated dictionary lookup table generated from the UMLS 2013AA.  This is included
 in the ctakes-resources zip from sourceforge.  You have to copy v_snomed_fword_lookup.txt to ctakes-ytex\scripts\data\umls\.
+</details>
 
-== Testing ==
+<details>
+<summary>Testing</summary>
 
 YTEX is dependent upon a database which is set up by the ant script scripts\data\build.xml
 
@@ -73,11 +73,12 @@ Override this by:
  which point to the ytex_test schema (mysql/orcl) or catalog (mssql).
  * or dropping your own ytex.properties in 
  \src\test\resources\org\apache\ctakes\ytex.
- 
+ </details>
 
-############
-Creating the ctakes-ytex-resources.zip 
-############
+<details>
+<summary>Creating the ctakes-ytex-resources.zip </summary>
 See scripts/build-nonasf.xml
+</details>
+