From: Russ Allbery <rra@stanford.edu>
Date: Mon, 14 Jul 2008 03:04:08 +0000 (+0000)
Subject: STABLE14-html-man-index-links-20060802
X-Git-Tag: openafs-stable-1_4_8pre1~44
X-Git-Url: https://git.michaelhowe.org/gitweb/?a=commitdiff_plain;h=1112a44af39bcf33afef072fc11a38c84134a3b0;p=packages%2Fo%2Fopenafs.git

STABLE14-html-man-index-links-20060802


Add links back to the index at the top and bottom of each generated page.


(cherry picked from commit b57f675bc3364c17fccc58ed56307f91213d3b3d)
---

diff --git a/doc/man-pages/generate-html b/doc/man-pages/generate-html
index 83570b1bb..610a7db03 100755
--- a/doc/man-pages/generate-html
+++ b/doc/man-pages/generate-html
@@ -7,6 +7,28 @@ use vars qw(@ISA);
 use Pod::Simple::Search;
 @ISA = qw(Pod::Simple::HTML);
 
+# Add a link back to the index page to the top and bottom of each generated
+# page.
+#
+# The hideous approach we have to use is because, unless we create a
+# Pod::Simple::HTML object and then rebless it, the html_header_after_title
+# and html_footer subs are placed in the OpenAFS::HTML package.  That means we
+# can't override them in a subclass and still call the SUPER version since
+# we'll be overwriting the SUPER version, and there aren't other good
+# opportunities to change the default values that I can see.
+sub new {
+    my $class = shift;
+    my $self = Pod::Simple::HTML->new (@_);
+    bless ($self, 'OpenAFS::HTML');
+    my $link = '<p class="indexlink"><a href="../index.html">'
+        . 'Back to Index</a></p>' . "\n";
+    my $after = $self->html_header_after_title;
+    $self->html_header_after_title ($after . $link);
+    my $end = $self->html_footer;
+    $self->html_footer ($link . $end);
+    return $self;
+}
+
 sub do_man_link {
     my ($self, $token) = @_;
     my $page = $token->attr ('to');
diff --git a/doc/man-pages/style.css b/doc/man-pages/style.css
index 475925bba..91d8d7a4e 100644
--- a/doc/man-pages/style.css
+++ b/doc/man-pages/style.css
@@ -30,6 +30,8 @@
     background-color: #fff;
   }
 
+  p.indexlink { text-align: right }
+
   body.pod h1 { font-size: large }
   body.pod h2 { font-size: large }