+-----------------------------------------------------------------------------+
| phpMyAddressbook - personal addressbook                                     |
|-----------------------------------------------------------------------------|
| Copyright (C) 2000-2008 Ploc                                                |
|-----------------------------------------------------------------------------|
| http://ploc.acampado.net/phpmyaddressbook/                                  |
| mailto:phpmyaddressbook [at] acampado.net                                   |
|-----------------------------------------------------------------------------|
| This file is part of phpMyAddressbook.                                      |
|                                                                             |
| phpMyAddressbook is free software: you can redistribute it and/or modify    |
| it under the terms of the GNU General Public License as published by        |
| the Free Software Foundation, either version 3 of the License, or           |
| (at your option) any later version.                                         |
|                                                                             |
| phpMyAddressbook is distributed in the hope that it will be useful,         |
| but WITHOUT ANY WARRANTY; without even the implied warranty of              |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
| GNU General Public License for more details.                                |
|                                                                             |
| You should have received a copy of the GNU General Public License           |
| along with phpMyAddressbook.  If not, see .   |
|-----------------------------------------------------------------------------|
|                                   README                                    |
+-----------------------------------------------------------------------------+

- phpMyAddressbook is a personal addressbook using php, fpdf and any pdo
  supported database engine (currently implemented database engine are sqlite
  and mysql).

- phpMyAddressbook main language is English but it can be easily translated
  as it uses gettext. French language package is available and enabled by
  default.

- phpMyAddressbook is highly customizable as it can potentially handle
  unlimited number of fields. Many parameters can be set in configuration
  files.

- phpMyAddressbook can export records to various formats such as pdf, sql,
  ldif, csv, mab. It can also send basic mailings to get a human validation
  from your contacts. Besides, phpMyAddressbook can import csv data if the
  file fits the database structure.

