Preliminary addition of Medium Sized images and pages

[bpgallery.git] / README

diff --git a/README b/README
index 0825950c22e432e35b11b0e53ecc32e0c50b7d79..81c0a4ed02955628fccb88b75ab596273eab17bc 100644 (file)
--- a/README
+++ b/README
@@ -30,7 +30,10 @@ 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)
         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
         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

 
 Example Usage:
         TITLE="My Funky Gallery" bpgallery.sh /path/to/image/files
 
 Example Usage:
         TITLE="My Funky Gallery" bpgallery.sh /path/to/image/files


@@ -69,8 +72,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:
                 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
                         $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
 
 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