![]() ![]() ![]() ![]() |
Table of Contents |
The VolanoChat applet has more than 250 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
dutch.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 language—even non-Western languages such as Japanese, Chinese and Korean. Please see the [8.1] Translating VolanoChat feature page 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:
banner.code=
This example removes the rotating banner player at the top of the chat window. 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 internal 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. In cases where the internal default differs from the default value in the properties file, the internal default is also noted so that you will know the result of commenting out or removing that 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 equals 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 your properties.txt file in order for the client applet to connect to the correct server port number.limit.public=5
-1
means there is no limit on the number of chat rooms any one person may enter. Monitors and administrators can enter an unlimited number of rooms.limit.private=5
-1
allows an unlimited number of private chat sessions for each person. Monitors and administrators can initiate an unlimited number of private chat sessions.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.filter.enable=false
true
displays the Room Filter label and text field as in earlier versions of the VolanoChat applet. Otherwise, the Room Filter label and text field are removed in the VolanoChat applet.send.private.disable=false
true
, this property disables the initiation of private chat sessions from the applet. Otherwise, it allows the initiation of private chat sessions.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. For more information, see the Member Monitor section of the [7.1.5] Monitor Interface page.label.text=
label.link=
label.url=
label.url.text=
label.url.link=
For example, if a dynamic text-based ad service at the following address:
http://www.yourdomain.com/textad.php
returns the following content:
alt=Get your chocolate here! href=http://aaa.bbb.ccc/chocolate.html
you would define your VolanoChat applet properties as:
label.url=http://www.yourdomain.com/textad.php label.url.text=alt label.url.link=href
Note that, as with remote banner advertisement services, you may need to use the VolanoChat ProxyServlet if the remote ad server is on a machine other than the one running your VolanoChat server. Web browsers allow Java applets to connect only to the machine that delivered them, so they need a proxy service to connect through to any remote ad servers.
banner.code=COM.volano.BannerPlayer.class
banner.parameters=BannerPlayer.txt
banner.width=468
banner.height=60
logo.code=COM.volano.BannerPlayer.class
logo.parameters=LogoPlayer.txt
logo.width=100
logo.height=220
All colors are specified in standard web notation #RRGGBB
, where RR
is the red hexadecimal value, GG
is the green hexadecimal value, and BB
is the blue hexadecimal value.
color.background=#A0B8C8
#FFFFFF
.color.background.button=#FFFFCC
#FFFFFF
.color.background.list=#DCDCDC
#FFFFFF
.color.background.text=#DCDCDC
#FFFFFF
.color.background.text.editable=#FFFFFF
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.color.foreground.button=#000000
color.foreground.list=#000000
color.foreground.text=#000000
color.foreground.text.editable=#000000
color.foreground.text.editable.inactive=#FF0000
color.foreground.text.link=#0000FF
font.default=SansSerif-13
"name[-style][-size]"
. For the best cross platform support, the name should be specified as Serif
, SansSerif
, Monospaced
, Dialog
, and DialogInput
. 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, unless this item is omitted from the options menu.accept.private.default=true
alert.audio.default=false
true
makes the audio alerts enabled by default, playing a sound any time a new user enters the room or another user rings them. 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, unless this item is omitted from the options menu.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, unless this item is omitted from the options menu.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, unless this item is omitted from the options menu.These properties specify preferences for displaying profile and referrer links in the status area of the applets.
link.prefix=http:// ftp:// news: mailto:
link.prefix=http://www.volano.com/ http://www.volano.net/
link.profile.disable=false
link.profile.url=%0
http://www.volano.com/incoming.cgi?%0
link.referrer.disable=false
link.referrer.url=%0
http://www.volano.com/incoming.cgi?%0
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 appear distorted. The properties look for images in your vcclient
directory, by default.
image.button.border=true
image.button1=button1.gif
image.button2=button2.gif
image.button.width=88
image.button.height=31
image.logo=logo.gif
logo.code=
. Otherwise the default banner player or your own Java applet will appear in this space instead.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=200
length.profile=200
length.roomname=100
length.username=20
A more detailed explanation of flood control can be found on the [8.2] Flood Control Feature page. The following values are in milliseconds, and define the amount of time before the client can send in another request to the server.
delay.keystroke=0
delay.access=0
delay.authenticate=0
delay.beep=1000
delay.chat=1000
delay.enter.private=1000
delay.enter.room=1000
delay.exit.private=0
delay.exit.room=0
delay.kick=0
delay.ping=0
delay.room.list=0
delay.user.list=0
unconfirmed.chat=0
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.access.duplicate=duplicate.html
duplicate.addresses=false
page.java.version=java.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.authenticating=Access granted, authenticating client...
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 Applet
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.filter=Room filter:
text.main.username=Your name:
text.main.profile=Your profile:
text.main.broadcast=Broadcast:
admin
parameter is set to true
.text.main.getrooms=Get Rooms
text.main.enter=Enter Room
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.getrooms=Get Rooms
text.menu.enter=Enter Room
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.accept.private=Accept Private Chats
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.monitor=Monitor
text.menu.monitor.remove=
text.menu.monitor=Remove %0
,where %0
is the name of the selected user.text.menu.monitor.kick=
text.menu.monitor=Kick %0
,where %0
is the name of the selected user.text.menu.monitor.ban=
text.menu.monitor=Ban %0
,where %0
is the name of the selected user.These text strings appear in the applet window menus when defined.
text.menu.links.title=Links
text.menu.links.names=Java - Get It Now!
"|"
vertical bar character. The order of the names must be the same as their corresponding addresses.text.menu.links.locations=http://www.java.com/
"|"
vertical bar character. The order of the addresses must be the same as their corresponding names.This section defines the themes menu and the actual construction of various themes. For more information see the [8.5] Themes Feature page.
text.menu.themes.title=Themes
text.menu.themes.names=Plum | Desert | Marine | Pumpkin | Lime | - | High Contrast Black | High Contrast Black (large) | High Contrast White | High Contrast White (large)
text.menu.themes.default=Standard
color.background.*
, color.foreground.*
, and font.default
above.
# Plum
theme.1.color.background=#CC99CC
theme.1.color.background.button=#EEEEEE
theme.1.color.background.list=#FFCCFF
theme.1.color.background.text=#FFCCFF
theme.1.color.foreground.text.editable.inactive=#996699
theme.1.color.foreground.text.link=#330033
# Desert
theme.2.color.background=#CCCC99
theme.2.color.background.button=#FFFFCC
theme.2.color.background.list=#EDEDCA
theme.2.color.background.text=#EDEDCA
theme.2.color.foreground.text.editable.inactive=#999966
theme.2.color.foreground.text.link=#333300
# Marine
theme.3.color.background=#6699CC
theme.3.color.background.button=#EEEEEE
theme.3.color.background.list=#B6CBEB
theme.3.color.background.text=#B6CBEB
theme.3.color.foreground.text.editable.inactive=#336699
theme.3.color.foreground.text.link=#000033
# Pumpkin
theme.4.color.background=#FF9966
theme.4.color.background.button=#FFFFCC
theme.4.color.background.list=#FFCC99
theme.4.color.background.text=#FFCC99
theme.4.color.foreground.text.editable.inactive=#CC6633
theme.4.color.foreground.text.link=#660000
# Lime
theme.5.color.background=#83D8A4
theme.5.color.background.button=#C8ECD4
theme.5.color.background.list=#C8ECD4
theme.5.color.background.text=#C8ECD4
theme.5.color.foreground.text.editable.inactive=#53A874
theme.5.color.foreground.text.link=#004814
# Skip theme.6 for separator "-".
# High Contrast Black
theme.7.color.background=#000000
theme.7.color.background.button=#000000
theme.7.color.background.list=#000000
theme.7.color.background.text=#000000
theme.7.color.background.text.editable=#000000
theme.7.color.foreground=#FFFFFF
theme.7.color.foreground.button=#FFFFFF
theme.7.color.foreground.list=#FFFFFF
theme.7.color.foreground.text=#FFFFFF
theme.7.color.foreground.text.editable=#FFFFFF
theme.7.color.foreground.text.editable.inactive=#808080
theme.7.color.foreground.text.link=#8080FF
# High Contrast Black (large)
theme.8.color.background=#000000
theme.8.color.background.button=#000000
theme.8.color.background.list=#000000
theme.8.color.background.text=#000000
theme.8.color.background.text.editable=#000000
theme.8.color.foreground=#FFFFFF
theme.8.color.foreground.button=#FFFFFF
theme.8.color.foreground.list=#FFFFFF
theme.8.color.foreground.text=#FFFFFF
theme.8.color.foreground.text.editable=#FFFFFF
theme.8.color.foreground.text.editable.inactive=#808080
theme.8.color.foreground.text.link=#8080FF
theme.8.font.default=SansSerif-18
# High Contrast White
theme.9.color.background=#FFFFFF
theme.9.color.background.button=#FFFFFF
theme.9.color.background.list=#FFFFFF
theme.9.color.background.text=#FFFFFF
theme.9.color.foreground.text.editable.inactive=#808080
# High Contrast White (large)
theme.10.color.background=#FFFFFF
theme.10.color.background.button=#FFFFFF
theme.10.color.background.list=#FFFFFF
theme.10.color.background.text=#FFFFFF
theme.10.color.foreground.text.editable.inactive=#808080
theme.10.font.default=SansSerif-18
The following items are displayed on the monitor pop-up menu.
recent.user.limit=50
text.monitor.title.remove=Remove From Room
text.monitor.title.kick=Kick From Server
text.monitor.title.ban=Ban From Server
text.monitor.label.remove=Select the name to remove:
text.monitor.label.kick=Select the address to disconnect:
text.monitor.label.ban=Select the address to ban:
text.monitor.okay=OK
text.monitor.cancel=Cancel
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.filter=Filter for list of room names.
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.getrooms=Get list of room names matching filter.
text.status.focus.enter=Enter a room.
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 to enter.
text.status.entername=Enter a name to join %0.
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 to enter %0.
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 Get 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 chat rooms.
%0
is the limit on the number of concurrent chat rooms per visitor.text.status.privatelimit=You are limited to %0 private chat sessions.
%0
is the limit on the number of concurrent private chat sessions per visitor.text.status.noprofile=%1 %0 has no profile.
%0
is the visitor's name and %1
is the visitor's Internet Protocol (IP) address. The IP address will only display to monitors and administrators.text.status.profile=%1 %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 will only display to monitors and administrators.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] %2 %1: %3
%0
is the date, %1
is the new visitor's name, %2
is the visitor's IP address, if available, and %3
is the visitor's profile text.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.![]() ![]() ![]() ![]() |
XHTML 1.0 | Table of Contents |