CONTACT LIST
A phpBB extension by Thoul
Current Hack Release: 0.3.1 Beta
Official Supported phpBB Release: 2.0.9-2.0.11

Table of Contents:
1) Introduction
2) Release Notes
3) Included Files
4) License
5) Features
6) Mini FAQ
7) Contact Information

--------------------------------------------------------------------------------
                                  INTRODUCTION
--------------------------------------------------------------------------------

Contact List is an modification for phpBB 2.0 that adds the combined features of
a buddy list, an ignore list, and a "disallow contact" list.  A Control Panel is
also included, through which users may add or move other users to their lists.

The buddy list portion of Contact List allows users to create a list of
'buddies' composed of other users.  This list can then be used to inform the
user when 'buddies' are visiting the forum at the same time as themselves and to
allow easy access to the 'buddies' usernames when sending private messages.

The ignore list portions of Contact List allow users to completely remove almost
all indications of certain other users from their sight.  When a user adds
a person to his or her ignore list, the person's posts, topics, and
similar data will not be displayed to the user.  The person also cannot send
the user messages via the forum.

The 'disallow contact' list in Contact List lets users completely prevent
certain other users from contacting them through the forum.  The 'disallowed'
users will not be able to see the user's contact information (email address, IM
address, etc.) or profile.  They will also be prevented from sending private
messages to the user. The user is still shown the 'disallowed' users' posts,
etc.

Contact List was formerly known as Buddy/Ignore/Disallow List or BID List.

--------------------------------------------------------------------------------
                                 RELEASE NOTES
--------------------------------------------------------------------------------

For a full list of changes in each version of this hack, look at the included
changelog.txt file.  For previous release notes, see release_notes.txt.

Version 0.3.1 Beta - Dec 21, 2003 8:00 pm Eastern Time
This release is mainly a catch-up type of deal. Contact List hadn't been updated
since phpBB 2.0.6, so some minor changes where needed for comparability with
later versions. I also fixed a few bugs, particularly in the installer.

--------------------------------------------------------------------------------
                                 INCLUDED FILES
--------------------------------------------------------------------------------

When the ZIP file for this hack is unpacked, the following new directories
may be created on your system, each containing the noted files.
	docs - Important documents for installation, upgrading, etc.
	hack_files - New files that will be added to your forum.
	hack_install - Installer files for this hack.
	premodded - Original phpBB files already modified for use with this hack.

The "docs" directory may contain the following files:
	release_notes.txt - Short summary of changes in each version of this hack.
	changelog.txt - Detailed list of changes to each version.
	install.txt - Instructions for installing this hack.
	upgrade.txt - Instructions for upgrading from a previous version.
	uninstall.txt - Instructions for uninstalling this hack.
	file_edits.txt - Detailed list of changes to be made in existing files.
	gpl.txt - A copy of the GNU General Public License.  See License section.
The "docs" directory may also contain a file with the extension .hl, such as
"contact.hl."  See the Mini FAQ section for details.

--------------------------------------------------------------------------------
                                    LICENSE
--------------------------------------------------------------------------------

The files in this package (collectively known as a modification, hack,
extension, or add-on), are free software distributed under the GNU General
Public License, Version 2.  A copy of this license is available from the Free
Software Foundation and should be found in the docs/gpl.txt file that came with
this package.

In addition, this modification may contain code from a 2.0.x release of phpBB in
the form of instructions or modified files.  Any such code is copyright (C) the
phpBB Group and distributed in accordance with the GNU General Public License
under which that phpBB version was released.

All original code and images in this package are copyright (C) Jeremy Rogers.

--------------------------------------------------------------------------------
                                    FEATURES
--------------------------------------------------------------------------------

Contact List Control Panel, with the following abilities:
-Add or remove users to lists, or move users from one list or another.
-Set alert preferences for Buddies, to alert you when they come online/go
 offline.
