README

   1 Introduction
   2 ------------
   3 bpgallery is a small static gallery generator, it generates an index file and
   4 thumbnails of your images. The index file is generated in the image folder,
   5 icons in a subfolder called icons.
   6
   7 Requirements
   8 ------------
   9 The ImageMagick tools (convert and identify)
  10 bash
  11 GNU find
  12 GNU xargs
  13 sed
  14
  15 Installation
  16 ------------
  17 Copy the file bpgallery.sh to a directory in your PATH.
  18
  19 Usage
  20 -----
  21 bpgallery.sh /path/to/image/files
  22
  23 Also, the following files, if placed in the images directory, will be used to
  24 generate part of the index page:
  25         description.txt - a simple text file containing paragraphs to go at the
  26                           beginnings of the index page
  27         captions.txt - filename<tab>caption style file, it'll add a caption to
  28                        the images on the index page.
  29 The following environment variables can also be used:
  30         TITLE - the title of the gallery
  31         WIDTH - the width to make the icons
  32         BPGALLERY_THEME - set the theme to use (described below)
  33         OUTPUTHTML - sets the script output to be wrapped in a <pre> block
  34
  35 Example Usage:
  36         TITLE="My Funky Gallery" bpgallery.sh /path/to/image/files
  37
  38 Themes
  39 ------
  40 Theme support is very rudimentary, basically you create functions for each of
  41 the parts of the template, and put them in a file named the same as the theme.
  42 The functions that you need to declare are as follows:
  43         bpgallery_ThemeName_head()
  44                 what's it for?:
  45                         This sets up the header for the page, generally
  46                         everything until the first picture. So, the title bar
  47                         and any menus you would like to use
  48                 available variables:
  49                         $TITLE       - the title for the index page
  50         bpgallery_ThemeName_tail()
  51                 what's it for?:
  52                         Closes the page, is the last thing to be printed.
  53                 available variables:
  54                         None
  55         bpgallery_ThemeName_description()
  56                 what's it for?:
  57                         if there's a description set up (i.e. a description.txt
  58                         file) then this is what it'll be wrapped in. It comes
  59                         just after the _head.
  60                 available variables:
  61                         $DESCRIPTION - the content of description.txt
  62         bpgallery_ThemeName_stylesheet()
  63                 what's if for?:
  64                         It generates the stylesheet for the page.
  65                 available variables:
  66                         $WIDTH       - the width of the images
  67                         $MAXHEIGHT   - the maximum height of the image
  68         bpgallery_ThemeName_thumbsline()
  69                 what's it for?:
  70                         Whatever is in here is generated per thumbnail.
  71                 available variables:
  72                         $filename    - the name of the file
  73                         $caption     - the caption as got from captions.txt
  74
  75 If any of the functions are not defined in a theme then the default theme
  76 function will be used instead. The default theme is clean and simplistic, this
  77 is deliberate!
  78
  79 Author
  80 ------
  81 Brett Parker:
  82         e-mail: <iDunno@sommitrealweird.co.uk>
  83         www:    http://www.sommitrealweird.co.uk/