Location: PHPKode > scripts > Weatimages > weatimages/README.TXT
    Weatimages version 1.7.2
    Copyright (c) 2003-2007 Vladimir Nazarkin
    http://nazarkin.name/projects/weatimages/
    hide@address.com
    $Id: README.TXT,v 1.11 2007/04/15 08:56:40 Vova Exp $


    1. Introduction

Weatimages is very easy to use program that allows you to organize powerful web-based photo albums on your website in a minimal time.
To publish photo album you just need to put one file from Weatimages distributive to a separate website directory containing your photos or folders (which become sub-albums) with your photos.


    2. Features

 - Automatic thumbnail creation for pictures and albums
 - Automatic image resizing
 - Caching of thumbnails and resized images for higher performance
 - Supports JPG, GIF and PNG image formats
 - Non-image files listing allowing users to download videos, music, archives, etc from your albums
 - Supports nested albums of any nesting level
 - Supports descriptions for albums and individual images, reading EXIF comments
 - Internationalization support
 - Ability to hide certain albums from listing
 - Hotkeys navigation and slideshow
 - Flexible configuration allow to change appearance, behavior and feature set


    3. Requirements

Web server with PHP 4.0.6 (or higher) and GD 2.0.1 (or higher).


    4. Installation

Unpack file "index.php" from this archive and upload it to separate directory (e.g. "photos/") on your web server.
In order to enable caching capabilities, you need to create the new directory named "weatimages-cache" in directory with "index.php" and to set access rights 777 (rwxrwxrwx) to "weatimages-cache".
If you plan to customize configuration, upload "weatimages.ini" too.

Further in that manual assumed that your Weatimages installation path is "photos/", and your site domain name is "www.yoursite.com".


    5. Configuration

Default configuration options works fine in most cases. So, you can miss this step painless.

Configuration options of Weatimages are stored in "weatimages.ini". Open it in any text editor and adjust needed settings in compliance with embedded instructions.


    6. Using

  6.1 Basics

To create an album just copy (via FTP) folder containing images from your computer to directory with Weatimages installed.

After adding new album to the Weatimages installation directory new album will appear at the Weatimages start page at http://www.yoursite.com/photos
You can go directly to any album using such address as http://www.yoursite.com/photos/index.php/ALBUMNAME where ALBUMNAME is the name of necessary album.

You can make nested albums by creating subfolders in any album and putting images to them.

  6.2 Descriptions

Descriptions can be applied to any type of items listed by Weatimages - images, entire albums, and downloadable non-image objects.
Descriptions is optional Weatimages feature. It can be enabled or disabled, refer to the configuration file.

To use descriptions you need create file named "desc.txt" and put it in directory with described items.
File "desc.txt" must contain data in the next format:

ItemFileName.jpg Description of item
ItemFileName2 Description of second item, file extension omitted
SomeFileName Description of some other item
SomeFileName. Long description which will be shown only on page containning the big image

As can be seen, description of each item is placed on the single line. It is supposed that the filename of item (which described on current line) is located at the beginning of the line and separated from description body by the space (separating character may be changed by the "description_delimiter" parameter in configuration file).
Extension in the filename of item described may be omitted if it is not disallowed in configuration file.
There are defined two special "virtual filenames" - "." and "..". Description with the "." in place of filename is considered as the title of current album and will be shown at the top of album. Description with the ".." in place of filename is considered as the comment to title of current album and will be shown under the album title.
If filename is suffixed by the dot ("SomeFileName." or "SomeFileName.jpg."), following description will be shown only on page with big (or resized) copy of corresponding image.
If you use non-english characters in items descriptions, you may wish to specify the particular characters encoding for albums pages. In this case you should refer to "charset" parameter of configuration file.

Since version 1.6 Weatimages also trying to read descriptions from EXIF if it isn't prohibited by the config and PHP has EXIF extension. When image description stored in UNICODE format, Weatimages tries to recode it to encoding specified in 'charset' option of configuration file (only when MBSTRING extension loaded). Check MBSTRING module presence and value of 'charset' option if you experiencing problems with displaying of non-roman characters from exif tags. If both Title/ImageDescription and Comment/UserComment EXIF tags is filled in, will be shown both.
Image description from the text file has priority over exif descriptions.

  6.3 Objects hiding

When albums listing enables, you may to wish to hide some album from the listing. To hide album, assign name starting with the "." character to album directory (e.g. ".sensitivedata"). This prefix may be changed by using "hidden_prefix" parameter in configuration file.
Hidden albums will not be listed at the albums listings, so these albums can be accessed only by direct URL such as http://www.yoursite.com/photos/index.php/.sensitivedata


    7. Updating

Latest version of Weatimages is available on http://nazarkin.name/projects/weatimages/

To update previous version of Weatimages replace old "index.php" with new "index.php".
If you have made changes in "weatimages.ini" from previous distributive version, you should check the new "weatimages.ini" for appearance of new configuration parameters, and add them to your current "weatimages.ini" file with your adjustments to experience full advantages of new version. The same actions should be performed with css and langpack files.


    8. Versions history
Weatimages 1.7.2
  + Fixed "ini[langpack]" vulnerability

Weatimages 1.7.1
  + Optional link for downloading all album items in single zip archive
  + Minor bugfixes

Weatimages 1.7
  + Thumbnails generation for albums
  + Hotkeys navigation and slideshow
  + Compatibility mode for using on servers with restricted functionality
  + Interface improvements and new configuration options

Weatimages 1.6
  + EXIF data reading (descriptions, comments, date picture taken)
  + Optional sorting of albums and items by the date
  + Resolved problems with unfavorable combinations of php and http server versions

Weatimages 1.5
  + external css support
  + translation/langpacks support
  + ability to configure every album individually
  + improved compability with unusual web server configurations
  + updated appearance
  + new tuning options

Weatimages 1.4
  + image resizing queue for reducing memory usage
  + optimized caching mechanism

Weatimages 1.3
  + improved behaviour of navigation controls

Weatimages 1.2
  + html container for images view
  + items descriptions support

Weatimages 1.1
  + objects hiding
  + non-image items listing
  + adjustable charsets

Weatimages 1.0
  + first public release


    9. License

Weatimages version 1 released under the GNU General Public License:

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, or (at your option) any later version.

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.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

See LICENSE.TXT for details.
Return current item: Weatimages