ShoutBox .NET

How Does It Work

These instructions correspond to the documentation file included in your ShoutBox! download.

Installing and configuring ShoutBox! is extremely easy, just follow the instructions and your new chat gadget will be up and running in less than 5 minutes:

These instructions correspond to the documentation file included in your ShoutBox! download.

Installing and configuring ShoutBox is extremely easy,
just follow the instructions and your new chat gadget
will be up and running in less than 5 minutes:

1. Extract the contents of shoutbox.zip to a folder named 'shoutbox'
   
   
2. With a text editor (like notepad) open the file named 'configdata.asp'
   This file holds all the ShoutBox configuration settings. You must modify the variables on this file to make ShoutBox part of your site:
   
   
• xlaSBtitle : The title for your Shout Box
  I.E : <add key="xlaSBtitle" value="XIGLA ShoutBox" />
  
  
• xlaSBmaxlines : Max. Number of Lines Displayed
  I.E : <add key="xlaSBmaxlines" value="25" />
  
  
• xlaSBmaxlength : Max. Length per message (number of characters)
  I.E : <add key="xlaSBmaxlength" value="255" />
  
  
• xlaSBmaxnicklength : Max. Length allowed per nick (number of characters)
  <add key="xlaSBmaxnicklength" value="8" />
  
  
• xlaSBtoptobottom : Display Messages from Top to Bottom ?. Can be true or false
  I.E : <add key="xlaSBtoptobottom" value="true" />
  
  
• xlaSBautolink : Auto-Generate Links for any URLs : can be true or false
  I.E : <add key="xlaSBautolink" value="true" />
  
  
• xlaSBrefreshrate : Chat Refresh Rate (in seconds)
  I.E : <add key="xlaSBrefreshrate" value="5" />
  
  
• xlaSBempticons : Enable Emoticons : can be true or false
  I.E : <add key="xlaSBemoticons" value="true" />
  
  
• xlaSBbadwords : Words to be filtered
  I.E : <add key="xlaSBbadwords" value="pig,butt,fool" />
  
  
• xlaSBtimestamp : Add a time stamp to the messages , can be true or false
  I.E : <add key="xlaSBtimestamp" value="true" />
  
  
• xlaSBlinebreak : Add Line Break Between Messages : can be true or false
  I.E : <add key="xlaSBlinebreak" value="true" />
  
  
• xlaSBpersisttime : Persists Messages in the ShoutBox for N hours : An integer
  I.E : <add key="xlaSBpersisttime" value="1" />
  
  
• xlaSBtimeoffset : Server Time Offset (In Minutes)
  I.E : <add key="xlaSBtimeoffset" value="0" />
  
  
• xlaSBnewusernotify : Display User Join / Left Notification : Can be true or False
  I.E : <add key="xlaSBnewusernotify" value="true" />
  
  
• xlaSBsplashscreen : Display an Intro Page (default.aspx) : Can be true or False
  I.E : <add key="xlaSBsplashscreen" value="true" />
  
  
• xlaSBsavechat : Save Chat Transcripts : Can be True or False
  I.E : <add key="xlaSBsavechat" value="true" />
  
  
• xlaSBsavechatpath : The physical disk path to the folder where the transcripts should be saved (Should have write permissions enabled)
  I.E : <add key="xlaSBsavechatpath" value="c:\folder\subfolder\" />
  
  
• xlaSBallowdomains : : Domains which can access the ShoutBox , separate using spaces, only use this feature if you see that your ShoutBox is being called from external sites.
  I.E : <add key="xlaSBallowdomains" value="localhost" />
  
  
  
3. Create a folder on your site named 'shoutbox' and upload the contents of your local 'shoutbox' to the 'shoutbox' folder on the server.
   
   
4. Check if there's a folder at the ROOT of your public Web Site called BIN, if there's none, you will need to create it (It is called BIN, not CGI-BIN). Once set , you will need to move the file XIGLA.ShoutBox.dll file from the Shoutbox/BIN folder to your site's BIN folder.
   
   Note : The BIN folder should be at the root of the folder defined as virtual in your web server. It is a subfolder at the very root of your public web site.
   
   
5. Add the following line of code to each page on your site where you want to enable your ShoutBox.
   Use the appropiate URL path to point to the shoutbox.aspx file on your site's 'shoutbox' folder :
   <iframe width="100%" height="200" frameborder="0" scrolling="No" marginheight="0" src="http://www.yoursite.com/shoutbox/shoutbox.aspx"></iframe>
   You can change the height setting to set the height of the ShoutBox
   By using width=100% the ShoutBox will resize to the full width of the cell where this code is located.
   Make sure to change the path to the shoutbox.aspx file on your site :
   http://www.yourdomain.com/shoutbox/shoutbox.aspx
   
   NOTE : The ShoutBox must be referenced with the same domain of the site where it is installed.
   For example : if the site is http://www.site.com, you cannot reference to the ShoutBox as http://site.com/shoutbox.aspx as http://site.com and http://www.site.com are considered differents by the browser.
   
   
6. To Configure the look and feel of your ShoutBox, you'll need to edit the sbstyles.aspx file
   
   
7. To change the Intro page, edit the default.aspx file with your favorite HTML editor

That's It!, now your visitors can chat and hold conversations with each other while surfing your site!.