document header & footer

[mkgallery.git] / include / footer.pl

diff --git a/include/footer.pl b/include/footer.pl
index 7fa6b8c67b01da8688ac8d171a90293c47dfe4c8..1c246e3cab194661c34f9076fa084db46970ff06 100644 (file)
--- a/include/footer.pl
+++ b/include/footer.pl
@@ -1 +1,10 @@
-"<div class=\"genby\">generated by $_{-version}</div>";
+# this gets `eval`-ed and must return a string to be included in the
+# index html page at the bottom.
+
+# The following variables are documented:
+# $_{-version}         SVN release of the running script
+# $_{-depth}           subdir depth relative to the "top" with .gallery2
+# $_{-title}           title of the current subdir (.title contents)
+# $_{-breadcrumbs}     not implemented at the moment
+
+"<div class=\"genby\">generated by $_{-version}</div>"