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.
9 The ImageMagick tools (convert and identify)
17 Copy the file bpgallery.sh to a directory in your PATH.
21 bpgallery.sh /path/to/image/files
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 BPGALLERY_THEME_DIR - set an extra location to look for themes
34 OUTPUTHTML - sets the script output to be wrapped in a <pre> block
37 TITLE="My Funky Gallery" bpgallery.sh /path/to/image/files
41 Theme support is very rudimentary, basically you create functions for each of
42 the parts of the template, and put them in a file named the same as the theme.
43 The functions that you need to declare are as follows:
44 bpgallery_ThemeName_head()
46 This sets up the header for the page, generally
47 everything until the first picture. So, the title bar
48 and any menus you would like to use
50 $TITLE - the title for the index page
51 bpgallery_ThemeName_tail()
53 Closes the page, is the last thing to be printed.
56 bpgallery_ThemeName_description()
58 if there's a description set up (i.e. a description.txt
59 file) then this is what it'll be wrapped in. It comes
62 $DESCRIPTION - the content of description.txt
63 bpgallery_ThemeName_stylesheet()
65 It generates the stylesheet for the page.
67 $WIDTH - the width of the images
68 $MAXHEIGHT - the maximum height of the image
69 bpgallery_ThemeName_thumbsline()
71 Whatever is in here is generated per thumbnail.
73 $filename - the name of the file
74 $caption - the caption as got from captions.txt
76 If any of the functions are not defined in a theme then the default theme
77 function will be used instead. The default theme is clean and simplistic, this
83 e-mail: <iDunno@sommitrealweird.co.uk>
84 www: http://www.sommitrealweird.co.uk/