Add ability to generate pages in a seperate directory

[bpgallery.git] / README

diff --git a/README b/README
index 6b9f99d2c3339c3d95140e03c94b88ef03187d7b..0678ce978882b51100af845a3dfdc6eee5615ed3 100644 (file)
--- a/README
+++ b/README
@@ -22,16 +22,40 @@ 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
+        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)
 
 Example Usage:
         TITLE="My Funky Gallery" bpgallery.sh /path/to/image/files
@@ -70,8 +94,18 @@ 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
                         $filename    - the name of the file
                         $caption     - the caption as got from captions.txt
+        bpgallery_ThemeName_page()
+                what's it for?:
+                        It generates the pages for fullsize image pages
+                available variables:
+                        $filename    - the name of the image
+                        $previouspage - the URL for the previous page
+                        $currentpage - the url for the current page
+                        $nextpage    - the url for the next page
+                        $caption     - the image caption
 
 If any of the functions are not defined in a theme then the default theme
 function will be used instead. The default theme is clean and simplistic, this