X-Git-Url: https://git.sommitrealweird.co.uk/bpgallery.git/blobdiff_plain/4e9ad17280e911da8026f21269285aed622de238..b53a01a10ef10a699efae79e7b44d4e8d62eedd5:/README?ds=sidebyside diff --git a/README b/README index 5657915..84a566b 100644 --- a/README +++ b/README @@ -29,44 +29,47 @@ generate part of 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) Example Usage: TITLE="My Funky Gallery" bpgallery.sh /path/to/image/files 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: - bpgallery_ThemeName_head() - what's it for?: - This sets up the header for the page, generally - everything until the first picture. So, the title bar - and any menus you would like to use - available variables: - $TITLE - the title for the index page - bpgallery_ThemeName_tail() - what's it for?: - Closes the page, is the last thing to be printed. - available variables: - None - bpgallery_ThemeName_description() - what's it for?: - if there's a description set up (i.e. a description.txt - file) then this is what it'll be wrapped in. It comes - just after the _head. - available variables: - $DESCRIPTION - the content of description.txt - bpgallery_ThemeName_stylesheet() - what's if for?: - It generates the stylesheet for the page. - available variables: - $WIDTH - the width of the images - $MAXHEIGHT - the maximum height of the image - bpgallery_ThemeName_thumbsline() - what's it for?: - Whatever is in here is generated per thumbnail. - available variables: - $filename - the name of the file - $caption - the caption as got from captions.txt +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: + bpgallery_ThemeName_head() + what's it for?: + This sets up the header for the page, generally + everything until the first picture. So, the title bar + and any menus you would like to use + available variables: + $TITLE - the title for the index page + bpgallery_ThemeName_tail() + what's it for?: + Closes the page, is the last thing to be printed. + available variables: + None + bpgallery_ThemeName_description() + what's it for?: + if there's a description set up (i.e. a description.txt + file) then this is what it'll be wrapped in. It comes + just after the _head. + available variables: + $DESCRIPTION - the content of description.txt + bpgallery_ThemeName_stylesheet() + what's if for?: + It generates the stylesheet for the page. + available variables: + $WIDTH - the width of the images + $MAXHEIGHT - the maximum height of the image + bpgallery_ThemeName_thumbsline() + what's it for?: + Whatever is in here is generated per thumbnail. + available variables: + $filename - the name of the file + $caption - the caption as got from captions.txt 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