 ____    __                      __    __
/\  _`\ /\ \                    /\ \__/\ \
\ \,\L\_\ \ \___     ___   __  _\ \ ,_\ \ \____   ___   __  _
 \/_\__ `\ \  _ `\  / __`\/\ \/\ \ \ \/\ \ '__`\ / __`\/\ \/'\
   /\ \L\ \ \ \ \ \/\ \L\ \ \ \_\ \ \ \_\ \ \L\ Y\ \L\ \/>  </
   \ `\___/\ \_\ \_\ \____/\ \____/\ \__\\ \_,__| \____//\_/\_\
    \/____/ \/_/\/_/\/___/  \/___/  \/__/ \/___/ \/___/ \//\/_/ version 2.371
                                                          (20 Mar 2005)
 (c) 2001-2005 Brett Taylor, 2004-2005 Christian Boisjoli
 <http://shoutbox.sourceforge.net> <mailto:glutnix@users.sourceforge.net>

UPGRADING FROM ANY PAST VERSION OF SHOUTBOX:
It is recommended that you remove all old shoutbox php files before 
installing any new version of shoutbox, then follow the normal install
procedure.  

*** CSV users: Remember to backup your shouts.txt file!

*** MySQL users: There was a database change in 2.30.
    If you are upgrading from < 2.21, run setup-mysql.php and 
    check upgrade from < 2.21. 

If you wish to change CSV -> MySQL, read the csv2mysql.txt file
Language packs have a different format in 2.30

==== Shoutbox Credits =======================================================
 * Idea taken from the old Aftertalk.com service.
 * Tested on the Addict^2 Box <http://www.addict.net.nz> - CHEERS LordP!
 * Typed in using the Dvorak keyboard layout.  Look Mum! No QWERTY!
 * mySQL Library based on code by GuruBob - CHEERS!
 * Shoutouts(?) to: Warner, GuruBob, Smikwily, Emre, SmileyChris, and
   everyone who's ever posted on a shoutbox! 

==== Licence ================================================================
1. You may modify, mangle or use as you wish.
2  You may not distribute this script to anyone.
3. If you use this script, please visit <http://forums.webfroot.co.nz>
   and post in the shoutbox there.
4. If you make any cool stylesheets, e-mail them to <glutnix@users.sourceforge.net>
   and he'll make them available for others if you wish...
5. Do not claim you wrote this script, because Brett Taylor did.
6. Do not remove or modify this notice. So there.
7. By using the script you agree to the terms of the licence.
8. We accept no responsibility for damages, losses, or problems caused by
   the script.  It's supplied AS IS.

==== Installation Instructions ==============================================
1. Extract all files to your web folder.  A subdirectory called 'shoutbox'
   is probably a good choice.

2. Open shoutboxconf.php and change to the database module you wish to use.

   *** If you wish to change from CSV to MySQL, read the csv2mysql.txt file

   Remove the // from infront of the database module you want to use.  Make
   sure you only have one of the lines un-remarked, or you'll get errors.

3. Open the module file you selected - there are options in there you'll want
   to change, such as filenames, database permissions, etc.

4. Open shoutbox_cookies.php and change the admin password.
   YOU MUST CHANGE THIS IF YOU DON'T WANT TO BE HACKED! :)

***  If you haven't already, upload your files ***

5. ALL USERS:
     If you're hosted on a unix-style box, get to a shell prompt and type 
     the following commands:
     % cd /path/to/shoutbox
     % chmod 766 shoutboxconf.php
     substituting the correct path and filename. Don't type the %'s :D

     If you don't have shell access via telnet or ssh, you can use an ftp
     client such as SmartFTP <smartftp.com> or CuteFTP <cuteftp.com>.  If
     you wish to use this method, consult your FTP client's documentation.

6. CSV Users:
     You need to do this extra chmod:
     % chmod 766 shouts.txt

   mySQL USERS:
     Open setup-mysql.php in your browser to create the database and table 
     you specified in shoutbox_mysql.php.  
     
     It is safe to delete this file when you've finished, and re-executing 
     it won't foul things up as it checks and won't re-create the database 
     or table if either already exist.

==== Installing as an IFRAME ================================================
Copy the IFRAME code from the iframe_demo.html and copy it into your page.
Make sure the urls point correctly.  What is between the iframe tags is what
will be shown to users who are not using IFRAME compatible browsers.

<!-- copy this segment -->
<iframe bgcolor="#000033" src="viewshoutbox.php" width="150" height="300" 
frameborder="0">
<font color="#FFFFFF"><a href="expanded.php">View the shoutbox</a></font>
</iframe>
<!-- END copy-->

Be sure to customise your width, height and bgcolor.

==== Installing as an inline page ===========================================
showshoutbox.php is the inline page.  Customise this page however you want.
You can copy and paste the code from here and put it in your pages if you 
want.  However, I have not tested this and will not give any support to users
with this setup.

==== Wish List ==============================================================
Please see the SourceForge feature requests tracker :)

Any ideas? Post on the tracker, mail me or post on the forum!

==== Known Bugs =============================================================
Please see the SourceForge bug tracker :)

==== Version History ========================================================
2.371 ! (Keilaron) A quick dirty fix to stop newlines from confusing shoutbox
2.37  ! (Keilaron) Bugfix to editshout.php (another index->admin oops)
2.36  ! (Keilaron) Bugfixes to admin.php (mega oops on my part)
      - (Keilaron) Flash directory dropped.
      ! (Keilaron) Smileys are now provided in a seperate download
2.35  - (Keilaron) Support for $conf is removed.
          While this nullifies the possibility to do cross-site scripting,
          it unfortunately disables the multiple configuration feature.
      ! (Keilaron) index.php was renamed to admin.php
      ! (Keilaron) new index.php was created
2.34  ! (Keilaron) Fixed parse error (semicolon hiding behind a comment!)
2.33  ?
2.32  ?
2.31  ! Fixed parse error on line 5 in editshout.php
      ! Whoops!  A bit-too zealous search/replace botched up my 
        setup-mysql.php upgrade from < 2.21 option, that I actually forgot 
	about.
2.30  ! Hopefully Fixed phpNuke and postNuke incompatibilities.  It is still
	not considered a 'block' as it doesn't integrate with these systems.
      ! Fixed Past Shouts in CSV mode.
      + Added javascript to add emoticon codes to the shout field from the 
        window that opened it.  Cheers to Xero from punknudes.com for that!
      + Added Timezone Correction if audience is in different timezone to
        the server.
      + Added inline url and email link converting.
      ! Finally fixed character escaping errors...*knocks on wood*
      + Added new language packs: Czech and Slovenian
      + Added charset selection per language pack, which allows for
        multi-byte languages such as chinese and japanese.
2.21  ! Fixed IP saving bug in shoutbox_csv.php
      + Turkish Language Pack - Thanks Bertan Kodamanoglu!
      + Updated Spanish help file.
2.20  + Added Edit/Delete shouts and Configuration via admin webpage!
      ! Changed the past shouts to only show 400 shouts, as nobody wants to
        download a 200kb shout list :)
      ! Updated mySQL and CSV modules to support the admin webpage details
      ! You have to 'chmod 766 shoutboxconf.php' to be able to use the web
        interface.
      + viewshoutbox.php and expanded.php now use $maxshoutlen for input 
        maxlength values.
      + CSV now records IP addresses - Upgrade is seamless :)
      + Users can delete posts from their IP address within a set time 
      + Added bad word filter (shoutbox_censor.php)
      + Added flood protection!
2.10  + Added Language Module Capability
      > Thanks to: Werner de Vries, (Dutch), Nils Fleigl (German), and 
        Piocheur (French) and Filip Zrnzevic (half of Serbian) for their 
        contributed language packs!
      ! Fixed cookies, adding end-of-unix-time to current-unix-time doesn't
        work too well... :)
      + Added Emoticon Themes!  Thanks to that website which had them...
        They are all public domain.  11 colour sets to choose from!
      + Added option to choose for white or black text above some smileys.
      + Improved the help window, and the emoticon reference.
      + Although the emoticon reference shows one 'code' per smiley, the 
        conversion library is quite comprehensive and takes looks at case too
        eg: :P :p :b :B
2.01  > Cheers to GuruBob for most of the fixes in this release!
      ! Improved the code in shoutboxsmileys.php
      + User's Nicks and URLs are now cookied on a submit!
      + Slight improvement in shoutbox_mysql.php to remind eager installers
        to edit the file to change settings.
      + Added stylesheet class .formarea for the area surrounding the form.
      ! Webfroot's Design changed, and thus the default stylesheet.
      ! Removed link requirement from the licence agreement.
      ! Now assumes that viewshoutbox.php is located in the same place as 
       shoutbox.php
2.00  ! Fixed wordwrap so it only cuts words longer than $linelength, thus 
        allowing the users browser to handle the word wrapping.
      + Help pop-up window, which includes the emoticon legend.
      + HTML and other scripts are now translated literally, meaning a script 
        will be shown as it was typed.  This means symbols like <, >, and & 
        can be entered correctly.
      + Added the ability to choose a configuration file when calling 
        shoutbox.php
1.91b ! Fixed mysql-setup.php to actually work now.
      ! Changed default output style - time now in table tooltip, name 
        becomes link.
      + Moved output styles from shoutbox.php to shoutboxconf.php
      + mySQL database module now records users IP addresses
1.90b * BETA VERSION - PLEASE PLEASE PLEASE SUBMIT BUG REPORTS!
      + Moved the CSV components to a database module (shoutbox_csv.php)
      + Created mySQL database module (shoutbox_mysql.php) -- based on code
        by GuruBob!  Full credits to him!
      + Added option to test submitted URLs for actual existance! ($checkurl)
      + If errors on form, values are passed back so they can be edited
        rather than re-typed
      + Added rendering time calculations to viewshoutbox.php - echo'd as 
        an <!-- html remark -->, so view source to see render time.
      + Added rendering time calculations to extended.php - visible.
      + Added internal version number (might make it check to see if an 
        upgrade is available)
1.33  ! More prevention of just space posts.
1.32  ! Stopped posts consisting of just spaces.
      ! Actually fixed it so $emoticons=0 actually stops parsing.
      + Server-side shout length limiting ($maxshoutlen)
      + topstyle-preview.html for making CSS files in TopStyle easier.
      > Cheers to emre for bug spotting! 
1.31  ! Fixed it so $emoticons=0 actually stops parsing.
1.30  + Added Expanded mode which shows every shout ever posted.
      + Added how to stop scrolling to the bottom when $direction=-1 to 
        $direction comments
      + Added Emoticon Parsing!
1.21  ! Fixed compulsory URL.
      ! Re-arranged field order in viewshoutbox.php
      + Help link (javascript alert)
      + Random 'get this php' link text in viewshoutbox.php
1.20  + Alternative colours for every other post using CSS.
      + Moved Configuration Options to shoutboxconf.php (to prepare for 
        administration page)
      + Post direction option ($direction)
      + Corrected IFRAME code in readme file.
      ! Fixed relative file problems (badly setup test environment, hehe)
      ! Fixed displaying empty posts when number of $showamount > number of 
        shouts.
1.10  + URL field
      + Server side error feedback to users
      + Wordwrap() performed on showShouts(), not on addShouts()
1.00  * First Release

=============================================================================
