[Put building and running instructions on web page.
bringert@cs.chalmers.se**20050611101201] {
hunk ./Makefile 21
-DIALOGUTIL = ../dialogutil
+DIALOGUTIL = ../dialogutil/dialogutil.jar
hunk ./Makefile 34
-CLASSPATH=.:build:$(GFC2JAVA):$(DIALOGUTIL)/build:$(OAA_CP)
+CLASSPATH=.:build:$(GFC2JAVA):$(DIALOGUTIL):$(OAA_CP)
hunk ./Makefile 79
- cp -r $(DIALOGUTIL)/build/* jarcontents
+ cat $(DIALOGUTIL) | (cd jarcontents; jar -x se)
hunk ./README 3
-A demo dialog system using Java-GF.
+A multimodal demonstration dialog system using the Embedded GF Interpreter.
hunk ./README 6
-
-RUNNING
-
-This section describes how to run the compiled application using the
-binary distribution (tramdemo.jar). If you only have the source code,
-follow the instructions under BUILDING first.
-
-Requirements:
-
-You may need to change the file
-tramdemo_unix.props (for Unix) or tramdemo_win.props (for windows)
-to point to the software below:
-
-- Java JRE 1.5.0 (http://java.sun.com/j2se/1.5.0/download.jsp)
-
- The 'java' executable should be on the PATH.
-
-- OOA 2.3.0 (http://www.ai.sri.com/oaa/distribution/v2.3/)
-
- The environment variable OAA_HOME should point to the OAA installation.
-
-Speech recognition:
-
-(
- - Nuance Recserver
-
- AND
-
- - NuanceWrapper
-)
-
-Speech synthesis:
-
-(
- (
- - Nuance Vocalizer
-
- OR
-
- - RealSpeak NUTTS
-
- Change the variable REALSPEAK in tramdemo_win.props
- )
-
- AND
-
- - NuanceWrapper
-)
-
-OR
-
-(
- - FreeTTS (http://freetts.sourceforge.net/)
-
- Check tramdemo_unix.props or tramdemo_win.props:
- FREETTS should to point to the FreeTTS installation.
-
- AND
-
- - FreeTTSAgent (http://www.ling.gu.se/projekt/talk/software/)
-
- Check tramdemo_unix.props or tramdemo_win.props:
- FREETTSAGENT should to point to the FreeTTSAgent installation.
-)
-
-
-Unix:
-
-$ ./tramdemo_speech.sh
-
-Windows:
-
-> ./tramdemo_speech.bat
-
-
-
-BUILDING
-
-Requirements:
-
-- GF 2.2 (http://www.cs.chalmers.se/~aarne/GF/)
-- Java SDK 1.5.0 (http://java.sun.com/j2se/1.5.0/download.jsp)
-- OOA 2.3.0 (http://www.ai.sri.com/oaa/distribution/v2.3/)
-- gfc2java (http://www.cs.chalmers.se/~bringert/gf/gf-java.html)
-- dialogutil (http://www.cs.chalmers.se/~bringert/gf/dialogutil.html)
-- TrindiKit java classes (???)
-
-Building:
-
-- Modify the Makefile to point to your javac, OAA, gfc2java etc.
-
-- Build tramdemo.jar:
-
-$ gmake
-
-- Run OAA start-up script:
-
-On Unix:
-
-$ ./tramdemo_speech.sh
-
-On Windows:
-
-$ ./tramdemo_speech.bat
-
-
-NOTES:
-
-To get the FreeTTS 1.2beta2 Java Speech API stuff working on my machine with
-JDK 1.5.0 RC, the system property
-com.sun.speech.freetts.voice.defaultAudioPlayer
-must be set to:
-com.sun.speech.freetts.audio.JavaClipAudioPlayer
-
+For instructions for running and building the system, see
+doc/tramdemo.html
hunk ./doc/tramdemo.html 19
-
Documentation
+Demo Movie
hunk ./doc/tramdemo.html 21
-
-The
-README
-file describes how to build and run the program.
-
-
-The TALK project
-deliverable D1.2a describes the use of multimodal grammars in dialogue
-systems. Section 3 of the deliverable details the
-grammars used by the tramdemo application.
-
-Demo
-
hunk ./doc/tramdemo.html 23
-of a demo of the Tramdemo system.
+of a demo of the Tramdemo system. It is a bit old, and the current
+system has a few more features than shown in the video.
hunk ./doc/tramdemo.html 28
-Compiled Tramdemo program.
+Compiled Tramdemo program.
hunk ./doc/tramdemo.html 30
-Source code and grammars.
+Source code and grammars.
hunk ./doc/tramdemo.html 37
+Documentation
+
+The TALK project
+deliverable D1.2a describes the use of multimodal grammars in dialogue
+systems. Section 3 of the deliverable details the
+grammars used by the tramdemo application.
+
+Running
+
+
+This section describes how to run the binary version of the system.
+If you want to modify the system, see the section Building.
+
+
+Download
+
+
+Get the latest
+binary
+package of the Tramdemo system, and unpack it.
+
+
+Requirements for running
+
+
+In order to run the Tramdemo system, you need to have the following software
+installed:
+
+
+
+
+-
+Java JRE
+1.5.0. The java executable should be on the path, or you can
+set the variable JAVA in tramdemo_{unix,win}.props (for Unix
+and Windows, respectively).
+
+
+-
+OOA 2.3.0.
+The environment variable OAA_HOME should point to the OAA installation.
+
+
+-
+A speech recognizer (optional, only needed if you run TramDemo SR, see
+below). Currently supported are:
+
+-
+Nuance Recserver (English.America or Swedish) with NuanceWrapper.
+The NUANCE environment variable should point to the Nuance installation.
+
+
+
+
+-
+A speech synthesizer (optional, without it you will only
+get map output, the speech output can be seen in the output window:
+View -> Show output window). Currently supported:
+
+
+- Nuance Vocalizer 4.0 (US English), with NuanceWrapper.
+- RealSpeak (Swedish), with NuanceWrapper. Set the variable
+REALSPEAK in tramdemo_win.props to point to the RealSpeak installation.
+- FreeTTS.
+Set FREETTS in tramdemo_{unix,win}.props
+to point to the FreeTTS installation. You also need
+FreeTTSAgent.
+Set FREETTSAGENT in tramdemo_{unix,win}.props
+to point to the FreeTTSAgent installation.
+
+
+
+
+
+
+
+
+Running
+
+
+
+-
+Start the starter GUI:
+Unix:
+
+$ ./tramdemo_speech.sh
+
+
+Windows:
+
+> ./tramdemo_speech.bat
+
+
+
+- (First time, or after modifying the input grammars)
+Compile the speech recognition grammar:
+Compile English Query GSL Grammar -> Start or
+Compile Swedish Query GSL Grammar -> Start
+
+
+- Start the Facilitator.
+
+- Start the speech recognizer. Start either of these:
+
+- Nuance (English)
+-
+Start Nuance Recserver license manager and
+Nuance Recserver (English).
+
+- Nuance (Swedish)
+-
+Start Nuance Recserver license manager and
+Nuance Recserver (Swedish).
+
+
+
+
+-
+Start the speech synthesizer. Start either of these:
+
+- Nuance Vocalizer (English)
+-
+Start Nuance Vocalizer license manager and
+Nuance Vocalizer (English).
+
+- RealSpeak (Swedish)
+-
+Start RealSpeak (Swedish).
+
+- FreeTTS (English)
+-
+Start FreeTTSAgent.
+
+
+
+
+-
+(Only if you use Nuance Recserver, Nuance Vocalizer or RealSpeak)
+Start NuanceWrapper. Choose English or Swedish depending on the
+language used for speech recognition and synthesis.
+
+
+- Start GFAgent (used for parsing and linearization).
+- Start QueryInterpreterAgent (simplifies queries).
+- Start GraphAgent (calculatess shortest paths).
+- Start MapAgent (shows the map and receives clicks).
+
+-
+Start the main application agent (a very simple dialogue manager).
+You can use either of these agents:
+
+- TramDemo SR
+- Uses input from a speech recognizer
+- TramDemo Text
+- Gets input from a dialog window.
+
+
+
+
+
+
+
+
+Requirements for building
+
+
+To build the system, you need the following system:
+
+
+
+-
+GF 2.2.
+The gf executable should be on the path, or you can
+set the variable JAVA in the Makefile.
+
+
+-
+Java JRE
+1.5.0. The javac executable should be on the path, or you can
+set the variable JAVA in the Makefile.
+
+
+-
+OOA 2.3.0.
+The environment variable OAA_HOME should point to the OAA installation.
+
+
+-
+gfc2java.
+Set the variable GFC2JAVA in the Makefile to point to the gfc2java
+JAR file.
+
+
+-
+dialogutil.
+Set the variable DIALOGUTIL in the Makefile to point to the dialogutil
+JAR file.
+
+
+
+
+Compiling
+
+
+-
+Build tramdemo.jar;
+
+$ gmake
+
+
+
hunk ./tramdemo.config 1
-projectlist run compile
+projectlist run
hunk ./tramdemo.config 7
-projects compile
+projects run
hunk ./tramdemo.config 13
-projects compile
+projects run
hunk ./tramdemo.config 24
-appname Nuance recserver license manager
+appname Nuance Recserver license manager
hunk ./tramdemo.config 30
-appname Nuance recserver (English)
+appname Nuance Recserver (English)
hunk ./tramdemo.config 36
-appname Nuance recserver (Swedish)
+appname Nuance Recserver (Swedish)
hunk ./tramdemo.config 48
-appname Nuance vocalizer (English)
+appname Nuance Vocalizer (English)
hunk ./tramdemo.config 92
-appname GraphAgent
-oaaname GraphAgent
+appname QueryInterpreterAgent
+oaaname QueryInterpreterAgent
hunk ./tramdemo.config 96
-appline ${JAVA} se.chalmers.cs.gf.graph.GraphAgent gbg.properties -oaa_connect tcp('${Host}',${FAC_PORT})
+appline ${JAVA} se.chalmers.cs.gf.tramdemo.QueryInterpreterAgent gbg.properties -oaa_connect tcp('${Host}',${FAC_PORT})
hunk ./tramdemo.config 100
-appname QueryInterpreterAgent
-oaaname QueryInterpreterAgent
+appname GraphAgent
+oaaname GraphAgent
hunk ./tramdemo.config 104
-appline ${JAVA} se.chalmers.cs.gf.tramdemo.QueryInterpreterAgent gbg.properties -oaa_connect tcp('${Host}',${FAC_PORT})
+appline ${JAVA} se.chalmers.cs.gf.graph.GraphAgent gbg.properties -oaa_connect tcp('${Host}',${FAC_PORT})
}