| Parameter |
Values |
Description |
| Connection
Properties |
| Server |
A valid domain name or IP address. |
This determines where the applet should look for the WebChat
server. Normally this does not need to be set. The server must be in the
same domain as the web server which server the applet. |
| Port |
A valid port number. |
Connects to Server on the specified port number.
Default value is 2513. |
| Login |
Any string without spaces. |
The login name for the user. |
| Password |
Any string without spaces. |
The password for the user. |
| LoginPrompt |
yes - displays the login panel to prompt for a
username and password.
no - does not show the login panel (default). |
Ideally you should use ASP or some other dynamic content
generation mechanism to ask for a username and password and check it
against a database. For implementations where this is not possible,
LoginPrompt may be set to "yes". |
| Room
List |
| DefRoom |
The name of a room on the server. |
This specifies which room to start in. If this is not
specified or is an invalid room, the user will start in the default room
for the server. |
| HideRooms |
yes - hides the list of rooms on the server.
no - shows the list of rooms on the server (default). |
If you have multiple rooms on one server but don't want
people to move between rooms you can set this option to 'yes'. Use it in
conjunction with the 'DefRoom' parameter to send users to a
particular room, which they can't change. |
| RoomOverride |
yes - ignores the list of rooms sent by the server. .
<blank> - displays the list of room sent by the server
(default). |
This option will show the room list panel, but will not fill
it automatically. Instead you should use the Roomn parameters
listed below to populate the list. The purpose of this flag is to let you
have rooms for several different websites on one server - you can then
override the room list to display only the rooms which are relevant for a
particular site. |
| Roomn |
A valid name of a chat room on the server. |
This option lets you populate the room list manually. The
rooms may be private or public. The first room is Room1. |
| Chat
Appearance |
| Background |
The URL of a background image. |
This is displayed behind the text when the applet loads. It
can be displayed in the left corner or tiled across the background. |
| BgType |
tile - tiles the image set above across the
background (default).
topleft - displays the picture in the top left.
|
Sets the location of the picture set by the 'background'
parameter. |
| PanelColour |
Hexadecimal HTML colour value (#rrggbb).
|
Sets the colour for the panels. The panels are at the bottom
and the right - they hold the chat text box and the user/room lists. |
| PanelTextColour |
Hexadecimal HTML colour value (#rrggbb).
|
The text colour for the panels. |
| LoginColour |
Hexadecimal HTML colour value (#rrggbb).
|
The background colour for the login panel. |
| LoginTextColour |
Hexadecimal HTML colour value (#rrggbb).
|
The text colour for the login panel. |
| Border |
yes - displays a border around the chat window
(default).
no - does not show a border.
|
You might wish to turn the border off to define your own
"virtual border" with images surrounding the chat applet. |
PMButtonImage
PMButtonDisabledImage
IgnoreButtonImage
IgnoreButtonDisabledImage
ProfileButtonImage
SendButtonImage
SendButtonDisabledImage
GotoRoomButtonImage |
A valid URL.
|
These options define the images for the Private Message (PMxxx),
Ignore (Ignorexxx), Profile (Profilexxx), Send (Sendxxx) and Goto
Room (GotoRoomxxx) buttons. |
RoomButtonImage
RoomButtonActiveImage
UserButtonImage
UserButtonActiveImage |
A valid URL.
|
These define the images for the Room (Roomxxx) and User (Userxxx)
tabs. The "Active" images are shown when that tab is shown. |
| |
|
|
| Misc. |
| ReadyURL |
The URL of an HTML or ASP page. |
This page is displayed when the applet has finished loading.
The applet can take a while to load the first time - you can use a
frameset with a 'Loading...please wait' message to indicate that the
applet is loading. Then, when it has finished, the applet could load an
advertising page into the frame. YOU MUST SET THE 'readytarget ' PARAMETER
IF YOU WISH TO USE THIS METHOD. |
| ReadyTarget |
A frame or window name. |
This specifies where the 'readyurl' file will be displayed. |
| UserEnterSound |
A valid .au sound file. |
The specified sound is played whenever someone enters the same room as the user. |
© 2000-2005, Ashley Brown. Questions, comments
or problems? Contact 
Ashley Brown
ITC Internet
