|
|
Table of Contents |
The VolanoChat applet has 165 properties you can modify in order to
customize the language, banner applet, colors, fonts, images, text, and
sounds of your chat rooms. Whenever the VolanoChat, MyVolanoChat, or
WebVolanoChat applet is downloaded to a Web page, the applet determines
its appearance by reading from its properties file. The properties file
is defined by the value of the applet's text parameter:
<param name="text" value="filename.txt">
where filename.txt is the name of the properties
file. For a complete description of the applet tag and the VolanoChat
applet parameters, see the previous
section. Volano provides six sample property files, each with a
different language translation:
english.txt
french.txt
german.txt
italian.txt
portuguese.txt
spanish.txt
your-translation.txt
These translations are just a set of samples you can use to translate the entire VolanoChat, MyVolanoChat and WebVolanoChat user interfaces into any lanuage -- even non-Western languages such as Japanese, Chinese and Korean. Please see the Translating VolanoChat chapter for information on translating into non-Western character sets. For languages using Western character sets, simply copy and edit one of the files listed above.
To remove a property value, set it equal to nothing, like this example:
char.replace.old= char.replace.new=
If you delete the property definition, or comment it out by putting
the character "#" at the beginning of the line, the
VolanoChat applet will use the default value for the property. By
setting the property value to nothing, you can make sure to override the
default value and disable the property.
To customize the appearance of your chat rooms, simply edit the
properties file that will be used by the applet. The files are located
by default in the vcclient directory. All of the applet
properties are defined below, showing the default value for each
property.
Note that for file path names, you must specify the path in Web
notation (using a forward slash "/" instead of the Windows
backslash "\"). Uniform Resource Locators (URLs) may be
relative or absolute, with relative URLs assumed relative to the
location of the applet properties file. There can be no spaces on either
side of the equal sign.
If you use an absolute URL in a property definition, make sure you understand the security restrictions of Java applets, described in the VolanoChat Servlets Chapter. That chapter shows you how you can use the VolanoChat proxy servlet to safely bypass the applet network security restrictions.
override.myvolanochat=true
true if you want to allow people
creating personal chat rooms to define their own text, colors, fonts,
and banner advertisements for their chat rooms. Otherwise, specify
false.
server.port=8000
server.port property value in order for the client applet
to connect to the correct server port number.
limit.public=-1
-1
means there is no limit on the number of chat rooms any one person may
enter.
limit.private=5
-1 allows an unlimited
number of private chat sessions for each person.
history.enable=false
true allows the up and down arrow keys to scroll
through the list of messages sent in a manner similar to Microsoft's
DOSKEY command recall feature. A value of false disables
the up and down arrow keys in the chat message text field.
member.document=
member.editable.name=true
username applet parameter. A value of
true allows the name to be changed on the main chat window.
A value of false prevents the name from being modified.
member.editable.profile=true
profile applet parameter. A value of
true allows the profile to be changed on the main chat
window. A value of false prevents the profile string from
being modified.
member.monitor=false
true, but allows it to work only for authorized
member-monitors.
banner.code=COM.volano.BannerPlayer.class
banner.parameters=BannerPlayer.txt
banner.width=468
banner.height=76
logo.code=COM.volano.BannerPlayer.class
logo.parameters=LogoPlayer.txt
logo.width=100
logo.height=200
color.background=#C0C0C0
#RRGGBB, where RR is
the red hexadecimal value, GG is the green hexadecimal
value, and BB is the blue hexadecimal value.
color.foreground=#000000
#RRGGBB, where RR is
the red hexadecimal value, GG is the green hexadecimal
value, and BB is the blue hexadecimal value. The foreground
color defines the color of the text and window borders.
font.default=TimesRoman-15
"name[-style][-size]". For the best cross
platform support, the name should be limited to Helvetica,
TimesRoman, Courier, or Dialog.
The style is one of italic, bold, or
bolditalic, and should be omitted for a plain style. The
size is the font point size. For example, you could specify the font
"Helvetica-bold-13".
alert.entrance.default=false
true makes the entrance
alerts enabled by default. A value of false makes the
entrance alerts initially disabled. The setting of the entrance alerts
can be modified by the user regardless of the initial setting.
alert.audio.default=false
true makes the audio alerts
enabled by default. A value of false makes the audio alerts
initially disabled. The setting of the audio alerts can be modified by
the user regardless of the initial setting.
alert.count.default=false
true makes the count alerts
enabled by default, displaying a count of the total number of people in
a room each time the count changes. A value of false makes
the count alerts initially disabled. The setting of the room count
alerts can be modified by the user regardless of the initial setting.
webtouring.default=false
true makes the Web touring
option enabled by default, opening a Web page when its URL is displayed
in a chat message. A value of false makes the Web touring
option initially disabled. The setting of the Web touring option can be
modified by the user regardless of the initial setting.
The images defined for the buttons and logos of the applet may be in GIF or JPEG format. Make sure you set the size properties to match the actual image sizes or they may be displayed distorted.
image.button.border=true
false if undefined.
image.button1=button1.gif
image.button2=button2.gif
image.button.width=88
image.button.height=31
image.logo=logo.gif
image.logo.width=100
image.logo.height=200
image.logo.background=#FFFFFF
#RRGGBB, where RR is the red hexadecimal
value, GG is the green hexadecimal value, and
BB is the blue hexadecimal value. The background color
appears if the logo image has any transparency or when the main chat
window is resized to expose a logo area larger than the image.
These properties specify the maximum number of characters for each user input string, to prevent any one user from flooding the server. The values must be the same as the values of these properties for the VolanoChat server, since the server will disconnect any user sending character strings longer than it expects.
length.chattext=1000
length.profile=1000
length.roomname=100
length.username=20
These properties define the location of the Web pages displayed when the applet encounters errors accessing the server or when the user requests help. You can modify these Web pages or translate them into another language.
page.newwindow=false
true causes the applet to open a new browser window when
displaying Web pages defined by the page.access.* and
page.exit properties. When false, the applet
displays these pages by replacing its own page.
page.use.document.base=false
true causes the applet to load its Web pages relative to
the location of the Web page. A value of false causes the
applet to load its Web pages relative to its own code base directory.
page.access.document=document.html
page.access.host=host.html
page.access.password=password.html
page.access.unable=unable.html
page.access.version=version.html
page.help=help.html
page.about=about.html
page.exit=
page.exit.error=
Each sound property gives the location of its sound file. Sound is
disabled if no sound URL is defined. Sound files must be encoded in the
Next/Sun 8000 Hz mono 8-bit µ-law format (usually with the file
extension ".au").
sound.start=
sound.stop=
sound.enter=
sound.exit=
sound.rooms=
sound.users=
sound.profile=
sound.alert=drip.au
The key properties specify a list of key codes to ignore when the Alt, Ctrl, Meta, or Shift keys are pressed. The Meta key is also known as the Command key on the Macintosh. You should use the Unicode escape sequences with the key codes in hexadecimal. To specify more than one key code, simply list additional Unicode escape sequences on the same line with no spaces.
key.ignore.alt=
key.ignore.ctrl=\u0016
key.ignore.meta=\u0076
key.ignore.shift=\u0401
The character properties specify one list of characters to be replaced by their corresponding entries in another list. If one list is longer than the other, all extra characters beyond those in the shortest list are ignored. For non-printable ASCII characters, you must use their Unicode escape sequences.
char.replace.old=\u000a\u000d\u00a0
\u000a), Carriage Return
(\u000d), and Non-breaking Space (\u00a0)
characters.
char.replace.new=\u0020\u0020\u0020
\u0020).
The function keys act as macro hot keys so that predefined
phrases can be automatically filled into the chat message text field.
Each property below defines a template in which words in the chat text
field are filled into the template as the variables %0
through %9. For example, if we define:
text.f1=Hello, %0! Welcome to my chat room.
we can simply type John and press F1 to get the chat
message string:
Hello, John! Welcome to my chat room.
text.f1=
text.f2=
text.f3=
text.f4=
text.f5=
text.f6=
text.f7=
text.f8=
text.f9=
text.f10=
text.f11=
text.f12=
These text strings appear on the Web page containing the applet or in the Web browser status area.
text.button.status=Start VolanoChat
text.button.message=Click button to start.
text.button.connecting=Contacting host %0...
%0 is the host name of the VolanoChat server, and
%1 (not used by default) is the port number.
text.button.accessing=Host contacted, requesting access...
text.button.notconnected=Unable to connect to host %0 on port %1.
%0 is the host name of
the VolanoChat server, and %1 is the port number.
text.button.admin=Administrator password:
admin is true.
text.button.monitor=Monitor password:
monitor is true.
These text strings appear on the Web page or chat windows and pertain to members and member profiles.
text.member.name=Member name:
member is true.
text.member.password=Member password:
member is true.
text.member.profile=[Member Profile]
member.document
property) when the applet parameter member is
true.
These text strings appear on the main chat window.
text.main.title=VolanoChat 2.1
text.main.logo=
text.main.rooms=Rooms:
text.main.norooms=Rooms:
text.main.oneroom=1 room:
text.main.manyrooms=%0 rooms:
%0 is the number of rooms in the list.
text.main.users=People:
text.main.nousers=People:
text.main.oneuser=1 person:
text.main.manyusers=%0 persons:
%0 is the number of users in the
room.
text.main.onstage=On stage:
text.main.roomname=Room name:
text.main.username=Your name:
text.main.profile=Your profile:
text.main.broadcast=Broadcast:
admin parameter is true.
text.main.enter=Enter Room
text.main.refresh=Refresh Rooms
text.main.connect=Connect
text.main.disconnect=Disconnect
These text strings appear in the chat rooms.
text.chat.status=Select a name for the profile. Double click a name for private chat.
text.chat.event.status=Type your question and press Enter to send it.
text.chat.event.sent=Your question has been submitted to the moderator.
These text strings appear in the applet window menus. To remove a menu or menu item, simply remove the associated text string defined for it.
text.menu.places=Places
text.menu.enter=Enter Room
text.menu.refresh=Refresh Rooms
text.menu.exit=Exit
text.menu.options=Options
text.menu.font.name=Font Name
text.menu.font.style=Font Style
text.menu.font.regular=Regular
text.menu.font.italic=Italic
text.menu.font.bold=Bold
text.menu.font.bolditalic=Bold Italic
text.menu.font.increase=Increase Font
text.menu.font.decrease=Decrease Font
text.menu.alert.entrance=Entrance Alerts
text.menu.alert.audio=Audio Alerts
text.menu.alert.count=Show Count Changes
text.menu.webtouring=Web Touring
text.menu.help=Help
text.menu.topics=Help Contents
text.menu.about=About VolanoChat
text.menu.room=Room
text.menu.close=Close
text.menu.people=People
text.menu.people.ring=Ring %0
%0 is the name of the selected user.
text.menu.people.ignore=Ignore %0
%0 is the
name of the selected user.
text.menu.people.unignore=Unignore %0
%0 is
the name of the selected user.
text.menu.people.count=Count
text.menu.people.remove=Remove %0
%0 is the name of the selected user. This menu item is
available only to monitors and administrators.
text.menu.people.kick=Kick %0
%0 is the name of the selected user. This
menu item is available only to monitors and administrators.
text.menu.people.ban=Ban %0
%0 is the name of the selected
user. This menu item is available only to monitors and administrators.
These text strings appear in the applet window menus when defined.
text.menu.links.title=
text.menu.links.names=
"|" vertical bar character. The order of the names must be
the same as their corresponding addresses.
text.menu.links.locations=
"|" vertical bar character. The order of the addresses must
be the same as their corresponding names.
These text strings appear in the main chat window status area when the keyboard focus is changed by tabbing through the components of the window.
text.status.focus.rooms=List of rooms.
text.status.focus.users=List of people in room.
text.status.focus.roomname=Your room selection.
text.status.focus.username=Your name or nickname.
text.status.focus.profile=Optional personal information such as a Web or e-mail address.
text.status.focus.enter=Enter a room.
text.status.focus.refresh=Refresh the list of rooms.
text.status.focus.membername=Your member name.
text.status.focus.memberpassword=Your member password.
These text strings appear as messages in the main chat window status area or on the Web page of the applet.
text.status.selectroom=Select a room.
text.status.entername=Enter your name or a nickname.
text.status.enterpassword=Enter your password.
text.status.entermembername=Enter your member name.
text.status.entermemberpassword=Enter your member password.
text.status.enterprofile=Enter an optional profile.
text.status.enter=Press Enter Room or the Enter key to enter.
text.status.enteringroom=Entering %0...
%0
is the name of the selected room.
text.status.enteringprivate=Starting private chat with %0...
%0 is the name of the person with whom the private chat
session is requested.
text.status.gettingrooms=Getting list of rooms...
text.status.gettingusers=Getting list of people in room...
text.status.gettingprofile=Getting %0's profile...
text.status.nosuchroom=Room no longer exists. Press Refresh Rooms.
text.status.nosuchuser=User is no longer in room.
text.status.nametaken=The name %0 is already taken in %1.
%0 is the requested name and
%1 is the chat room name.
text.status.membertaken=The name %0 belongs to a member. Please choose another name.
%0 is the reserved member name.
text.status.alreadyinroom=Already in %0.
%0 is the chat room name.
text.status.roomfull=%0 is full. Select another room or try again later.
%0 is the chat room name.
text.status.roomcount=Room count = %0.
text.status.publiclimit=You are limited to %0 concurrent chat rooms.
%0 is the limit
on the number of concurrent chat rooms per visitor.
text.status.privatelimit=You are limited to %0 concurrent private chat sessions.
%0
is the limit on the number of concurrent private chat sessions per
visitor.
text.status.noprofile=%0 has no profile.
%0 is the visitor's name and %1 is the
visitor's Internet Protocol (IP) address. The IP address is excluded
from the text by default.
text.status.profile=%0: %2
%0 is the visitor's name, %2 is the profile
string specified by the visitor, and %1 is the visitor's
Internet Protocol (IP) address. The IP address is excluded from the text
by default.
text.status.closing=Closing VolanoChat...
These text strings appear in the chat room text area as system
messages. In each message, the date can be removed or replaced with a
different prefix string. You may want to add a special prefix to these
messages, such as the string "***", so that they can be
distinguished from the normal chat messages in the chat rooms.
text.system.entrance=[%0] %1
%0 is the date and %1 is the
new visitor's name and profile.
text.system.audio=[%0] Audio alert from %1.
%0 is the date and %1 is sender's
name.
text.system.broadcast=[%0] %1
%0 is the date and %1 is the broadcast message
text.
text.system.partnerleft=[%0] %1 left private chat.
%0 is the date and %1 is the
name of the private chat partner.
text.system.disconnected=[%0] Disconnected. Close VolanoChat and restart.
%0 is the date.
|
|
Check HTML | Table of Contents |