-All changes must be confirmed before they are actually made.
-Users can be displayed in alphabetical order or reverse alphabetical order.
-When a user is added to another user's buddy list, that user will receive a
 private message informing them of the change (this includes the typical "notify
 on new private message" options).

Buddy List Features:
-A "Buddies" button is available when sending a PM.  Clicking it launches a new
 window that lists the user's buddies and their online/offline status.
-You can be alerted when your buddies come online or go offline (requires
 Javascript being turned on in your browser).

Ignore List Features:
-When you is ignore another user:
  -They cannot view some of your contact information (PM and e-mail links) in
   the member list, topics, and profile.
  -They cannot send private messages or e-mail (via the board) to you.
  -You will not see them in the member list or "who is online" lists and will
   not see their posts in topics.  Quotes attributed to users you ignore
   appearing in other posts will also be removed.
  -You will not see topics they start if the topics have no replies or only one
   reply, if that reply was made by a user you are ignoring.
  -On pages that hide something regarding them from you, a link will be
   presented that allows you to view the page including whatever was hidden.

Disallow List Features:
This is a "disallow contact" list, which means users added to this list cannot 
contact or view contact information via the board.  It's like a lesser version
of an ignore list, for those that just don't want to get PMs from an annoying
user.
-When you add another user to your Disallow List:
  -They cannot view any of your contact information (PM, website, and e-mail
   links, and instant messenger information) in the member list, topics, and
   profile.
  -They cannot send private messages or e-mail (via the board) to you.
  -You will see their topics and replies as normal.

Other Features:
-New FAQ page to help users understand how to use the lists.
-Links to add or remove a user from each list in users' posts, profiles, and the
 member list.
-Supports Nivisec's Admin Hacks List.
-Administrators and Moderators cannot be ignored or disallowed.


--------------------------------------------------------------------------------
                                    MINI FAQ
--------------------------------------------------------------------------------

Q. I don't know how to install this?  What should I do?
A. Installation instructions can be found in the docs/install.txt file.  If you
   have not installed a hack before, then you may have problems understanding
   the format of some instructions.  There are several guides available online
   that explain this format.  I recommend the ones found in the phpBBHacks.com
   Tutorials section (see Contact Information).

Q. The install/upgrade/uninstall instructions say unzipping the hack should have
   created new directories, but it didn't?  What do I do?
A. Those instructions all assume your archive software program unpacks files
   into the directories they were stored in when packed in the ZIP file.  If it
   doesn't, you're going to be confused when you try working through the
   instructions.  Try changing some settings in the program or using a different
   one.

Q. Are any non-English language file packs available for this hack?
A. Maybe, maybe not.  English is my only language, so any language pack
   releases are dependent solely on the generosity and work of others.

Q. There is a .hl file in the docs/ directory.  What should I do with it?
A. This file is provided for use with the Mods/Hack List hack written by
   Nivisec.  If you do not have Nivisec's hack installed on your forum, you can
   ignore the file.  If you do have his hack installed, then that hack has
   instructions for using the .hl file.

Q. Can I customize my installation in other ways not documented in this package?
A. This is usually possible.  Check out the Docs and Tutorials section of the
   DarkMods web site to see if I have listed any possibilities there.

Q. I need more help!
A. The Contact Information section of this file lists sites that you can check
   for support, lists of known bugs and fixes, and solutions to problems other
   people may have encountered.  If you are having a problem with installing
   this hack, please make sure you are following the installation instructions
   in docs/install.txt.

--------------------------------------------------------------------------------
                              CONTACT INFORMATION
--------------------------------------------------------------------------------

To download older or new versions of my hacks, please visit these web sites:
DarkMods         http://darkmods.sourceforge.net/      (Old and New versions)
Shaded Wings     http://cyborgcentral.dynip.com/~pd/   (Latest version only)
phpBBHacks.com   http://www.phpbbhacks.com/            (Latest version only)

DarkMods is my phpBB hacking related web site and Shaded Wings is my personal
web site.  These two sites tend to get new releases more quickly, but phpBBHacks
does have some exclusive releases from me.  DarkMods is the best place to look
for add-ons, language packs, image sets, FAQs, and other material from myself.

If you are having a problem with one of my modifications and would like support,
please visit either DarkMods or phpBBHacks.  As of this release, I do visit both
of these regularly and will try to answer any questions that come to my
attention there.  To increase the speed in which you get an answer to your
question, I strongly recommend that you search those forums using key words that
describe your problem.  If the question has already been answered, a good search
will give you the answer more quickly than waiting for a post to be answered.

It is not necessary to post the same question on both forums, unless I cannot
answer your question at DarkMods.  phpBBHacks has a helpful Support Team that
may be able to answer questions I cannot.

If you need to e-mail me, I can be reached at thoul-phpbb@earthlink.net.  I do
prefer not to give support for hacks via e-mail, as forum posts can help many
people with identical problems at different points in time.  I do not give out
instant messenger contact information.

If you wish to be informed by e-mail when I release an update to this or my
other modifications, there's a mailing list you can subscribe to at:
http://lists.sourceforge.net/mailman/listinfo/darkmods-announce
Sourceforge.net users can also monitor releases from the Sourceforge.net
interface for project "darkmods."

Have a nice day. :D