]> git.sommitrealweird.co.uk Git - bpgallery.git/blob - README
Update the documentation
[bpgallery.git] / 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
33 Example Usage:
34         TITLE="My Funky Gallery" bpgallery.sh /path/to/image/files
35
36 Themes
37 ------
38 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:
39         bpgallery_ThemeName_head()
40                 what's it for?:
41                         This sets up the header for the page, generally
42                         everything until the first picture. So, the title bar
43                         and any menus you would like to use
44                 available variables:
45                         $TITLE       - the title for the index page
46         bpgallery_ThemeName_tail()
47                 what's it for?:
48                         Closes the page, is the last thing to be printed.
49                 available variables:
50                         None
51         bpgallery_ThemeName_description()
52                 what's it for?:
53                         if there's a description set up (i.e. a description.txt
54                         file) then this is what it'll be wrapped in. It comes
55                         just after the _head.
56                 available variables:
57                         $DESCRIPTION - the content of description.txt
58         bpgallery_ThemeName_stylesheet()
59                 what's if for?:
60                         It generates the stylesheet for the page.
61                 available variables:
62                         $WIDTH       - the width of the images
63                         $MAXHEIGHT   - the maximum height of the image
64         bpgallery_ThemeName_thumbsline()
65                 what's it for?:
66                         Whatever is in here is generated per thumbnail.
67                 available variables:
68                         $filename    - the name of the file
69                         $caption     - the caption as got from captions.txt
70
71 If any of the functions are not defined in a theme then the default theme
72 function will be used instead. The default theme is clean and simplistic, this
73 is deliberate!
74
75 Author
76 ------
77 Brett Parker:
78         e-mail: <iDunno@sommitrealweird.co.uk>
79         www:    http://www.sommitrealweird.co.uk/