upstream version 1.2.2
[debian/freetts] / demo / JSAPI / WebStartClock / README.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
2 <html>
3   <head>
4     <title>FreeTTS Web Start Clock</title>
5   </head>
6
7   <body bgcolor="#FFFFFF">
8
9       <table bgcolor="#FFCC66" width="100%">
10           <tr>
11             <td align=center width="100%">
12               <h1>FreeTTS Web Start Clock</h1>
13             </td>
14           </tr>
15       </table>
16
17       <p>This demo shows how to use FreeTTS with Java<sup>TM</sup> Web
18       Start.  With Java Web Start, you launch applications simply by
19       clicking on a Web page link. If the application is not present
20       on your computer, Java Web Start automatically downloads all
21       necessary files. It then caches the files on your computer so
22       the application is always ready to be relaunched anytime you
23       want -- either from an icon on your desktop or from the browser
24       link. And no matter which method you use to launch the
25       application, the most current version of the application is
26       always presented to you.  
27
28       <p><h2>Setup</h2>
29
30       <p><h3>Web Server</h3>
31
32       <ol>
33         <li>Your web server must be configured to return the proper
34         MIME type for the JNLP content. Refer to the Java<sup>TM</sup>
35         Web Start Developer's Guide, 
36         <a href="http://java.sun.com/products/javawebstart/1.2/docs/developersguide.html#website">
37         Setting up the Web site</a>, for details.
38       </ol>
39
40       <p><h3>Client</h3>
41
42       <ol>
43         <li><b>Download and install Java Web Start.</b> Java Web Start
44         is already included in the latest version of
45         J2SE<sup>TM</sup>. Since you will need J2SE version 1.4 for
46         FreeTTS, no extra download and installation should be
47         required. Refer to the 
48         <a href="http://java.sun.com/products/javawebstart/1.2/docs/installguide.html">
49         Java Web Start Installation Guide</a> for installation. It
50         also tells you how to set up your web browser appropriately, which
51         normally means handling the Java Web Start MIME type
52         (<code>"application/x-java-jnlp-file"</code>) using the
53         <code>javaws</code> executable file in your Java Web Start
54         directory.
55
56         <li><p><b><font color="ff0000">IMPORTANT:</font> Edit the file
57         clock.jnlp</b>. Change the <code>"&lt;jnlp
58         codebase="..."&gt;"</code> tag to point to the absolute URL
59         of this directory, e.g.,
60         <code>codebase="http://www.yourwebsite.com/FreeTTS/demo/JSAPI/WebStartClock"</code>. 
61         Unfortunately, the codebase attribute currently cannot be
62         relative. For more
63         information, refer to the 
64         <a href="http://java.sun.com/products/javawebstart/faq.html#50">
65         Java Web Start FAQ</a>. Moreover, if you use file URLs (e.g.,
66         "file:/home/usr1/..."), it might not work properly on
67         differently platforms. So we encourage you to use HTTP
68         URLs.
69
70         <p>If you have created your own voice for the time
71         domain (see <a
72         href="../../../tools/FestVoxToFreeTTS/README.html">FestVoxToFreeTTS</a>),
73         you can modify <code>clock.jnlp</code> to tell it to use your
74         voice.  Merely change the following line in
75         <code>clock.jnlp</code> to use the class name of the
76         <code>VoiceDirectory</code> for your voice:
77         <ul>
78             <code>&lt;property name="freetts.voices"</code>
79             <code>          value="com.sun.speech.freetts.en.us.cmu_time_awb.AlanVoiceDirectory"/></code>
80         </ul>
81
82         <li><p><b>Build WebStartClock</b>.  If you are not planning on
83         making any changes to WebStartClock, you do not need to
84         rebuild anything.  However, if you would like to make changes
85         to WebStartClock and would like to rebuild it, run the
86         following command:
87         <ul>
88             <code>ant -find demo.xml deploy_webstartclock</code>
89         </ul>
90         <p>This will create a WebStartClock.tar file containing all
91         the files you need to copy to your web server.  Note that you 
92         must also unpack <code>jsapi.jar</code> to build the
93         WebStartClock.  See <a href="../../../docs/jsapi_setup.html">
94         how set up your environment to use JSAPI</a> to unpack
95         <code>jsapi.jar</code>.
96       </ol>
97
98       <p><h2>Demo</h2>
99
100       <img src="webstartclock.jpg">
101
102       <p>After you have done the "Setup" above, launch the Web Start Clock demo by clicking on this link: <h4><a href="clock.jnlp">Launch</a></h4>
103
104         <p>You can also run this demo locally without needing to use Web
105         Start.  To run this demo, type the following command from a command
106         window at the top level FreeTTS directory:</p>
107         <ul>
108             <p><code>java -jar bin/WebStartClock.jar</code></p>
109         </ul>
110     
111       <hr>
112
113 See the <a href="../../../license.terms">license terms</a> and <a href="../../../acknowledgments.txt">acknowledgments</a>.<br>Copyright 2001 Sun Microsystems, Inc.  All Rights Reserved.  Use is subject to license terms.
114
115   </body>
116 </html>