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
  26             a simple text file containing paragraphs to go at the beginnings of
  27             the index page
  28         captions.txt
  29             filename<tab>caption style file, it'll add a caption to the images
  30             on the index page.
  31
  32 The following environment variables can also be used:
  33         TITLE
  34             the title of the gallery
  35
  36         WIDTH
  37             the width to make the icons
  38
  39         MEDIUMWIDTH
  40             set the width of images in the medium size pages
  41
  42         BPGALLERY_THEME
  43             set the theme to use (described below)
  44
  45         BPGALLERY_THEME_DIR
  46             set an extra location to look for themes
  47
  48         OUTPUTHTML
  49             sets the script output to be wrapped in a <pre> block
  50
  51         GENERATEPAGESFORMEDIUMSIZE
  52             generate medium sized images and pages
  53
  54         GENERATEPAGESFORFULLSIZE
  55             decide wether to generate pages for the full size images or not
  56
  57         INDEXDOCUMENT
  58             name of the index page (e.g. index.html)
  59
  60 Example Usage:
  61         TITLE="My Funky Gallery" bpgallery.sh /path/to/image/files
  62
  63 Themes
  64 ------
  65 Theme support is very rudimentary, basically you create functions for each of
  66 the parts of the template, and put them in a file named the same as the theme.
  67 The functions that you need to declare are as follows:
  68         bpgallery_ThemeName_head()
  69                 what's it for?:
  70                         This sets up the header for the page, generally
  71                         everything until the first picture. So, the title bar
  72                         and any menus you would like to use
  73                 available variables:
  74                         $TITLE       - the title for the index page
  75         bpgallery_ThemeName_tail()
  76                 what's it for?:
  77                         Closes the page, is the last thing to be printed.
  78                 available variables:
  79                         None
  80         bpgallery_ThemeName_description()
  81                 what's it for?:
  82                         if there's a description set up (i.e. a description.txt
  83                         file) then this is what it'll be wrapped in. It comes
  84                         just after the _head.
  85                 available variables:
  86                         $DESCRIPTION - the content of description.txt
  87         bpgallery_ThemeName_stylesheet()
  88                 what's if for?:
  89                         It generates the stylesheet for the page.
  90                 available variables:
  91                         $WIDTH       - the width of the images
  92                         $MAXHEIGHT   - the maximum height of the image
  93         bpgallery_ThemeName_thumbsline()
  94                 what's it for?:
  95                         Whatever is in here is generated per thumbnail.
  96                 available variables:
  97                         $link        - the page/image to link to
  98                         $filename    - the name of the file
  99                         $caption     - the caption as got from captions.txt
 100         bpgallery_ThemeName_page()
 101                 what's it for?:
 102                         It generates the pages for fullsize image pages
 103                 available variables:
 104                         $filename    - the name of the image
 105                         $previouspage - the URL for the previous page
 106                         $currentpage - the url for the current page
 107                         $nextpage    - the url for the next page
 108                         $caption     - the image caption
 109
 110 If any of the functions are not defined in a theme then the default theme
 111 function will be used instead. The default theme is clean and simplistic, this
 112 is deliberate!
 113
 114 Author
 115 ------
 116 Brett Parker:
 117         e-mail: <iDunno@sommitrealweird.co.uk>
 118         www:    http://www.sommitrealweird.co.uk/