X-Git-Url: http://www.average.org/gitweb/?p=mkgallery.git;a=blobdiff_plain;f=include%2Fheader.pl;fp=include%2Fheader.pl;h=62ef345d90c0aec5e056ad1730a8260dc21071e0;hp=e1f9c965dd0b906706fe83e6386b29098f182dc7;hb=94784b38b15864616598a9d9e24e3945fe8dd4b1;hpb=46c35837ebf71a013ec383f71e3f8f5424823334

diff --git a/include/header.pl b/include/header.pl
index e1f9c96..62ef345 100644
--- a/include/header.pl
+++ b/include/header.pl
@@ -1,2 +1,11 @@
+# this gets `eval`-ed and must return a string to be included in the
+# index html page at the top.
+
+# 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
+
 "<h1 class=\"title\">$_{-title}</h1>".
 ($_{-depth}?"<div class=\"linkup\"><a href=\"../index.html\">UP</a></div>":"")