Sticklet README

Sticklet is an applet version of the Sticker desktop ticker application. It supports all the features of Sticker, except:

·         Persistent settings and messages. Messages and settings are lost when the applet closes down.

·         Online presence (“Who’s Online”).

See “sticklet.html” for a simple example of using Sticklet in a web page.

Configuration

Elvin

Since Sticklet is an applet, it is only guaranteed to be able to connect to an Elvin service on the same host that its page is served from, ie the web server and the Elvin server must be the same host (but see below). A partial workaround is to serve just “sticklet_object.html” from the host running Elvin, and embed this file within an IFRAME inside web pages served from other hosts. This still requires a web server on the Elvin host to serve “sticklet_object.html”, but does allow any number of other web servers to then field the Sticklet applet in their pages.  See “sticklet_iframe.html” for an example of using this approach.

As of release 2.2 Sticklet is a signed applet, using a certificate issued by Verisign to “Information Technology Division, Defence Science and Technology”. If you are using the Sun Java plugin (and you probably will, since there aren’t many other ways to run a Java 1.3 applet), you will be asked whether to trust the applet as signed, and in the case where you answer yes, Sticklet will have full application-level privileges, allowing it to connect to any host.

Using Sticker Settings

As of Sticklet 2.2, you can configure Sticklet using settings imported from its bigger brother, Sticker. This allows you to configure various advanced features, such as changing the default ticker stack, changing the ticker appearance and using message processing rules.

The Sticker settings that can be imported into by Sticklet are:

·         The Elvin service.         

·         The user’s name and ticker groups (including Advanced groups).

·         The ticker stack and ticker display options (ie the settings in the Options window’s “Ticker Scrollers” section).

·         All message processing rules and actions, including the actions associated with the user’s ticker groups.

To create a Sticklet settings file from saved Sticker settings:

1.      Download and extract a Sticker 2.2 binary distribution ZIP archive (eg sticker-2.2.0.zip).

2.      Create the Sticker settings file. Sticker’s settings are saved in a file called “settings.xbml” in the Sticker user home directory. This directory is by default the “.sticker2.2” subdirectory in the user’s home directory. If you don’t want to use your own Sticker settings, you can run Sticker with a different user home and set up a temporary configuration there. To run Sticker with an alternative user home, set the environment variable STICKER_USER_HOME to the directory you want to put the configuration in, eg

                [Windows] set STICKER_USER_HOME=c:\temp
                [csh]     setenv STICKER_USER_HOME /tmp
                [bash]    export STICKER_USER_HOME=/tmp

Then run “sticker.bat” (Windows) or “sticker.sh” (Unix) and set up your desired configuration. The settings will appear as “c:\temp\settings.xbml” or “/tmp/settings.xbml”.

3.      Import the Sticker settings into a Sticklet settings file using the “sticker2sticklet.jar” utility. The sticker2sticklet utility needs access to the Sticker JAR file, so ensure that “sticker2sticklet.jar” and “sticker.jar” are in the same directory. Then run sticker2sticklet:

              java –jar sticker2sticklet.jar
                –input c:\temp\settings.xbml
                -output settings.sticklet

This creates a “settings.sticklet” file in the current directory. If you see a “java.lang.NoClassDefFoundError”, this means that sticker.jar is not in the same directory as sticker2sticklet.jar, or is the wrong version.

4.      Tell Sticklet to use the settings via the “settings” parameter in the applet section of the HTML file where Sticklet is being hosted. The settings file will most often go in the same directory as the HTML, so the parameter will usually look like:

              <PARAM NAME="settings" VALUE="settings.sticklet">

Sticket prints the full URL of the settings file it is using to the console when it starts.

Applet Parameters

Sticklet’s ticker groups, Elvin server, user name, etc can be configured via applet parameters. In the case where you are using a Sticklet settings file (see above), these parameters will override the settings file. The user can also configure some of these settings while the applet is running. See “sticklet.html” for an example of using these parameters in a web page.

The available parameters are documented below. All have usable defaults in the case where they are not specified.

·         settings: A URL pointing to a settings file.

·         elvin: The Elvin server to connect to. Defaults to the host that Sticklet is being served from. This usually is not set, since the applet cannot connect to other servers unless security settings have been relaxed.

·         showToolbar: When set to “false”, the toolbar that usually appears below the tickers will be hidden. Default is “true”.

·         user: The name of the user on sent messages. Defaults to the login name of the current user if applet has sufficient privileges, “Sticklet User” otherwise.

·         chatGroups: A comma-separated list of initial chat groups eg “Chat,Sticklet Chat”.

·         newsGroups: A comma-separated list of initial news groups eg “CNN,ABC”.

Changes

Sticklet 2.3.1

·         Fixed bug where applet would fail to receive messages after being restarted (eg on page change/reload).

·         Installed “Chrome Metal” look and feel as default (although it doesn’t appear to install correctly under JRE 1.3.1).

Sticklet 2.3.0

·         Based on Sticker 2.3.0 release.

Sticklet 2.2.2

·         The message area of Sticklet's Messages window can now be resized.

Sticklet 2.2.1

·         Sticklet no longer ignores the “elvin” applet parameter.

·         Changing the username when sending a message no longer causes Sticklet to hang for 2 minutes waiting for server ACK.

Sticklet 2.2.0

·         Added ability to import Sticker settings.

·         Sticklet is now a signed applet, allowing it to read the current user’s login name (if the user grants it extended privileges).

More Information

 

Please contact the author of Sticklet and Sticker, Matthew Phillips for more information

      <matthew.phillips@dsto.defence.gov.au>