Installing The Address Book Grouping and Pagination Plugin
==========================================================

1) Start with untaring the file into the plugins directory.
   Here is a example for the 1.0 version of the Address Book
   Grouping and Pagination plugin.

  $ cd plugins
  $ tar -zxvf abook_group_pagination-1.0-1.4.9.tar.gz

2) If you do not want to change the default behavior of this
   plugin, skip to step four.

3) (OPTIONAL) Decide if you want to store the plugin
   configuration file in the plugin directory or in the main
   SquirrelMail config directory.  

   A) To store the configuration file in the plugin directory,
      change into the abook_group_pagination directory, copy
      config.sample.php to config.php and edit config.php,
      making adjustments as you deem necessary.

     ----- optional -----
     $ cd abook_group_pagination
     $ cp config.sample.php config.php
     $ vi config.php
     ----- optional -----

   B) To store the configuration file in the main SquirrelMail
      config directory, change into the abook_group_pagination
      directory, copy config.sample.php to
      ../../config/config_abook_group_pagination.php and edit
      ../../config/config_abook_group_pagination.php, making
      adjustments as you deem necessary.

     ----- optional -----
     $ cd abook_group_pagination
     $ cp config.sample.php ../../config/config_abook_group_pagination.php
     $ vi ../../config/config_abook_group_pagination.php
     ----- optional -----

4) If you are running SquirrelMail 1.4.14 or above, skip to step six.

5) Patch the SquirrelMail source code to add the needed hooks
   for this plugin.  This patch essentially brings parts of
   your SquirrelMail installation up to SquirrelMail 1.4.15;
   it is better to simply upgrade the whole package to at least
   1.4.15 where no patching is needed.

   The patch should be run from the abook_group_pagination
   directory.  Make sure to use the patch that corresponds
   closest to your SquirrelMail version.  If one does not work,
   try the other.

  $ patch -p0 < patches/abook_pagination_squirrelmail-1.4.13.diff

   Note for Windows users: you can get native patch functionality
   by installing this very useful package:
   http://unxutils.sourceforge.net/

6) Then go to your config directory and run conf.pl.  Choose
   option 8 and move the plugin from the "Available Plugins"
   category to the "Installed Plugins" category.  Save and exit.

  $ cd ../../config/
  $ ./conf.pl

7) Also, if not being used with SquirrelMail 1.4.10+ or 1.5.2+,
   please verify that you have the "Compatibility" plugin
   installed (but not necessarily activated).

8) Translations are not included in this package.  To get a
   translation, download the language pack needed from:

      http://www.squirrelmail.org/download.php



Upgrading Address Book Grouping and Pagination
==============================================

1) Start with untaring the file into the plugins directory.
   Here is a example for the 1.0 version of the Address Book
   Grouping and Pagination plugin.

  $ cd plugins
  $ tar -zxvf abook_group_pagination-1.0-1.4.9.tar.gz

2) Change into the abook_group_pagination directory and check
   your config.php file against the new version to see if
   there are any new settings that you must add to your
   config.php file.

  $ diff -u config.php config.sample.php

   If you store your configuration file in the main SquirrelMail
   config directory, adjust this command as follows:

  $ diff -u ../../config/config_abook_group_pagination.php config.sample.php

   Or simply replace your configuration file with the provided
   sample and reconfigure the plugin from scratch (see step three
   under the installation procedure above).

3) You never need to patch SquirrelMail again if you've done it
   once before (or unless the release notes/changelog say otherwise).

