------------------------------------------------------------------------------
PiXfr Photo Module (PPM) 1.1.1 for PostNuke, PHP-Nuke or standalone - readme
------------------------------------------------------------------------------

  PHP application that generate web photo galleries.
  PostNuke / PHP-Nuke module or standalone.

  Version 1.1.1 - 2001/11/27
  http://pixfr.com

  Copyright (C) 2000-2001 Yann Courtaux <pixman@pixfr.com>

  This program 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 2 of the License.

  This program 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 (license).

Requirements:
    A webserver running PHP 3 or 4.
    Not mandatory: GD library for automatic ThumbNails creation.

Summary:
    PiXfr Photo Module is intended to generate massive web photo galleries
    (thousands of pics).
    Webmasters just have to create directories and upload pictures.

    . PPM scans a given root directory (ie 'my_photos').
    . Each subdir of 'my_photos' becomes a category (ie 'cat1','cat2','me').
    . Each subdir of a category becomes a gallery (ie 'a','b','c','d','e').

       my_photos     --> Main page				 (1)
       |
       |__ cat1      --> Category 'my_photos/cat1' page 	 (2)
       |    |____ a
       |    |____ b
       |    |____ c  --> Gallery 'my_photos/cat1/c' page	 (3)
       |
       |__ cat2
       |    |____ 1__ photo1.jpg    --> Here are the photos !	 (4)
       |    |	  |__ photo2.jpg
       |    |	  |__ at_home.jpg				 (5)
       |    |	  |__ ppm_text.php  --> Text for this gallery	 (8)
       |    |	  |__ at_home.jpg.php > Text for picture 'at_home.jpg' (8)
       |    |
       |    |____ 2
       |    |____ 3
       |    |____ ppm_text.php	    --> Text for this category (cat screen) (8)
       |    |____ ppm_main_text.php --> Text for this category (main screen)(8)
       |
       |__ me
       |    |____ young
       |    |____ at_home      (6)
       |
       |__ my_dog	       (7)
	    |____ 1
	    |____ 2


Functionalities:
    - Show multilingual interface. Easy to extend.
      English, french, spanish, italian, dutch and german are now supported.
    - Multilingual text (8) for pages (2) & (3) with 'ppm_text.php' files, for
      page (1) with 'ppm_main_text.php' and for image (5) with 'image.jpg.php'.
    - create missing ThumbNails (TN) of JPEG, GIF and PNG pictures if GD lib
      is a module of the web server. Formats handled depends on GD version.
      Look at http://www.boutell.org for info about GD library.
    - Generated TN height in setup.
    - Usage of GD library can be disabled in the config file.
    - Generation of the main page (1).
    - Generation of the categories page (2).
    - Generation of a TN galleries page for each category (3).
      Each TN of this page links to a gallery of the current category.
      Refreshing this page can display other TN if random selection is
      turned on, if not the first TN is displayed (alphabetical order).
    - Generation of ergonomic navigation links:
	categories, galleries, pictures, next and previous links.
    - 'panic' link: displays a fake data sheet...
    - Maximum numbers of TN columns is configurable.
    - Maximum width of a TN row is configurable.
    - Geometric TN distribution on pages (2) and (3) is optimized.
    - A '_' (underscore) in a name of a file or directory is displayed as a
      blank character (space) (1),(5),(6) and (7).

Tips:
 + Your ISP don't have GD or use a version that can't deal with JPEG.
     In this case you'll have to create the thumbnails on your local
     development machine and upload them to your ISP.
     - Use an apache server running PHP with GD on your machine. I think
       it's always the best way (and GD is very time consuming).
       This is the easyest way once everything is configured on your local
       machine. Here are some links to do the job (sorry for Mac users..):
       . Windows server package :
	       FoxServ at http://sourceforge.net/projects/foxserv
	       easyphp at http://www.easyphp.org (the one I use, GD 2.0.1)
       . Linux : any distro includes apache/php/gd. The one I use is the
		 Mandrake 8.0 (http://www.linux-mandrake.com)
		 This distribution is easy to install and to configure.
     - Manual creation of the TN:
       . a TN for image.jpg must be called image.jpg-ppm. Case sensitive !
       . i suggest all TN should have the same height (good looking)
       . Easy Thumbnails (http://www.fookes.com/ezthumbs) and Flash Renamer
	 (http://www.rlvision.com) do the job on a PC.

 + Structure of a 'ppm_text.php' or 'ppm_main_text.php' file:
   <?php
    $ppmt_eng = 'This is an english text...';
    $ppmt_fra = 'Ceci est un texte francais...';
   ?>

Download:
    You can get the latest version at http://pixfr.com

Installation:
    Please see the 'install' file.

To see PPM in action:
    Go to http://pixfr.com and see the 'PPM in action' and 'PPM live' blocks.

ChangeLog:
    See the 'credits' file.

Documentation:
    - This file.
    - documentation.html
    - PiXfr Forums at http://pixfr.com

Bug Reports:
    There is a special forum for this at http://pixfr.com

PS: Please, don't send me emails with question like "How do I install GD".
    I answer to all emails about PPM, but I don't have time to be a helpdesk.
    Before contacting me, please go to http://pixfr.com to consult the Forums,
    latest news and comments.