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:
26 a simple text file containing paragraphs to go at the beginnings of
29 filename<tab>caption style file, it'll add a caption to the images
32 The following environment variables can also be used:
34 the title of the gallery
37 the width to make the icons
40 set the width of images in the medium size pages
43 set the theme to use (described below)
46 set an extra location to look for themes
49 sets the script output to be wrapped in a <pre> block
51 GENERATEPAGESFORMEDIUMSIZE
52 generate medium sized images and pages
54 GENERATEPAGESFORFULLSIZE
55 decide wether to generate pages for the full size images or not
58 name of the index page (e.g. index.html)
61 name of the directory in which to put the pages for fullsized and
62 mediumsized images. Defaults to the image directory. This is
63 relative to the images directory, so, for example,
64 PAGESDIRECTORY=pages would create /path/to/image/files/pages
67 directory to generate medium sized images in, defaults to medium,
68 works the same as the PAGESDIRECTORY variable
71 directory to generate thumbnails in, defaults to icons, works the
72 same as MEDIUMDIRECTORY and PAGESDIRECTORY
75 TITLE="My Funky Gallery" bpgallery.sh /path/to/image/files
79 Theme support is very rudimentary, basically you create functions for each of
80 the parts of the template, and put them in a file named the same as the theme.
81 The functions that you need to declare are as follows:
83 Available in all templates:
85 Base directory (will generate ../ when making pages in a
86 subdirectory for getting to the generated stylesheet or to the
89 bpgallery_ThemeName_head()
91 This sets up the header for the page, generally
92 everything until the first picture. So, the title bar
93 and any menus you would like to use
95 $TITLE - the title for the index page
96 bpgallery_ThemeName_tail()
98 Closes the page, is the last thing to be printed.
101 bpgallery_ThemeName_description()
103 if there's a description set up (i.e. a description.txt
104 file) then this is what it'll be wrapped in. It comes
105 just after the _head.
107 $DESCRIPTION - the content of description.txt
108 bpgallery_ThemeName_stylesheet()
110 It generates the stylesheet for the page.
112 $WIDTH - the width of the images
113 $MAXHEIGHT - the maximum height of the image
114 bpgallery_ThemeName_thumbsline()
116 Whatever is in here is generated per thumbnail.
118 $link - the page/image to link to
119 $filename - the name of the file
120 $caption - the caption as got from captions.txt
121 bpgallery_ThemeName_page()
123 It generates the pages for fullsize image pages
125 $filename - the name of the image
126 $previouspage - the URL for the previous page
127 $currentpage - the url for the current page
128 $nextpage - the url for the next page
129 $caption - the image caption
131 If any of the functions are not defined in a theme then the default theme
132 function will be used instead. The default theme is clean and simplistic, this
138 e-mail: <iDunno@sommitrealweird.co.uk>
139 www: http://www.sommitrealweird.co.uk/