Customization Settings
Below is a list of all the variables that you can change to customize the appearance of WebbyChat. Just add them to the code we gave you when signing up. Make sure you put them before the call to our chat.php script.
If you still need help, just ask someone in our chat room, or try the forums.
An Example:
var __ptw_width = "300"; // this will make the width of the chat bar defaulted to 300 pixels wide
Advanced
A suggested user name. This can be handy to use if you have a user management system already. You could, for instance, dynamically insert the currently logged in user here, and their name would appear in the chat.
As an example: Let's say you had a PHP login system and the currently logged in user's name was available in PHP with the variable $user_name. You could use this javascript code on a php page to have that username suggested:
var __ptw_suggest_user_name = "<?=$user_name?>";
Possible Values
- A String
Deprecated: Use __ptw_slide_content instead
Possible Values
- true
- false
__ptw_disable_chat_button
If you set this to "true", then the regular chat icon will not appear. You will need to use the following javascript call to manually show/hide the chat window:
__wbc_slide_chat_pane()
Possible Values
- true
- false
Just enter any number greater than 0 and all pages on your site with this number will be grouped into their own chat room.
Possible Values
- A Positive Number
By Default, WebbyChat will consider subdomains as different rooms on your site. If you'd like it to consider ALL subdomains on your site as part of the same room set this variable to true.
Possible Values
- true
- false
If you want to totally remove the webby chat bar but want to integrate directly with your site, you can set this to true. You would then need to manually call the javascript function __wbc_slide_chat_pane(); For example, you could add a link somewhere on your page like this:
<a href="#" onclick="__wbc_slide_chat_pane(); return false;">Live Chat</a>
Possible Values
- true
- false
*** UPDATE : Please read before you enable this feature ***
The Easy Way (But Buggy)
When you set __ptw_slide_content=true our code will attempt to automatically rewrite your page content by wrapping a <div> around everything so that we can "slide" things over. This can sometimes cause page reloading and issues with some javascripts running on your site.
The Better Way (But a little harder to implement)
You can still set __ptw_slide_content=true, but instead of having our code try and wrap a <div> and create problems, you can just wrap a special <div> yourself. This will get rid of the compatibility issues talked about above.
Wrap EVERYTHING that is in the <body> of your webpage with a div with id=__ptw_body_wrap
For example,
<div id="__ptw_body_wrap">
... page content here ...
</div>
Possible Values
- true
- false
Colors
Changes the Chat Log Background Color. This is the area that chat history appears.
Possible Values
- A Hex String (i.e. "#FFFFFF")
Changes the Border Color (The user list will show a lighter border color automatically).
Possible Values
- A Hex String (i.e. "#FFFFFF")
Changes the color of chatted text in the chat log.
Possible Values
- A Hex String (i.e. "#FFFFFF")
Changes the color of YOUR name in the Chat log and User List
Possible Values
- A Hex String (i.e. "#FFFFFF")
Changes the color of other user names in the user list.
Possible Values
- A Hex String (i.e. "#FFFFFF")
Changes the color of the chat log's scroll bar.
Possible Values
- A Hex String (i.e. "#FFFFFF")
The background color of the input box
Possible Values
- A Hex String (i.e. "#FFFFFF")
The border color of the input box.
Possible Values
- A Hex String (i.e. "#FFFFFF")
The font color of the input box.
Possible Values
- A Hex String (i.e. "#FFFFFF")
Changes the color of the "User is Typing" keyboard icon in the user list.
Possible Values
- A Hex String (i.e. "#FFFFFF")
You can change the background color of the CHAT icon button that sits to the left or right of the page.
Possible Values
- A Hex String (i.e. "#FFFFFF")
If you quickly want to switch to a preset color scheme, just set the theme value.
Possible Values
- "default"
- "black"
__ptw_moderator_name_color
The color of the name of a moderator in the chat log.
Possible Values
- A Hex String (i.e. "#FFFFFF")
The color of a room administrators name in the chat log.
Possible Values
- A Hex String (i.e. "#FFFFFF")
__ptw_admin_name_color_ul
The color of a room administrators name in the User List.
Possible Values
- A Hex String (i.e. "#FFFFFF")
__ptw_moderator_name_color_ul
The color of a room moderators name in the User List.
Possible Values
- A Hex String (i.e. "#FFFFFF")
General Settings
The first time a visitor uses your chat this is the state the chat window will appear, either opened or closed. If the user chooses to open the chat window, this setting will be ignored it place of the user-chosen setting.
Possible Values
- true
- false
Where to align the chat bar on the screen.
Possible Values
- "left"
- "right"
The width of the chat bar in pixels. Leave the "px" off. The minimum value is 200 pixels, as the chat is pretty much unusable less than this.
Possible Values
- 200 and up
Control the location of the chat icon Use a number for pixel, or include a % sign. For example, if you want the chat icon to appear half way down the page you could enter "50%". To place the chat icon 25 pixels down the page use the value "25px".
Possible Values
- Any number
- 1-100%
Languages
The language to use for WebbyChat text.
Possible Values
- "english"
- "spanish"
- "turkish"
- "french"
- "italian"
- "hebrew"
- "polish"
User Names
If you want to bypass the UserName facility set this to true. That will automatically log people in as a guest or use the Suggested Username in the variable __ptw_suggest_user_name.
Possible Values
- true
- false
