Introduction
------------
bpgallery is a small static gallery generator, it generates an index file and
thumbnails of your images. The index file is generated in the image folder,
icons in a subfolder called icons.

Requirements
------------
The ImageMagick tools (convert and identify)
bash
GNU find
GNU xargs
sed

Installation
------------
Copy the file bpgallery.sh to a directory in your PATH.

Usage
-----
bpgallery.sh /path/to/image/files

Also, the following files, if placed in the images directory, will be used to
generate part of the index page:
        description.txt - a simple text file containing paragraphs to go at the
                          beginnings of the index page
        captions.txt - filename<tab>caption style file, it'll add a caption to
                       the images on the index page.
The following environment variables can also be used:
        TITLE - the title of the gallery
        WIDTH - the width to make the icons
        BPGALLERY_THEME - set the theme to use (described below)
        BPGALLERY_THEME_DIR - set an extra location to look for themes
        OUTPUTHTML - sets the script output to be wrapped in a <pre> block
        GENERATEPAGESFORFULLSIZE - decide wether to generate pages for the full
                                   size images or not

Example Usage:
        TITLE="My Funky Gallery" bpgallery.sh /path/to/image/files

Themes
------
Theme support is very rudimentary, basically you create functions for each of
the parts of the template, and put them in a file named the same as the theme.
The functions that you need to declare are as follows:
        bpgallery_ThemeName_head()
                what's it for?:
                        This sets up the header for the page, generally
                        everything until the first picture. So, the title bar
                        and any menus you would like to use
                available variables:
                        $TITLE       - the title for the index page
        bpgallery_ThemeName_tail()
                what's it for?:
                        Closes the page, is the last thing to be printed.
                available variables:
                        None
        bpgallery_ThemeName_description()
                what's it for?:
                        if there's a description set up (i.e. a description.txt
                        file) then this is what it'll be wrapped in. It comes
                        just after the _head.
                available variables:
                        $DESCRIPTION - the content of description.txt
        bpgallery_ThemeName_stylesheet()
                what's if for?:
                        It generates the stylesheet for the page.
                available variables:
                        $WIDTH       - the width of the images
                        $MAXHEIGHT   - the maximum height of the image
        bpgallery_ThemeName_thumbsline()
                what's it for?:
                        Whatever is in here is generated per thumbnail.
                available variables:
		        $link        - the page/image to link to
                        $filename    - the name of the file
                        $caption     - the caption as got from captions.txt
	bpgallery_ThemeName_page()
		what's it for?:
                        It generates the pages for fullsize image pages
		available variables:
                        $filename    - the name of the image
                        $previouspage - the URL for the previous page
                        $currentpage - the url for the current page
                        $nextpage    - the url for the next page
                        $caption     - the image caption

If any of the functions are not defined in a theme then the default theme
function will be used instead. The default theme is clean and simplistic, this
is deliberate!

Author
------
Brett Parker:
        e-mail: <iDunno@sommitrealweird.co.uk>
        www:    http://www.sommitrealweird.co.uk/