1 Version
$Id: README,v 1.5 2003/02/12 02:52:59 mavrik Exp $
2 Overview
In general, building the project's documentation is not necessary
because it comes prebuilt with the distribution. However, in the
event that you do need to build it, you may be required to modify
Html.pm. The instructions on how to do this are given in the
next section.
3 Patching Html.pm
Before patching Html.pm, find out where Html.pm is located on
your system. Then, check to see that its MD5 hash matches the
one provided here:
MD5 (Html.pm) = 5f16c14462cfba6cdc1735236ecd5ea6
To patch Html.pm by hand, do the following:
- Remove the LINK tag code. Search for LINK.
- Add an if block around the index code. Search for INDEX.
if ($doindex) { }
- Add https to the list of urls. Search for "my $urls".
- Remove paragraph tag from process_head().
- Balance paragraph tags in pod2html() (i.e. add
).
- Add 2 to the heading value. Search for "my $level".
To patch Html.pm with patch, do the following:
- Create a patch file named Html.pm.diff that contains the diff
output provided at the bottom of this document. The following
command will conveniently create the patch file for you.
sed -e '1,/^--- Html.pm.diff ---$/d; /^--- Html.pm.diff ---$/,$d' README > Html.pm.diff
The patch file should have the following MD5 hash:
MD5 (Html.pm.diff) = 1161fcbd5bfe370e377b43d50d4bb7ab
- Run the following command:
patch < Html.pm.diff
You probably will be required to input the actual location
of the file being patched.
--- Html.pm.diff ---
--- /usr/libdata/perl/5.00503/Pod/Html.pm Mon Jan 27 09:50:20 2003
+++ /usr/libdata/perl/5.00503/Pod/Html.pm.new Tue Feb 11 20:57:54 2003
@@ -332,11 +332,13 @@
$title = ($podfile eq "-" ? 'No Title' : $1);
warn "using $title" if $verbose;
}
+#
+# 2000-12-28 klm, Eliminated the LINK tag.
+#
print HTML <$title
-
@@ -352,6 +354,11 @@
# put an index at the top of the file. note, if $doindex is 0 we
# still generate an index, but surround it with an html comment.
# that way some other program can extract it if desired.
+#
+# 2000-12-28 klm, Don't put the index in if --noindex has been set.
+#
+if ($doindex)
+{
$index =~ s/--+/-/g;
print HTML "\n";
print HTML "\n" unless $doindex;
print HTML "\n\n";
print HTML "\n" if $doindex;
+}
# now convert this file
warn "Converting input file\n" if $verbose;
@@ -402,7 +410,10 @@
next if @begin_stack && $begin_stack[-1] ne 'html';
my $text = $_;
process_text(\$text, 1);
- print HTML "
\n";
}
}
@@ -857,12 +868,17 @@
# figure out the level of the =head
$tag =~ /head([1-6])/;
- my $level = $1;
+#
+# 2001-01-15 klm, Added 2 to the heading value.
+#
+ my $level = $1 + 2;
# can't have a heading full of spaces and speechmarks and so on
$firstword = $heading; $firstword =~ s/\s*(\w+)\s.*/$1/;
- print HTML "