Previous Next Up FAQ Table of Contents

7.1.1 VolanoChat Parameters

The applet tag

The minimal applet HTML tag for the VolanoChat client applet is shown below:

<applet codebase="http://hostname/vcclient"
        archive="COM/volano/VolanoChat.jar"
        code="COM.volano.VolanoChat.class"
        width="500" height="60">
<param name="cabbase" value="COM/volano/VolanoChat.cab">
</applet>

where hostname is the name of the host running the VolanoChat server. A sample applet HTML tag with all possible parameters is shown below, with each parameter set to its default value:

<applet codebase="http://hostname/vcclient"
        archive="COM/volano/VolanoChat.jar"
        code="COM.volano.VolanoChat.class"
        width="500" height="60">
<param name="cabbase"    value="COM/volano/VolanoChat.cab">
<param name="monitor"    value="false">
<param name="admin"      value="false">
<param name="member"     value="false">
<param name="stage"      value="false">
<param name="public"     value="false">
<param name="color"      value="">
<param name="foreground" value="">
<param name="group"      value="">
<param name="topic"      value="">
<param name="text"       value="english.txt">
<param name="username"   value="">
<param name="profile"    value="">
<param name="password"   value="">
</applet>

For example the following attributes:

<applet codebase="http://hostname/vcclient"
        archive="COM/volano/VolanoChat.jar"
        code="COM.volano.VolanoChat.class"
        width="500" height="60">
<param name="cabbase" value="COM/volano/VolanoChat.cab">
<param name="color"   value="#FFFFFF">
<param name="group"   value="John's Chat Room">
<param name="text"    value="english.txt">
</applet>

define a white background color on the Web page, a name for the chat room, such as "John's Chat Room," and the default English client applet properties file. Each of the applet attributes and parameters is defined below.

Applet tag attributes

For a complete description of the HTML applet tag, see The Applet Tag documentation on Sun's Web site. The attributes of the VolanoChat HTML applet tag are:

codebase
the location of the VolanoChat client applet and all of its files. By default, this location is the directory vcclient that you made publicly available through a virtual link or directory when you installed VolanoChat.
archive
the location of the JAR applet archive, relative to the applet codebase. Applet archives allow the applet to be downloaded all at once so that it has better performance while running. The JAR archive is used by most non-Microsoft browsers, and is also supported by the newer Microsoft browsers if no CAB archive is available. Microsoft browsers use CAB archives first, defined in the next section below. Some older browsers only supported the use of ZIP archives, and a ZIP file is included in VolanoChat, though its use is deprecated. If a browser cannot read the archive format of the applet, it downloads the applet's Java class files one at a time.
code
the name of the applet's main Java class file.
width
the width in pixels of the applet on the Web page.
height
the height in pixels of the applet on the Web page.

VolanoChat applet parameters

The VolanoChat applet parameters are:

cabbase
the location of the CAB applet archive, relative to the applet codebase. CAB archives are used by Microsoft browsers. Newer versions of Internet Explorer also support JAR archives as a secondary option is no cabfile is available.
monitor
indicates whether to enable monitoring capabilities for the VolanoChat applet. When used with the correct monitor password, the monitor entrance allows you to remove people from a chat room, kick people out of the VolanoChat server, or ban them permanently from entering. The default value is false.
admin
indicates whether to enable administrative capabilities for the VolanoChat applet. When used with the correct administrator password, the administrator version provides all functions of the monitor version plus the ability to broadcast chat messages into all public and personal chat rooms of the server. The default value is false.
member
indicates whether to enable member capabilities for the VolanoChat applet, prompting for a member name and password on the applet's Web page. Member access functions only when you have provided the member access scripts defined in the [5.7] Member Database Support section. The default value is false.
stage
indicates whether this applet is a stage entrance of an event auditorium. If true, the address of the containing Web page must be authorized to create event auditoriums by matching the VolanoChat server entrance.stage prefix. The default value is false.
color
the color you want for the background of the area occupied by the VolanoChat applet on the Web page. You will most likely want to choose a color to match the background of your Web page. Use the same notation of #RRGGBB as the bgcolor attribute of the Web page body tag, where RR is the red hexadecimal value, GG is the green hexadecimal value, and BB is the blue hexadecimal value. The default color is the default defined by the Web browser.
foreground
the color you want for the foreground text of the area occupied by the VolanoChat applet on the Web page. You will most likely want to choose a color to match the text color of your Web page. Use the same notation of #RRGGBB as the color attribute of your Web page font tag, where RR is the red hexadecimal value, GG is the green hexadecimal value, and BB is the blue hexadecimal value. The default color is the default defined by the Web browser.
group
the name of the chat room you want created automatically when someone enters VolanoChat from the Web page. You can create different Web pages for different chat rooms. People who start the VolanoChat applet can see all of the chat rooms available, no matter through which Web page they entered. If you omit this parameter, no room for the Web page will be created, but people will still be able to enter any other room in the server.
topic
specifies the topic of the live event, if this applet is a stage entrance creating an event auditorium.
text
the translated text and properties for the applet. The default language is English, specified by english.txt. Instead of English, you can also specify french.txt, german.txt, italian.txt, portuguese.txt, spanish.txt, or any other property file you define. This property file is also used to control colors and fonts, menu selections, embedded applets, and much more. See section [7.1.2] VolanoChat applet properties file.
username
the user nickname or member name to use. This parameter can be supplied by a server-side include or CGI script in order to automatically fill in the name with a registered member name.
profile
the user profile to use on the main chat window. This parameter can be supplied by a server-side include or CGI script in order to automatically fill in the profile text with a registered member profile or any other text. A complete URL (http://...) supplied in this parameter will display a clickable link (opening in a new browser window) when the user's name is selected in a list of users.
password
the member password to use. This parameter can be supplied by a server-side include or CGI script in order to avoid requiring members to type in a password to the VolanoChat applet when they have already supplied a password to enter the Web site.

Previous Next Up FAQ XHTML 1.0 Table of Contents

2014-07-11 — An updated version of the VOLANO chat server that supports the latest Java 8 Plug-in is now available. More…

The VOLANO® chat software for the Java™ platform lets you build on-line communities and add real-time social networking to your Web site. More…

John Neffenger <john@status6.com>
More…

A PROJECT OF STATUS:6®