X-Git-Url: https://git.sommitrealweird.co.uk/bpgallery.git/blobdiff_plain/b53a01a10ef10a699efae79e7b44d4e8d62eedd5..210d915d4e2f21b063ebd0f3f6d8277b4a331f93:/README diff --git a/README b/README index 84a566b..0678ce9 100644 --- a/README +++ b/README @@ -22,14 +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 - filenamecaption 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 + filenamecaption 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) + 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
 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
@@ -68,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