- phpMyAddressbook includes icons from the Tango Desktop Projet
  (http://tango.freedesktop.org/) and fpdf (http://fpdf.org/) as the pdf
  generator.


|-----------------------------------------------------------------------------|
|                                REQUIREMENTS                                 |
+-----------------------------------------------------------------------------+

- a web server
- php 5 (or later) with pdo enabled
- a database engine : sqlite or mysql


|-----------------------------------------------------------------------------|
|                                INSTALLATION                                 |
+-----------------------------------------------------------------------------+

- Extract the downloaded archive in a directory of your web server.

- If you want to use apache authentication, rename the file named htaccess to
  .htaccess and edit the file in order to refer to your own .htpasswd file.

- Edit the user configuration file named user.cfg.inc.php according to the
  configuration of your database and to your preferences. This file is the
  place to set how you want the software to behave (any setting from the main
  configuration file init.inc.php can be overriden in the user configuration
  file user.cfg.inc.php). Default settings use sqlite to store your data. If
  you prefer to use mysql, edit the corresponding parameters in the user
  configuration file.

- If you set a mysql database, check that the mysql database named $dbName
  already exists and that the mysql user named $dbLogin has write access on
  it (create, alter, insert, update, delete). Check that the mysql user named
  $dbLogin has write access (create, alter, insert, update, delete) on the
  mysql database named $dbName.

- Open your browser and browse the script named install.php (this script is
  creating the table that will store your data). If your browser displays an
  error about gettext, check that gettext extension is enabled in your php.
  If your browser displays an error about the database, check the database
  settings in the configuration file and that the table named $dbTable does
  not already exist in your database.

- If your browser displays that the installation is complete, it's ok ! You
  can start to enter your data.


|-----------------------------------------------------------------------------|
|                                    TODO                                     |
+-----------------------------------------------------------------------------+

- Update : tableless template.


|-----------------------------------------------------------------------------|
|                                  CHANGELOG                                  |
+-----------------------------------------------------------------------------+

xx-xx-2008 v1.9
- Add : csv import module.
- Add : sqlite support.
- Add : database access is using pdo.
- Add : sql statements are sql ansi compliant.
- Add : css filename can be set in configuration files.
- Update : csv export module escape special characters.
- Update : mab export module escape special characters.
- Update : mass-mailer is integrated to the interface.
- Update : phpMyAddressbook updated to php5.
- Update : fpdf updated to version 1.6.
- Update : various improvements.
- Bugfixe : numeric values are correctly handled.
- Bugfixe : search feature is always consistent.

22-04-2008 v1.8
- Add : mass-mailer in order to get a human validation from your contacts.
- Add : mab export module.
- Add : server side file export.
- Update : various improvements.
- Bugfixe : email, ldif and sim export modules filter null email contacts.
- Bugfixe : ldif export module is correctly handling name and firstname.
- Bugfixe : sim export module charset set to an unknown but working charset.

07-11-2007 v1.7
- Add : tags feature.
- Add : tags shortcuts.
- Update : export feature is filter compatible.
- Update : shortcuts can be enabled or disabled.
- Update : init.inc.php settings can be overridden in user.cfg.inc.php file.
- Update : csv export module format is simpler.
- Update : switch to GPLv3.
- Bugfixe : update statement is correctly handling numeric data.
- Bugfixe : records with html special characters are correctly handled.

28-02-2007 v1.6
- Add : .htaccess authentication example file.
- Update : gettext activation checking.
- Update : database connection function.
- Update : configuration files.
- Update : various improvements.
- Bugfixe : install script is connecting the database.

18-01-2007 v1.5
- Update : icons (from Tango Desktop Project).
- Update : default charset changed to utf8.
- Update : template is using xhtml 1.1.
- Update : sql export module is more flexible.
- Bugfixe : language setting is correctly set in html template.

06-03-2006 v1.4
- Update : support php with register_globals disabled.
- Update : parameters checking secured.
- Update : generic export module.
- Bugfixe : data are correctly exported to the pdf document.

17-08-2005 v1.3
- Update : css slightly modified.
- Update : parameters checking slightly modified.
- Bugfixe : parameters checking is working.
- Bugfixe : export filenames are based on the table name.

05-06-2005 v1.2
- Add : sim card export module.
- Add : fully multi-lingual using gettext.
- Add : phpMyAddressbook can handle unlimited number of fields.
- Add : each field has a default value and a suggested value.
- Update : all export filenames are timestamped.
- Update : using fpdf153.
- Remove : javascript confirm script.

12-10-2004 v1.1
- Add : csv export module.
- Add : secured data handling.
- Update : full revision of the code (less code means less bug).
- Update : redesigned interface is more simple and efficient.
- Update : template is xhtml strict valid and uses css.
- Update : all graphic files are now png.
- Update : icons.
- Update : using fpdf152.

09-05-2003 v1.0
- Update : pdf export module has a 2-sided printing capability.
- Update : full revision of the code to fulfill the pear coding standards.
- Update : using fpdf151.
- Update : various improvements.

02-03-2003 v0.9
- Add : ldif export module.
- Add : combo box to choose the export format.
- Update : search bar.
- Update : various improvements.

05-04-2002 v0.8
- Add : pdf export module.
- Add : text export module.
- Update : records are now sorted depending on a field.
- Update : phpMyAddressbook updated to php4.
- Update : various improvements.
- Remove : print export module.
- Bugfixe : cellphone is correctly set when adding a record.

03-07-2001 v0.7
- Update : full revision of the code (optimised, harmonized, commented)
- Update : automatic database structure management.
- Update : various improvements.

08-06-2001 v0.6
- Add : print export module.
- Update : various improvements.

04-05-2001 v0.5
- Update : sql export file is now downloaded.
- Update : various improvements.

22-04-2001 v0.4
- Add : confirmation before deleting a record.

02-04-2001 v0.3
- Add : record delete feature.
- Update : search mode is now case insensitive.

20-12-2000 v0.2
- Add : sql export module.
- Update : icons.

27-10-2000 v0.1
- Initial release.


|-----------------------------------------------------------------------------|
|                                     END                                     |
+-----------------------------------------------------------------------------+