Copyright (c) 2008 Charles Rich and Worcester Polytechnic Institute

MIT License: Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
________________________________________________________________

README file for the toplevel directory of the CE Task Engine.

This is an implementation of a "task engine," as depicted in
Figure 4 of the CEA-2018 Task Model Description (CE Task 1.0)
standard, which may be purchased at http://ce.org/cea-2018.  This
standard is currently (Jan/08) in the public review period for
becoming an ANSI standard.

Basically, this system implements a simple command line interface,
edu.wpi.cetask.guide.Guide, which uses the task engine
edu.wpi.cetask.TaskEngine.  In keeping with the position of CEA-2018
not being about interface appearance, this is not a proposal for a
real user interface, but rather a way to demonstrate and debug the
capabilities of the underlying task engine.

System contents include:

   java         Java source files directory
     /edu/wpi/cetask        Basic task engine 
                            [note RelaxNG schema resource CEA-2018.rnc]    

     /edu/wpi/cetask/guide  Example applications using task engine
                            [Guide and SpeechGuide]

   bin          Unix shell scripts directory [see README.txt]
   doc          Javadoc documentation directory [incomplete]

   lib          library directory
                [note contains pre-compiled system guide.jar] 
                [note XML schema CEA-2018.xsd]
                
   speech       library directory for SpeechGuide 
                [using Sphinx4 and MARY]
                               
   models       Task models directory [see README.txt]
   test         Test script directory [see README.txt]
   .classpath   Eclipse configuration file
   .project     Eclipse configuration file

To import the archive file containing this directory directly into
Eclipse:  

          File > Import > General > *Existing...* > Next 
          > Select Archive > Browse > Finish
          
*** The best way to get started is to look next at test/README.txt ***    

NB: This software is designed to run in JRE 1.6 (Java SE 6.0), which
includes JavaScript. Note that the Mac JRE 1.6-dp developer preview
version is *not* adequate, since it does not contain JavaScript. (See
special instructions below for JRE 1.5).
          
To simply run the pre-compiled version of the system, put guide.jar
and jing.jar (RelaxNG validation utility) from lib directory onto your
classpath and invoke main class edu.wpi.cetask.guide.Guide.  If you
leave guide.jar in place in the lib directory, you can also run the
system without changing your classpath by launching the jar, e.g.,

     java -jar lib/guide.jar

To run the speech-enabled version in place:

     java -mx512m -jar lib/guide.jar -speech
     
NOTE: If you need to run in JRE 1.5 (J2SE 5.0), two compatibility
files, js.jar and j2-engine5.jar are provided in the lib directory.
These should also be added on your classpath, unless you are directly
launching the jar in place as above. (In Eclipse, these are already
referenced libraries).

Please send bug reports to email address below and make sure to
include both the console.guide file (from directory indicated at
system startup) and all task model files involved.

rich@wpi.edu
1/10/08      
________________________________________________________________

RELEASE NOTES FOR VERSION 0.8.3 BETA - February 14, 2008

-improved error checking for bindings

RELEASE NOTES FOR VERSION 0.8.3 BETA - February 12, 2008

-text-to-speech added
-some bug fixes

RELEASE NOTES FOR VERSION 0.8.2 BETA - February 11, 2008

-SpeechGuide added
-new 'by' command added to select decomposition class
-guide asks for decomposition class
-guide asks for unbound inputs
-subtasks applicability conditions of "$this.succeed == false" used in example models
-automatic loading of properties files
-simple formatted system output (see examples in Library.properties)
-added 'execute' command (like 'done' but runs script if any) for convenience
 in running simple simulations

RELEASE NOTES FOR VERSION 0.8 BETA - January 10, 2008

-first release

KNOWN DEFICIENCIES: 

-scripts are not compiled
-more error checking could be added
-unbounded maxOccurs not supported (approximates 10)
-nothing done with user intent concepts
-sufficient attribute currently not used (and assumed *true*)
-side effect notation (8.6) not tested (note need to cache copy of input when value used
 in postcondition)
-"forward" reference to member of not loaded task model not implemented (but designed)
-$execute, $getModel and $occurred  functions not implemented
-grounding queries (10.2) not implemented
-speech grammar (.gram) and properties files (.properties) should be
 internationalized using resource bundles
-import scheme for automatically loading speech grammar files (.gram) associated
 with task models only works for one task model at a time (due to limitation in
 JSGFGrammar only supporting one grammar at a time)
-many "TODO" notes scattered in source code, of varying priority

________________________________________________________________
