X-Git-Url: https://git.sommitrealweird.co.uk/bpgallery.git/blobdiff_plain/d159b57ca37ebdb3b9a1ef690acb0010de5e3638..5e305a2e0a9b4349300a38ceb39a6c67b6dfd7a4:/README diff --git a/README b/README index 0678ce9..df7e584 100644 --- a/README +++ b/README @@ -57,6 +57,20 @@ The following environment variables can also be used: 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 @@ -65,6 +79,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: + + 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