This file covers the major changes between each release.  For more details,
the reader is referred to the changelog (CHANGELOG.TXT in the main directory
of the archive), or for extreme details, to the check-ins archive (see
<http://mail.python.org/pipermail/spambayes-checkins>)
                                                                   
This is a bugfix release, so there are no new features, and you do not need
to do anything to migrate to the new release (other than install it).  There
are no incompatible changes.

New in 1.0.1
============

 o A bug with the import/export script (sb_dbexpimp.py) where merging into
   an existing database in the dbm format might lose training data has been
   fixed.  Another minor bug with the script that caused an error to be
   printed when importing into a pickle file (although the import was still
   successful) has also been fixed.

 o The binary installer failed to offer to install a startup items shortcut,
   which is convenient for sb_server binary users.  The installer will now
   do this.

 o sb_server users who wish to use non-standard strings for classification
   (e.g. "spambayes-ham" instead of "ham") can now use the "Notate To" and
   "Notate Subject" options.  This is particularly useful for Outlook
   Express users.

 o Users of Windows extensions that automatically expand zip files (such
   as ZipMagic) should now be able to successfully use the binary versions
   of sb_server and the Outlook plug-in.

 o Checking whether a new version is available should now work for users
   who have entered proxy details in their configuration file.

 o Source code users can now use Python 2.4 with SpamBayes, although some
   DeprecationWarnings may still be generated.

 o The '-u' command line option for sb_server (letting you specify which
   port the web interface is served on) was broken, but is now fixed.

 o The tte.py (Train to Exhaustion) script now works with Python 2.3.

 o Various other minor fixes.   


Reported Bugs Fixed
===================
The following bugs tracked via the SourceForge system were fixed:
    981970, 990700, 941639, 986353, 790757, 944109, 959937, 903905,
    1051081, 1036601, 922063, 831864, 1022848, 715248

A URL containing the details of these bugs can be made by appending the
bug number to this URL:
http://sourceforge.net/tracker/index.php?func=detail&group_id=61702&atid=498103&aid=

As this is a bugfix release, no feature requests or patches tracked via the
SourceForge system were added.


Deprecated Options
==================

The following options are still deprecated and will be removed in the 1.1
release:
  o [Tokenizer] generate_time_buckets
  o [Tokenizer] extract_dow
  o [Classifier] experimental_ham_spam_imbalance_adjustment

We recommend that you cease using these options if you still are.  If you
have any questions about the deprecated options, please email
spambayes@python.org and we will try and answer them.


Experimental Options
====================

We would like to remind users about our set of experimental options.  These
are options which we believe may be of benefit to users, but have not been
tested throughly enough to warrent full inclusion.  We would greatly
appreciate feedback from users willing to try these options out as to their
perceived benefit.  Both source code and binary users (including Outlook)
can try these options out.

To enable an experimental option, sb_server and sb_imapfilter users should
click on the "Experimental Configuration" button on the main configuration
page, and select the option(s) they wish to try.

To enable an experimental option, Outlook plug-in users should open their
"Data Directory" (via SpamBayes->SpamBayes Manager->Advanced->Show Data Folder)
and open the "default_bayes_customize.ini" file in there (create one with
Notepad if there isn't already one).  In this file, add the options that
you wish to try - for example, to enable searching for "Habeas" headers,
add a line with "Tokenizer" and, below that, a line with
"x-search_for_habeas_headers:True".

If you have any queries about the experimental options, please email
spambayes@python.org and we will try and answer them.
                                                          
Experimental options that are currently available include:
  o [Tokenizer] x-search_for_habeas_headers
  o [Tokenizer] x-reduce_habeas_headers
    These generate tokens based on the Habeas headers (see
    <http://habeas.com> for more details).
  
  o [Classifier] x-use_bigrams
    By default, SpamBayes uses unigrams tokens that are basically
    single words (split on whitespace).  This option enables both unigrams
    and bigrams (pairs of words), but uses a 'tiling' scheme, where only
    the set of unigrams and bigrams that have the strongest effect on
    the message are used.  Note that this option will no longer be
    experimental (although still off by default) with 1.1 - we recommend
    that you try it out if you want higher accuracy.

  o [URLRetriever] x-slurp_urls
  o [URLRetriever] x-cache_expiry_days
  o [URLRetriever] x-cache_directory
  o [URLRetriever] x-only_slurp_base
  o [URLRetriever] x-web_prefix
    If these are used, if a message is scored as 'unsure', and could use
    more tokens in its classification, then text from any URLs in the
    message is retrieved and used, if it makes a difference to the
    classification.

  o [Tokenizer] x-pick_apart_urls
    Pick out some semantic bits from URLs.

  o [Tokenizer] x-fancy_url_recognition
    Recognize 'abbreviated' URLs of the form www.xyz.com or ftp.xyz.com as
    http://www.xyz.com and ftp://ftp.xyz.com, respectively.  This gets rid
    of some fairly common "skip:w NNN" tokens.
