X-Git-Url: https://git.sommitrealweird.co.uk/bpgallery.git/blobdiff_plain/7ef6a62b83bf172619e03032828d59be3afc1bba..d62a41ddcf501d3c1a147f544dc6fa1b032b2750:/README diff --git a/README b/README index 0825950..81c0a4e 100644 --- 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) + BPGALLERY_THEME_DIR - set an extra location to look for themes OUTPUTHTML - sets the script output to be wrapped in a
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
@@ -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:
+ $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