Read Me

Code libraries and programs supporting Canonical Text Services, v. 3,
and related services in the CITE architecture.

ABOUT CTS3 AND RELATED SERVICES
CTS3 is a protocol for identifying and retrieving passages of text using
canonical references.  The Collections service protocol defines a
method for identifying and retrieving structured objects.  Refindex services
map citable objects (texts, or collection objects) to other citable
objects, or to raw data.

Since replies to service requests are formatted in XML, all I/O in this
code assumes a UTF-8 character encoding unless that is
explicitly overridden. (Note that the current code libraries do not yet
systematically implement convenient options to override this assumption.)


STRUCTURE OF THIS REPOSITORY
appengine-jvm:  source code for applications built on Google's Java AppEngine framework.

appengine-python:  source code for applications built on Google's Python AppEngine framework.

docs/gapi : groovydoc output.

docs/userguide : user guides to the various services (not up to date for cts3)

groovlet: servlets, written in groovy, implementing CITE services. Currently, the most
	  important service servlet is cts3, an implementation of CTS3 using a JPA
	  interface that works with either Google's BigTable or RDBMS sources.

src:  java source code, including in src/edu/harvard/chs/cts3 a cts3
      library in groovy, and in src/edu/harvard/echs/ctsjpa an implementation
      of the CtsRepository interface for JPA data sources.

unittests : unit tests in groovy.  These are designed to be run from ant targets;
       relative path references in the tests assume that the tests are being run
       from the root directory of the svn tree.

ANT TARGETS
All .xml files in this directory are ant build files.
Run "ant" to see a suggested list of included targets.