README for GalAxML 0.1-b1 * GalAXML - Copyright (c) 2005 - Gordon Johnston * Contact: gordonj@newswall.org.uk * 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. Requirements ------------ You need the following Perl modules installed to run GalAxML: * XML::Writer * XML::Simple * PHP::Serialization And one of the below modules: either XML::Sablotron OR XML::LibXSLT All Perl modules are available on CPAN. Please note both LibXSLT and Sablotron are dependent on their C equivalents being installed on your system, they're just wrappers to the C modules. GalAxML should work or any Unix web server that handles CGI scripts correctly. Alternativly you can use AxKit to serve the web pages in which case you will need to use Apache 1.3 and mod_perl. 1) Move your Gallery instalation. If you are installing to the location where your main Gallery is installed at present you should move it before proceeding with the instalation. To do this move the installation, put it in 'configure' mode then update the paths in the config accordingly. You still need to have access to your Gallery instalation once you have installed GalAxML, all administration of your Gallery is performed through the normal Gallery interface. You can move your Gallery to a sub directory below GalAxML, it will function as expected. 2) Installing the web interface The /htdocs directory contains 1 - A /xml subdirectory containing configs and imported Gallery data 2 - A /stylesheets subdirectory containing XSLT/CSS stylesheets 3 - galaxml.cgi, a CGI script for using GalAxML in CGI mode Copy the contents of /htdocs to the directory of your webserver where you want to serve GalAxML from. 3) Configuring GalAxML Edit /htdocs/xml/settings.xml to match the settings for your Gallery instalation. Comments are included in this file to assist you. GalAxML can run in CGI or AxKit mode. In CGI mode a CGI script is used to handle the XSLT parsing chains. In AxKit mode this activity is handled by AxKit. 4) Importing your callery. In /bin you'll find galaxmlImport.pl, run this as follows ./galaxmlImport.pl --config /path/to/settings.xml This will import your Gallery into GalAxML. If your perl instalation isn't at /usr/bin/perl you may need to ammend the first line of galaxmlImport.pl, alternativly just run it like this: perl galaxmlImport.pl --config /path/to/settings.xml 5) Give it a go. Point your browser to the installed location and see if it works. If you're using the AxKit cache you may wish to preload the cache. You can use wget to do this, just issue a: wget -r -nd --delete-after http://location.com/of/your/gallery 6) Tweaking GalAxML By default GalAxML returns valid XHTML 1.1. You can choose to return any HTML standard from 4.01 Transitional or above. This is defined towards the top of wrapperHTML.xslt in the stylesheets directory. Just adjust the comments so the xsl:output block relating to the format you want is selected. If you would like to add a header or footer to your page open wrapperHTML.xslt and scroll down to and follow the comments there. GalAxML honours your Gallery settings regarding allowing viewers to view full size images and if dimensions are shown for photos when viewing an album. To make changes to these update your Gallery and reimport it. Alternativly you can override this behaviour for viewing full size images by updating your settings.xml. Please note GalAxML is currently BETA status, this means that data structures may still change such as the underling database and the XML format used between stylesheets. If you get 500 (Server error) errors with 'Directory Index not allowed here' you need to ensure 'AllowOverride Indexes' is set in your Apache config. 7) We'd love to hear your results. If you've any comments, good or bad, or find any bugs, please contact gordonj@newswall.org.uk. Alternativly you can post a bug or support request on the project page at http://sourceforge.net/projects/galaxml/ We hope you find GalAxML useful.