* Update documentation

[bpgallery.git] / README

diff --git a/README b/README
index 0678ce978882b51100af845a3dfdc6eee5615ed3..026262f6c6f043b6c93be95947b7ed1213b44b9b 100644 (file)
--- a/README
+++ b/README
@@ -29,6 +29,12 @@ generate part of the index page:
             filename<tab>caption style file, it'll add a caption to the images
             on the index page.
 
             filename<tab>caption style file, it'll add a caption to the images
             on the index page.
 

+If both width and height are specified then it'll be resized to the bounding
+box that contains it.
+
+If height is specified without width then the bounding box will be 100xHEIGHT
+for icons and 400xMEDIUMHEIGHT for the medium sized image pages
+

 The following environment variables can also be used:
         TITLE
             the title of the gallery
 The following environment variables can also be used:
         TITLE
             the title of the gallery


@@ -36,9 +42,15 @@ The following environment variables can also be used:
         WIDTH
             the width to make the icons
 
         WIDTH
             the width to make the icons
 

+        HEIGHT
+            the height to make the icons
+

         MEDIUMWIDTH
             set the width of images in the medium size pages
 
         MEDIUMWIDTH
             set the width of images in the medium size pages
 

+        MEDIUMHEIGHT
+            the height to make images in the medium size pages
+

         BPGALLERY_THEME
             set the theme to use (described below)
 
         BPGALLERY_THEME
             set the theme to use (described below)
 


@@ -57,6 +69,20 @@ The following environment variables can also be used:
         INDEXDOCUMENT
             name of the index page (e.g. index.html)
 
         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
 
 Example Usage:
         TITLE="My Funky Gallery" bpgallery.sh /path/to/image/files
 


@@ -65,6 +91,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:
 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
         bpgallery_ThemeName_head()
                 what's it for?:
                         This sets up the header for the page, generally


@@ -89,7 +122,8 @@ The functions that you need to declare are as follows:
                         It generates the stylesheet for the page.
                 available variables:
                         $WIDTH       - the width of the images
                         It generates the stylesheet for the page.
                 available variables:
                         $WIDTH       - the width of the images

-                        $MAXHEIGHT   - the maximum height of the image
+                        $MAXWIDTH    - the maximum width of the images
+                        $MAXHEIGHT   - the maximum height of the images

         bpgallery_ThemeName_thumbsline()
                 what's it for?:
                         Whatever is in here is generated per thumbnail.
         bpgallery_ThemeName_thumbsline()
                 what's it for?:
                         Whatever is in here is generated per thumbnail.