document header & footer

[mkgallery.git] / include / header.pl

diff --git a/include/header.pl b/include/header.pl
index e1f9c965dd0b906706fe83e6386b29098f182dc7..62ef345d90c0aec5e056ad1730a8260dc21071e0 100644 (file)
--- 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>":"")