$Id: README_XOOPS.TXT,v 1.12 2003/10/20 07:18:29 gstarret Exp $

-------------
Introduction:
-------------

This is an update to the XoopsGallery 1.3.3, incorporating all (or most, anyway) 
of the user-submitted patches.  The original port from Gallery was done by Ono 
and updated by Boobtoob.  The patches included here were from numerous 
submittors on the Xoops.org website forums.  I (gstarrett, aka Glen Starrett) 
took these patches and bundled them into this package for your convenience, 
along with several patches of my own creation.

Gallery is a very famous web-based photo album script released from 
http://gallery.sourceforge.net. With Gallery you can easily create and maintain 
albums of photos via an intuitive interface. 

XoopsGallery is a module version of Gallery that has been integrated (not in 
full yet though) with XOOPS v2 template system and comments system. You can 
modify the appearance of the user side of Gallery by editing template files, and 
also users can post comments which can be then managed through XOOPS comment 
manager.

This only has been tested on XOOPS 2.0.4 or later versions.  Using the latest 
stable release of XOOPS2 is highly recommended.


-------------
Distribution:
-------------
The official distribution point for this module is:

http://www.sciox.org/xoops/

You will find the latest updates there.


-------------
Support:
-------------

There is no formal maintenance group for this module. However, if you post a 
good description of your problem to the forums at www.xoops.org, chances are 
that you'll get a response from the very helpful user community.


-------------
Installation - Upgrade:
-------------

To upgrade your existing XoopsGallery 1.3.3:

1) Make sure you have a good backup of your albums

2) Copy the included files over your existing XoopsGallery files

3) Go to Administration Menu > System > Modules and Update the XoopsGallery 
Module.

4) Copy index.html from the xoopsgallery/cache/albums directory into each of the 
album directories below that. (optional, but recommended)

5) Fix some consistency errors in the data table by running 'Check Orphaned 
Records' in the admin menu.


-------------
Installation - Fresh Install:
-------------

To install XoopsGallery for the first time in your XOOPS system:

1) Unzip the package on your hard drive (Somewhere that you will remember)

2) Use a FTP program to upload the xoopsgallery folder and its contents to 
{Xoopsroot}/modules/ folder on your server (should be NO need to make a new 
folder called xoopsgallery.  But if you do, just copy the contents of the folder 
and not the folder with its contents).

3) Set permissions on xoopsgallery/cache/tmp and xoopsgallery/cache/albums 
directories to 0777 (needs to be RW for webserver account, you might be able to 
reduce those permissions accordingly).

4) Login to Xoops as an admin and click on 'Administration Menu' in user menu.

5) Once you are logged in as admin and in Xoops site admin, Hover the mouse 
cursor over the 'system Admin' icon and then click on the 'Modules' link.

6) You should have arrived at 'Modules Administration' now, look down the module 
column list until you find the Gallery icon and click on it.  Xoops will now 
install the module and then prompt you to return 'back to Module Administration 
page' and then is the install complete.

7) Hover the mouse over the Gallery icon and click Preferences in the pop-up menu.

8) Important!  Configure Gallery for your server.  An important setting is the 
Graphis Suite options (Path to NetPBM / Path to ImageMagick / Graphics Suite). 
See the next section for details on that.


-------------
Graphics Suite:
-------------

You need to know the path to your NetPBM *or* ImageMagick suite is located, and 
configure XoopsGallery accordingly.  You can check the settings to be sure it is 
working properly by accessing "Check NetPBM" or "Check ImageMagick" from your 
admin menu. 

Pesonally, I am and always have used NetPBM for no particular reason other than 
it was the first one listed in the options.  You only need one of these suites 
configured for XoopsGallery to work.

If you have trouble with xoopsgallery, specifically "Problem creating 
thumbnails" or similar, see the troubleshooting pages on the Gallery website.

