#!/usr/bin/perl -w
package OpenAFS::HTML;
use strict;
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 = '
' . "\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');
my ($name, $section) = ($page =~ /^([^\(]+)\((\d+)\)$/);
return unless $name;
my @url = ('..', $section, $name);
return join ('/', map { $self->pagepath_url_escape ($_) } @url)
. $Pod::Simple::HTML::HTML_EXTENSION;
}
# Underscore isn't allowed in man page names in Pod::Simple 3.04, so links
# like L show up as POD links. Discover that case and dispatch
# everything else to the standard do_pod_link implementation.
sub do_pod_link {
my ($self, $token) = @_;
my $target = $token->attr ('to');
if ($target && $target =~ /^([^\s\(]+)\((\d+)\)$/) {
return $self->do_man_link ($token);
} else {
return $self->SUPER::do_pod_link ($token);
}
}
sub VERSION () { '1.1' }
$Pod::Simple::HTML::Tagmap{'item-bullet'} = '
';
$Pod::Simple::HTML::Tagmap{'/item-bullet'} = '
';
$Pod::Simple::HTML::Tagmap{'item-number'} = '
';
$Pod::Simple::HTML::Tagmap{'/item-number'} = '
';
# This horrific hack is required because Pod::Simple::HTMLBatch has no way
# of setting search options and we have to set laborious to true in order
# to pick up man pages like krb.conf(5).
package OpenAFS::Search;
use strict;
use vars qw(@ISA);
use Pod::Simple::Search;
@ISA = qw(Pod::Simple::HTML);
sub new {
my $class = shift;
my $object = Pod::Simple::Search->new;
$object->laborious (1);
return $object;
}
package main;
use strict;
use File::Copy;
use Pod::Simple::HTMLBatch;
# Override the search class to set laborious.
$Pod::Simple::HTMLBatch::SEARCH_CLASS = 'OpenAFS::Search';
our $HEADER = <<'EOH';
OpenAFS Reference Manual
OpenAFS Reference Manual
EOH
our %HEADINGS = (1 => 'User Commands',
3 => 'C Library Functions',
5 => 'Configuration and Data Files',
8 => 'Administrator Commands');
# Scan all of the POD files and build a list of section, name, and short
# description, returning that as an array.
sub scan_names {
my @index;
for my $dir (qw(pod1 pod3 pod5 pod8)) {
my $section = $dir;
$section =~ s/^pod//;
opendir (D, $dir) or die "Cannot open $dir: $!\n";
for my $file (sort grep { !/^\./ && /\.pod$/ } readdir D) {
open (F, "$dir/$file") or die "Cannot open $dir/$file: $!\n";
my ($name, $desc);
local $_;
while () {
last if /^=head1/ && !/^=head1\s+NAME\b/;
next unless /\s+-\s+/;
($name, $desc) = split (/\s+-\s+/, $_, 2);
}
unless ($name) {
warn "$dir/$file: cannot find NAME section, skipping\n";
}
$name =~ s/^(backup|bos|fs|fstrace|kas|pts|symlink|uss|vos)_/$1 /;
if ($section eq '3') {
$name =~ s/^AFS\./AFS::/;
}
if ($section eq '5') {
$name =~ s/_/ /g;
}
my $page = $file;
$page =~ s/\.pod$//;
push (@index, [ $section, $name, $page, $desc ]);
}
closedir D;
}
return @index;
}
unless (-d 'html') {
mkdir ('html', 0755) or die "Cannot create html directory: $!\n";
}
for my $dir (qw(pod1 pod3 pod5 pod8)) {
my $section = $dir;
$section =~ s/^pod//;
mkdir ("html/$section", 0755) unless -d "html/$section";
my $conv = Pod::Simple::HTMLBatch->new;
$conv->verbose (0);
$conv->index (undef);
$conv->contents_file (undef);
$conv->add_css ('../style.css', 1);
$conv->css_flurry (0);
$conv->javascript_flurry (0);
$conv->html_render_class ('OpenAFS::HTML');
$conv->batch_convert ($dir, "html/$section");
}
copy ('style.css', 'html/style.css') or die "Cannot copy style.css: $!\n";
open (INDEX, '> html/index.html')
or die "Cannot create html/index.html: $!\n";
print INDEX $HEADER;
print INDEX "
\n";
my @index = scan_names;
my $current;
for my $entry (@index) {
my ($section, $name, $page, $desc) = @$entry;
for ($name, $desc) {
s/&/>/g;
s//>/g;
}
if (!$current || $section != $current) {
print INDEX qq(