{"desc":"The ChatBox is comming soon. It will be available in version 3.6."}
 

FCChat Tutorial

Index Using the Chatbox


where is it

This tutorial will guide you through the process of setting up and administrating the chatbox on your site. At this time, the chatbox can only be run from within the FCChat toolbar.

Blogs may want to run the chatbox in mode 1 (see below). This gives you a chat room for each page, or blog topic on your site. Other sites may want to run it in mode 0. In this mode, you will typically have one sitewide chat room.

Please note. Because require_tag is enabled by default, you will need to embed a small tag in each page on which you want the chatbox to appear.


1) Chatbox Configuration

Within the FCChat configuration, the chatbox parameter contains the configuration options for the chatbox, as shown below:

//CHATBOX
chatbox:{
	enabled:true,
	mode:0, /* 0 - sitewide, 1 - page discussion */
	dialog_width:500,
	require_tag:true,
	sitewide:{
		full_page:true,
		topic:"",
		desc:"",
		button_width:120,
		button_text:"ChatBox",
		title_text:"ChatBox",
		connected_text:"Connected: ",
		viewing_text:"Viewing"
	},
	page_discussion:{
		button_width:130,
		button_text:"BlogChat",
		title_text:"Chat about this page",
		connected_text:"Viewing this page: ",
		viewing_text:"Active",
		use_querystring_in_url:false,
		use_page_title:true,
		lock_all_discussions:false
	}
},

enabled
Enables the chatbox.

mode
The chatbox has two modes. When in mode 0, you will have one sitewide chat room. In mode 2, you have the option of having a different chat room for each page, or topic, on your site. When in mode 0, the accompanying sitewide parameters will be used. When in mode 1, the page_discussion parameters will be used.

dialog_width
This is the width of the chatbox.

require_tag
When this is set to true, a page tag is required to activate and display the chatbox. There is more info about page tags and how they are used below. When set to false, the chatbox, if enabled, will be displayed on all pages of your site. If you are running the chatbox in the “page_discussion” mode and have disabled require_tag, a separate chat room will be created for each unique page on your site, which, in many cases, is not ideal. Enabling the require_tag parameter allows you to specify which pages will display the chatbox.

sitewide parameters

full_page
If true, the chatbox will be displayed in the full page chat.

topic
Info about the chatbox’s topic.

desc
More info about the chatbox.

button_width
The width of the chatbox button in the toolbar.

button_text
The chatbox button text.

title_text
The chatbox dialog title.

connected_text
Text to describe the state of users who are connected to the chatbox.

viewing_text
Text to describe the state of users in the chatbox’s userlist, who are actively viewing the chat room.

page_discussion parameters

button_width
The width of the chatbox button in the toolbar.

button_text
The chatbox button text.

title_text
The chatbox dialog title.

connected_text
Text to describe the state of users who are connected to the chatbox.

viewing_text
Text to describe the state of users in the chatbox’s userlist, who are actively viewing the chat room.

use_querystring_in_url
Different querystrings should be counted as separate pages? T/F

use_page_title
The page title will be taken to be the default “topic” for the page discussion? T/F

lock_all_discussions
The page discussions will be locked? T/F


2) Using page tags to control the chatbox.

You can embed a small tag in your web page to control the operation of the chatbox. When require_tags is enabled, a tag must be present on the page in order for the chatbox to appear. Here is an example of a page tag:

<span class='fc_chat_params'>
	{"id":"chatbox_tutorial",
	"topic":"Using the chatbox."}
</span>


There are no required parameters for the page tag. It can be as simple as an empty set of braces, like this:

<span class='fc_chat_params'>
	{}
</span>


Important: WordPress inserts extra characters in your text, thus, you must eliminate all extra line breaks from your tags, or they won’t work. Like this:

<span class='fc_chat_params'>{"id":"chatbox_tutorial","topic":"Using the chatbox."}</span>


Here is a page tag with more parameters included:

<span class='fc_chat_params'>
	{
		"page":"all",
		"id":"testchat",
		"no_discussion":false,
		"topic":"This is just a test",
		"desc":"Blah blah blah",
		"topic_closed":false
	}
</span>


page
This can be set to the exact url of the page in which the tag is embedded, or it can be set to “all”. When FCChat encounters more than one tag on a page, it chooses the correct tag in this fashion:

1) The first tag it encounters with “all” for the page parameter, or

2) the first tag it encounters with the same URL as the current page, or

3) simply, the first tag on the page.

id
This is an identifier for the chat room associated with this page. It can be anything you want. By using an identifier, you can have the same room span accross several pages. If you omit the identifier, and you are running in “page discussion” mode, the url of the page will be used as the identifier. If you are running a sitewide chatbox, the phrase “Sitewide Discussion” will be used as the default identifier.

no_discussion
Set this to true if you want to hide the chatbox on this page.

topic
The topic of the chatbox. This overrides the topic parameter in the configuration.

desc
A description. This overrides the desc parameter in the configuration.

topic_closed
Closes the chatbox discussion, so that no further chats are allowed.


In addition to these parameters, the page tag may contain any of the fields from the sitewide or page_discussion parameters above. These parameters, when present, will override the corresponding parameters in the chatbox configuration above.


3) Chatbox administration

Chatbox messages can be moderated with the Chatbox Manager. To access the Chatbox Manager, go to the FCChat adminstration panel, and open the chatcenter.


Solution Graphics