http://gallery.menalto.com/modules.php?op=modload&name=GalleryDocs&file=index&page=gallery1-install.faq.c.php#gallery1-install.faq.c.2


-------------
Gallery Remote:
-------------

Gallery Remote is a java applet that allows you to organize, rotate, and upload 
images into your XoopsGallery from your client.  Very handy if you post photos 
frequently and like to drag/drop files instead of select them one by one.

In order to use Gallery Remote, you need to:

1) Enable anonymous access to XoopsGallery

2) In Gallery Remote, set up the URL as follows:

	Username:	  {Your XOOPS username}
	Password:	  {Your XOOPS password}
	Gallery Type: Standalone
	Gallery URL:  {XOOPS root}/modules/xoopsgallery/

For Example:

	Username:	  jsmith
	Password:	  1337pass
	Gallery Type: Standalone
	Gallery URL:  http://www.mysite.com/modules/xoopsgallery/


-------------
Future:
-------------

In the near term, I will be addressing some of the known faults in XoopsGallery, 
and perhaps add in a few wishlist items.  If you find problems or have ideas, 
report them to the XoopsGallery distribution site or the XOOPS.org forums.

I have no idea what the future holds for XoopsGallery.  Gallery is currently on 
version 1.4 (and they are working on 2.0), so even the base code of XoopsGallery 
is dated. There are "a couple of teams" working on porting different galleries 
into XOOPS, hopefully one of them will be more functional than this is today.

However, XoopsGallery remains a very capable and functional gallery module for 
XOOPS2, and I hope you enjoy it.

-------------
History:
-------------

Version 1.3.3.2, 10/19/2003, by gstarrett
* Update xoopsgallery_images and xoopscomments table on album rename
* Set of patches from SirTanksAlot
* Fix for comments disappearing with nav buttons from bugger
* Fixed Shutterfly link
* Comments working with help from core team in xoops 2.0.5rc+
* Remove undeclared constant from require('init.php') lines to prevent warning
* Add index.html to each album root to discourage browsing
* Add index.html to tmp and albums to force directory creation
* New admin icon from vzBob
* Highlight image on top gallery page is now a link to the album it represents
* Added this readme file
* check_netpbm.php and check_imagemagick.php are now off the admin menu
* Enabled the Time Limit preference.
* Comment count hidden when comments disabled on module or album.
* Fixed formatting (somewhat) on Caption editor, slideshow, and search results
* Fixed album path on view_photo
* Added smarty tags to view_photo: <{$photoCaption}>, <{$photoIndex}>
* Added smarty tags to view_album: <{$row.pictures[i].index}> and <{$row.captions[i].index}>
* Converted navigation on view_album and view_photo to be rendered in smarty template.
* Fixed alignment of tables and pictures in album index and view albums
* Fixed comments appearing on wrong photo from system-generated links
* Too many other fixes, lost track!

Version 1.3.3, 4/23/2003, by Boobtoob
* As released by Boobtoob, from Ono with modifications.


(Much of the new install instructions were based on the Wf-Snippets readme.)

-------------
Known Issues:
-------------

The following is a list of known problems with XoopsGallery.  If you have a fix 
for them then please submit them to .

* ZIP file support on Photo Add is disabled for some reason
* ALT text is URL not description of image
* Hidden / Protected photos can appear in "new" and "random" blocks.
* Failed upload can leave DB entry with file but no assoc picture in album
* Lots of undefined variables in debug PHP output (Normal for Gallery 1.3.3).
* Reset counter can result in blank page (and sometimes PHP fault).
* Not fully set up for internationalization.
* Gallery remote use requires anonymous users have access to XoopsGallery


Wish List of features that are desired but not yet implemented:

* XOOPS Notification support
* Increase level of smarty assignments to allow more granular modification of templates.
* Watermarks (http://www.xoops.org/modules/newbb/viewtopic.php?topic_id=13041&forum=4&post_id=52229)
* Use XOOPS Groups in gallery permissions.

