From: Brett Parker <arch@sommitrealweird.co.uk>
Date: Tue, 16 Aug 2005 00:02:26 +0000 (+0000)
Subject: Update the documentation
X-Git-Tag: release-1.0.1~3
X-Git-Url: https://git.sommitrealweird.co.uk/bpgallery.git/commitdiff_plain/8471a9037b82239c3e82505ac2f1663c44cc9596

Update the documentation

Add some entries to the TODO list, and, also, add documentation on the Theme support to the README file.

git-archimport-id: arch@sommitrealweird.co.uk--2005-desktop/bpgallery--mainline--1.0--patch-8
---

diff --git a/README b/README
index 9a4aec8..5657915 100644
--- a/README
+++ b/README
@@ -33,6 +33,45 @@ The following environment variables can also be used:
 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
+
+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
+is deliberate!
+
 Author
 ------
 Brett Parker:
diff --git a/TODO b/TODO
index f3e5d23..05290a6 100644
--- a/TODO
+++ b/TODO
@@ -1,7 +1,10 @@
-* Add in a middle image size, so thumbs -> medium -> full size
+* Add in a middle image size, so thumbs -> medium -> full size (and option for
+  this)
 * Allow to recreate galleries and use new captions (only resizing changed
   images) - mostly done, needs to be able to check and change based on
   the width specified then it'll be finished
 * Allow a fixed height to be specified instead or as well as a fixed width, in
   the latter case, resize to which ever fits the bounding box, but keep the
   aspect ratio.
+* Make sure that the tools we require are available (i.e. check that we have
+  xargs, convert, identify etc)