From 94784b38b15864616598a9d9e24e3945fe8dd4b1 Mon Sep 17 00:00:00 2001
From: Eugene Crosser <crosser@average.org>
Date: Thu, 4 Sep 2008 14:45:53 +0000
Subject: [PATCH] document header & footer

---
 include/footer.pl   | 11 ++++++++++-
 include/gallery.css |  3 +++
 include/header.pl   |  9 +++++++++
 3 files changed, 22 insertions(+), 1 deletion(-)

diff --git a/include/footer.pl b/include/footer.pl
index 7fa6b8c..1c246e3 100644
--- 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>"
diff --git a/include/gallery.css b/include/gallery.css
index e1ec824..44e360d 100644
--- a/include/gallery.css
+++ b/include/gallery.css
@@ -3,6 +3,9 @@
 
 	This is a part of mkgallery.pl suite
 	http://www.average.org/mkgallery/
+
+	DO NOT EDIT THIS FILE OR FACE RISK OF PROBLEMS ON UPGRADE
+	Instead, include custom modifications into custom.css
 */
 
 h2.ititle {
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>":"")
-- 
2.39.2