* Update changelog

[bpgallery.git] / README

diff --git a/README b/README
index 81c0a4ed02955628fccb88b75ab596273eab17bc..df7e5843ffff94971984f470c4572116c5fcd362 100644 (file)
--- a/README
+++ b/README
@@ -22,18 +22,54 @@ bpgallery.sh /path/to/image/files
 
 Also, the following files, if placed in the images directory, will be used to
 generate part of the index page:
-        description.txt - a simple text file containing paragraphs to go at the
-                          beginnings of the index page
-        captions.txt - filename<tab>caption style file, it'll add a caption to
-                       the images on the index page.
+        description.txt
+            a simple text file containing paragraphs to go at the beginnings of
+            the index page
+        captions.txt
+            filename<tab>caption style file, it'll add a caption to the images
+            on the index page.
+
 The following environment variables can also be used:
-        TITLE - the title of the gallery
-        WIDTH - the width to make the icons
-        BPGALLERY_THEME - set the theme to use (described below)
-        BPGALLERY_THEME_DIR - set an extra location to look for themes
-        OUTPUTHTML - sets the script output to be wrapped in a <pre> block
-        GENERATEPAGESFORFULLSIZE - decide wether to generate pages for the full
-                                   size images or not
+        TITLE
+            the title of the gallery
+
+        WIDTH
+            the width to make the icons
+
+        MEDIUMWIDTH
+            set the width of images in the medium size pages
+
+        BPGALLERY_THEME
+            set the theme to use (described below)
+
+        BPGALLERY_THEME_DIR
+            set an extra location to look for themes
+
+        OUTPUTHTML
+            sets the script output to be wrapped in a <pre> block
+
+        GENERATEPAGESFORMEDIUMSIZE
+            generate medium sized images and pages
+
+        GENERATEPAGESFORFULLSIZE
+            decide wether to generate pages for the full size images or not
+
+        INDEXDOCUMENT
+            name of the index page (e.g. index.html)
+
+        PAGESDIRECTORY
+            name of the directory in which to put the pages for fullsized and
+            mediumsized images. Defaults to the image directory. This is
+            relative to the images directory, so, for example,
+            PAGESDIRECTORY=pages would create /path/to/image/files/pages
+
+        MEDIUMDIRECTORY
+            directory to generate medium sized images in, defaults to medium,
+            works the same as the PAGESDIRECTORY variable
+
+        ICONSDIRECTORY
+            directory to generate thumbnails in, defaults to icons, works the
+            same as MEDIUMDIRECTORY and PAGESDIRECTORY
 
 Example Usage:
         TITLE="My Funky Gallery" bpgallery.sh /path/to/image/files
@@ -43,6 +79,13 @@ Themes
 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:
+
+        Available in all templates:
+            ${BASEURL}
+                Base directory (will generate ../ when making pages in a
+                subdirectory for getting to the generated stylesheet or to the
+                index page)
+
         bpgallery_ThemeName_head()
                 what's it for?:
                         This sets up the header for the page, generally
@@ -72,13 +115,13 @@ The functions that you need to declare are as follows:
                 what's it for?:
                         Whatever is in here is generated per thumbnail.
                 available variables:
-                       $link        - the page/image to link to
+                        $link        - the page/image to link to
                         $filename    - the name of the file
                         $caption     - the caption as got from captions.txt
-       bpgallery_ThemeName_page()
-               what's it for?:
+        bpgallery_ThemeName_page()
+                what's it for?:
                         It generates the pages for fullsize image pages
-               available variables:
+                available variables:
                         $filename    - the name of the image
                         $previouspage - the URL for the previous page
                         $currentpage - the url for the current page