📄 readme.txt
字号:
FILE TYPE must be supported by java's getAudioClip(...)
URL must be relative to the applet dir and <= 256 characters
default: the oops.au in applet dir
Ex. <param name="messageDingURL" value="sounds/yourOOPsClip.au">
cloneOnDingURL URL of the audio file played when a user selects a clone point
FILE TYPE must be supported by java's getAudioClip(...)
URL must be relative to the applet dir and <= 256 characters
default: the cloneOn.au in applet dir
Ex. <param name="cloneOnDingURL" value="sounds/yourCloneClip.au">
passVisible show the password field on the login screen
OPTIONAL - values: [true|false] - default: true
Ex. <param name="passVisible" value="false">
emailVisible show the email field on the login screen
OPTIONAL - values: [true|false] - default: true
Ex. <param name="emailVisible" value="false">
urlVisible show the URL field on the login screen
OPTIONAL - values: [true|false] - default: true
Ex. <param name="urlVisible" value="false">
tourCheckboxVisible show the Excursions checkbox
OPTIONAL - values: [true|false] - default: true
Ex. <param name="tourCheckboxVisible" value="false">
tourSelected initial state of Excursions checkbox (Note 2)
OPTIONAL - values: [true|false] - default: true
Ex. <param name="tourSelected" value="false">
usersVisible display user list?
OPTIONAL - values: [true|false] - default: true
Ex. <param name="usersVisible" value="false">
userInputVisible display the message Input field? (NOTE: 3)
OPTIONAL - values: [true|false] - default: true
Ex. <param name="userInputVisible" value="false">
floatVisible display the FLOAT button?
OPTIONAL - values: [true|false] - default: true
Ex. <param name="floatVisible" value="false">
quietTimeout number of minutes that a user can be quite before
being automatically logged off (NOTE: 3 & 4)
OPTIONAL - default: 10 (minutes)
Ex. <param name="quietTimeout" value="60">
THESE ADDITIONAL APPLET PARAMETERS ARE ALSO SUPPORTED due to
a substancial number of requests to add them -
HOWEVER - WE ABSOLUTELY DO NOT RECOMMEND USING THESE PARAMETERS
IF SECURITY IS AT ALL AN ISSUE BECAUSE THE USER"S PASSWORD WILL BE
VISIBLE IN THE HTML SOURCE OF THE PAGE ON WHICH THE APPLET RESIDES.
If you do use these, we suggest that you at LEAST expire the page on
which the applet resides so, if a user leaves the page, he cannot back
up to it and view the page's source --- this won't help in some browsers,
particularly some IE versions which ignore expirations once a page is
in memory - but you should peobably at least TRY.
autoLogin if true, will automatically attempt login when applet loads
OPTIONAL - values: [true|false] - default: false
Ex. <param name="autoLogin" value="true">
NOTE - if true then at least the userName parameter must
also be used and valued.
userName user name to be placed in the "Handle" input field.
OPTIONAL - default: blank - limit: 8 characters
Ex. <param name="userName" value="joe">
NOTE: REQUIRED if autoLogin is true
userPass user's password to be placed in the "Password" input field.
OPTIONAL - default: blank - limits: 20 characters
Ex. <param name="userPass" value="j6l3B4t">
NOTE: REQUIRED if autoLogin is true AND this user
has a user id and password for the room
userEmail user's email address to be placed in the "Email" input field.
OPTIONAL - default: blank - limit: 128 characters
Ex. <param name="userEmail" value="joe@whatever.com">
userURL user's URL to be placed in the "URL" input field.
OPTIONAL - default: blank - limit: 128 characters
Ex. <param name="userURL" value="http://www.hav.com/">
Applet Parameter Notes:
=======================
1. all color parms may be one of the following:
"black", "blue", "red", "white", "green", "yellow",
"pink", "orange", "magenta", "lightgray", "gray",
"darkgray", "cyan"
- OR an RGB specification with/without a leading "#"
character
2. the tourSelected parameter is important when you chhose not to
display the Excursions checkbox (i.e. when tourCheckboxVisible = false)
3. set the quietTimeout attribute longer in cases where a user might be
expected to be quite for longer periods - like in a moderated room or
when using an Audit (listen only) applet.
4. the quietTimeout attribute does not affect ADMIN or MODERATOR users.
INSTALLATION AND USE:
=====================
PLEASE review the following information before installing the havChat Server.
BEFORE RUNNING THE SERVER:
==========================
1. When you unpack this distribution, you will find several directories:
- web: this directory contains the files and subdirectories that
you will need to (eventually) copy to your web server space - for
example, it contains several example html pages (for both the FULL
and the LITE demo applets) and the sub directory to hold the applets
themselves.
- web|applet: the applet directory contains the demo applets' jar files
along with various support files like various graphic and sound files.
- shortcut: this is just an example Windows shortcut if you are running
on a Windows platform.
- server: the server directory contains the chat server pieces.
The contents of this directory and its subdirectories will NOT be
placed "on the web" but will exist and must be run from the same
domain from which the applets will be run. (If this is not clear,
speak to your webmaster - explain that you have a server application
that must run from the same domain that you will use to serve out
the applets).
THE STRUCTURE OF THIS server DIRECTORY SHOULD NOT BE CHANGED -
Its sub directories contain two example rooms - each with
one or more example password protected users.
WE STRONGLY SUGGEST THAT YOU PLACE THE server DIRECTORY AND
IT'S SUB DIRECTORIES IN A DIRECTORY THAT IS NOT ACCESSIBLE
FROM OR BY THE WEBSERVER - THE WEBSERVER DOES NOT NEED ACCESS
TO ANYTHING HERE. --- AND RUN THE CHAT SERVER AS AN UNPTIVILEGED USER.
2. edit the two example Room.conf files (rm1, rm2) to set appropriate
URLs from which applet connections will be allowed.
You may now specify wildcards as part of the FILE portion of any
URL allowed by a room. So, for example, if I want to allow pages from
anywhere at or under http://www.hav.com/new/ to contain the havChat applet,
I could specify a room's allowed url as http://www.hav.com/new/*
ALSO - URL protocol and host parts will compare for equality using
standard java URL handling -- so ...
http://www.hav.com/ is the same as http://HAV.com
... in my case anyway :-)
Multiple URLS can be specified on one line (separated by spaces)
or with multiple "url = ..." lines in the Room.conf file.
3. edit the example index.htm, indexIE.htm, mini.htm and miniIE.htm html
pages to change the CODEBASE and HOST attributes of the applet tag as
needed to point to YOUR server and where you have placed the web/applet
directory.
4. If you run the server on something other than the default port (4333),
then you should also edit the PORT attribute of the applet tags as well.
RUNNING THE SERVER
==================
To run the chat server, use a command like...
java havChatServer2000Eval [xxxx]
... where xxxx is an optional port number on which socket connections
will be made - default is port 4333.
The chat server can only be run on a version 1.1 (or later) Java Virtual
Machine.
There are several example password protected users defined in the demo rooms
provided.
id: demoadmi (NOTICE - NO "final "n")
pass: demoadmin
id: guest
pass: demoguest
RUNNING THE CLIENT
==================
The client is distrubited with demo applets signed for both Netscape and IE.
There are two flavors of applet for each: one for the FULL applet demo
and the other for the "Lite" applet demo.
The Full demo includes the whiteboard support - the Lite version does not.
Example html pages which illustrate the form of the applet tags required
are included in both the web and the web/applet directories
Both applets include features which, if used, require more privilege than
is available to a standard applet. SO, both jar files are digitally signed
and will ask for such additional privilege when needed.
The specific features that require additional privilege are:
1) saving a chat log** to your local machine (SEE KNOWN PROBLEMS)
2) saving a copy of the whiteboard picture to your local machine and
3) printing a copy of the whiteboard on a printer attached to your
local machine.
No additional privileges are required or requested except for these three
activities.
INCOMPLETE or MISSING FEATURES
==============================
Generally speaking, the system administration functionality is incomplete.
Certain functions are fully implemented while others are not implemented
at all. Several functions are implemented as interim manual processes which
might include use of a stand alone utility program.
1. ADDING A ROOM - still a manual process
- add the room id to the server.conf file
- add a directory named the same as the room id
- make a new room.conf in the room's directory
- add a users directory below the room's directory
- add at least ONE admin user .conf to the room, thereafter
you can use the applet's %admin command to manage room users
To add the first admin user to a room, you might just copy
an admin user's .conf file from some other room - if not, you
will need to use the initUser.class (provided in source and class
forms) to initialize the user's password.
if you DO need to run the initUser.class application to create
a version of the user's .conf file which will have the password
encrypted as required - you need to ...
java initUser roomID uid password_text
i.e. like java initUser rm1 hav abcdefg
There are several example password protected users defined in the demo rooms
provided.
id: demoAdmi (NOTICE - NO "final "n")
pass: demoadmin
id: guest
pass: demoguest
2. ADDING PROTECTED and ADMIN USERS TO A ROOM - applet command
- once there is at least one admin user for a room, he can simply
use the "%admin" command from either demo applet to get the user
management GUI. Using the GUI he can add, edit and delete password
protected users in the room.
3. KNOWN USER ID's MUST BE LOWERCASE
- this is sort of a bug and sort of a workaround for Microsoft's
lack of case sensitivity. For now user id's for users with
passwords, should be lower case only. This restriction will
be lifted in future releases.
GENERAL INFO:
===============
- User privileges are shown to the right of the user ID:
A indicates ADMIN privilege.
M indicates MODERATOR privilege.
S indicates SPEAKER privilege.
G indicates TOUR GUIDE privilege.
- User IDs are limited to 8 characters in length.
- IDs may not be blank nor only a dash (i.e. "-").
- Disallowed characters in IDs will be changed to "_".
- User Email addresses are limited to 128 characters in length.
- User URL's are limited to 128 characters in length.
- Messages are limited to 256 characters each.
- Use FLOAT to get a resizable window of the chat room.
- After not speaking for 20 minutes you will be logged out of the chat.
Note: this time limit may change from time to time per room.
- Use PRIVATE/IGNORE to have private conversations with
one or more folks - or to ignore one or more folks.
- Double-click on a user's name to get info on the user.
- Room Administrators can conduct virtual tours or excursions
and all room visitors can opt in/out by Checking/Unchecking"
the Excursions checkbox.
- Several control commands are available that can be used
to perform certain actions in the chat. All commands are
preceded by a "%" with no space between the % and the
command name. Commands are entered as if they are
outgoing messages with the "%" character as the FIRST
character in the message.
PRIVILEGED USER COMMANDS:
===========================
The following control commands require some privilege.
Supported privileges are ADMIN, MODERATE, TOUR, SPEAK, LOG
Where there is an alternate language versions of a command,
it is shown below the (default) English versions.
NOTE: If a language specific version of some command is not
listed below, the (default) english version should be
used.
%admin
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -