document header & footer

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>"

diff --git a/include/gallery.css b/include/gallery.css
index e1ec8243a15c48c258527805c566e32a2fda5b3f..44e360d47c7f094b409490997993e3b951d2874e 100644 (file)
--- 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 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>":"")