Installation
To install the SpecheBox Applet, please read the entire installation
document, and then perform each Step in the listed order. As it is currently
written, all code presented in this document must be added to the same web page
or frame.
Step 1: Copy the JavaScript code below, and paste
it in between the header tags on your web page (<head>...</head>).
This code contains all of script that communicates with the applet.
Step 2: Copy the following code and paste it into
the Body tag. This code will initiate a search for a preference cookie on the
client. Example: <body onload="GetSettings();">
Step 3: Copy the following code and paste it into
the body of your web page, at the location where you would like the text
display to be located. This code will cause the SpecheBox Applet to be
downloaded, initialized, and displayed. The applet will connect to Speche
Communication's Text Server at text.speche.com on port 80. Additionally, this
code section renders all of the configuration options and transcript button for
the client, assuming that JavaScript is enabled.
Step 4: Load the web page in a browser. Validate
that text is streaming to the applet, by viewing the display. You should see
text scrolling within the applet display. If the applet is displaying text,
please test the customization options offered. Please note that the buttons and
selection boxes utilize approximately 40 pixels of space below the applet
display. Please pay special attention to the available font sizes, with regard
to the size of the display area. Instructions on how to modify the display and
customization options are listed in the next section of this document. If you
encounter any difficulties, or have any questions regarding implementation of
the provided code, please contact:
Courtroom Connect and Speche Support
Phone: (877) 838-9080
E-mail: support@speche.com
Step 5: Upon validation of the streaming text,
please contact Speche Communications, Inc. to confirm the successful applet
installation.
Step 6: After the applet installation has been
confirmed, we will send you a new EventID for the production event. This
EventID will need to be pasted into the value attribute of the applet's EventID
parameter tag. Example: <Param name="EventID"
value="25E9D359-69CB-4A30-A103-D02E0B986042"> Prior to the production event,
we will be sending a continuous loop of text over the connection to validate
that the transition to the new EventID has been successful.
Customization Options and Applet Parameters
Default Applet Parameters (please review the options below for valid
options for each parameter):
Width = 500 and Height = 182
<applet name="jtext1" id="jtext1"
code="com.speche.userinterface.Caption.class" width=500 height=182 ...>
Branding=1
<Param name="Branding" value="1">
InitialText=""
<Param name="InitialText" value="">
ForgroundColor (Text) = #FFFFFF (white)
<Param name="ForegroundColor" value="#FFFFFF">
BackgroundColor = #000000 (black)
<Param name="BackgroundColor" value="#000000">
Font = SansSerif
<Param name="Font" value="SansSerif">
FontSize = 14
<Param name="FontSize" value="14">
Size of the Applet Display:
There are two variables that were copied to your web page during Step 3 of the
installation process - width (default = 500) and height (default = 182). These
variable are present within the Applet tag (<applet...>). These two
values can be modified to fit the display area into a specific region of your
web page. Please keep in mind that the size of the display area impacts the
users ability to read the displayed text. Additionally, the values offered for
Font Size should be considered when the display size is altered.
Fonts:
Valid Font names for the Applet are:
SansSerif
Serif
Monospaced
Fonts may be removed at your discretion by removing Option tags from the Jfont
selection box. Addition fonts are not supported by most browser / applet
combinations.
Colors:
The applet supports the full RGB color range (#000000 - #FFFFFF) for the text
and background colors in the applet display. The subset of offered colors were
chosen to support high contrast combinations, and the use of popular named
colors. You may add or remove colors at your discretion by adding or removing
Option tags from both the JFGColor, and the JBGColor selection boxes.
Font Size:
The font size is set in points per inch just like Microsoft Word. There are two
variables that were copied to your web page during Step 1 of the installation
process - MinFontSize (default = 10) and MaxFontSize (default = 40). These
values to can be modified to limit the font size values offered to the user by
the JFontSize selection box.
Initial Text:
The value of this parameter sets the initial text that will be displayed to all
users when the SpecheBox is initially loaded. Use "\r\n" to indicate a carriage
return. Example: <Param name="InitialText" value="Welcome\r\nto the web
cast">
This would display as follows:
Welcome
to the web cast
Branding:
Setting this parameter to "0" will turn off the Speche Communications branding.
Turning this off may affect the cost of your event. Please contact your
Customer Service Representative for details regarding branding and how it
relates to cost.
General Notes and Information
It is advisable to use the above methodology for loading the applet. Loading
the applet from our server insures that you always have the newest version of
our SpecheBox Applet and that your users are getting the richest set of
available features.
It should be noted that the applet that you will be loading is using HTTP to
connect from the applet to the Text Server over port 80. This allows us to
connect from the applet to the Text Server, traverse virtually all standards
compliant firewalls and proxy servers.