use strict;
use Config; # for config options in the makefile
-use File::Spec;
+use File::Path qw(remove_tree);
+use File::Spec::Functions qw(rel2abs no_upwards);
use Getopt::Long; # for command-line parsing
use Cwd;
-use Pod::Html 'anchorify';
+use Pod::Html 1.23 qw(anchorify relativize_url);
=head1 NAME
=head1 SYNOPSIS
- installhtml [--help] [--podpath=<name>:...:<name>] [--podroot=<name>]
- [--htmldir=<name>] [--htmlroot=<name>] [--norecurse] [--recurse]
- [--splithead=<name>,...,<name>] [--splititem=<name>,...,<name>]
- [--ignore=<name>,...,<name>] [--verbose]
+ installhtml [--help] [--podpath=<name>:...:<name>] [--podroot=<name>]
+ [--htmldir=<name>] [--htmlroot=<name>] [--norecurse] [--recurse]
+ [--splithead=<name>,...,<name>] [--splititem=<name>,...,<name>]
+ [--ignore=<name>,...,<name>] [--verbose]
=head1 DESCRIPTION
I<installhtml> converts a collection of POD pages to a corresponding
-collection of HTML pages. This is primarily used to convert the pod
-pages found in the perl distribution.
+collection of HTML pages. This is used to convert the pod pages found in the
+perl distribution. (It is not intended as a general-purpose
+converter/installer of POD pages in HTML format. See L<Pod::Html>.)
=head1 OPTIONS
=item B<--splititem> POD files to split on =item directive
-Comma-separated list of all pod files to split by the =item directive.
-The .pod suffix is optional. I<installhtml> does not do the actual
-split, rather it invokes I<splitpod> to do the dirty work. As with
---splithead, these files should have names specified relative to podroot.
+Comma-separated list of all pod files to split by the =item directive. The
+.pod suffix is optional. I<installhtml> does not do the actual split, rather
+it invokes I<splitpod>, a separate program in the Perl 5 core distribution,
+to do the dirty work. As with --splithead, these files should have names
+specified relative to podroot.
=item B<--splitpod> Directory containing the splitpod program
# See vms/descrip_mms.template -> descrip.mms for invocation.
if ( $^O eq 'VMS' ) { @ARGV = split(/\s+/,$ARGV[0]); }
-use vars qw( %Options );
+our %Options;
# parse the command-line
my $result = GetOptions( \%Options, qw(
# read in everything until what would have been the first =head
# directive, patching the index as we go.
- open(H, "<$file.html") ||
+ open(H, '<', "$file.html") ||
die "$0: error opening $file.html for input: $!\n";
$/ = "";
my @data = ();
while (<H>) {
- last if /name="name"/i;
+ last if m!<h1 id="NAME">NAME</h1>!;
$_ =~ s{href="#(.*)">}{
- my $url = "$pod/$1.html" ;
- $url = Pod::Html::relativize_url( $url, "$file.html" )
+ my $url = "$file/@{[anchorify(qq($1))]}.html" ;
+ $url = relativize_url( $url, "$file.html" )
if ( ! defined $Options{htmlroot} || $Options{htmlroot} eq '' );
"href=\"$url\">" ;
}egi;
close(H);
# now rewrite the file
- open(H, ">$file.html") ||
+ open(H, '>', "$file.html") ||
die "$0: error opening $file.html for output: $!\n";
- print H "@data", "\n";
+ print H @data, "</body>\n\n</html>\n\n\n";
close(H);
}
+remove_tree(@splitdirs, {safe=>1});
+
##############################################################################
sub create_index {
my($html, $dir) = @_;
(my $pod = $dir) =~ s,^.*/,,;
- my(@files, @filedata, @index, $file);
- my($lcp1,$lcp2);
-
# get the list of .html files in this directory
opendir(DIR, $dir) ||
die "$0: error opening directory $dir for reading: $!\n";
- @files = sort(grep(/\.html?$/, readdir(DIR)));
+ my @files = sort(grep(/\.html?$/, readdir(DIR)));
closedir(DIR);
- open(HTML, ">$html") ||
+ open(HTML, '>', $html) ||
die "$0: error opening $html for output: $!\n";
# for each .html file in the directory, extract the index
# embedded in the file and throw it into the big index.
print HTML "<DL COMPACT>\n";
- foreach $file (@files) {
- $/ = "";
+ foreach my $file (@files) {
- open(IN, "<$dir/$file") ||
- die "$0: error opening $dir/$file for input: $!\n";
- @filedata = <IN>;
- close(IN);
+ my $filedata = do {
+ open(my $in, '<', "$dir/$file") ||
+ die "$0: error opening $dir/$file for input: $!\n";
+ local $/ = undef;
+ <$in>;
+ };
# pull out the NAME section
- my $name;
- ($name) = grep(/name="name"/i, @filedata);
- ($lcp1,$lcp2) = ($name =~ m,/H1>\s(\S+)\s[\s-]*(.*?)\s*$,smi);
- if (defined $lcp1 and $lcp1 =~ m,^<P>$,i) { # Uninteresting. Try again.
- ($lcp1,$lcp2) = ($name =~ m,/H1>\s<P>\s*(\S+)\s[\s-]*(.*?)\s*$,smi);
- }
- my $url= "$pod/$file" ;
- if ( ! defined $Options{htmlroot} || $Options{htmlroot} eq '' ) {
- $url = Pod::Html::relativize_url( "$pod/$file", $html ) ;
- }
+ my($lcp1, $lcp2) =
+ ($filedata =~
+ m#<h1 id="NAME">NAME</h1>\s*<p>\s*(\S+)\s+-\s+(\S.*?\S)</p>#);
+ defined $lcp1 or die "$0: can't find NAME section in $dir/$file\n";
- if (defined $lcp1) {
- print HTML qq(<DT><A HREF="$url">);
- print HTML "$lcp1</A></DT><DD>$lcp2</DD>\n";
+ my $url= "$dir/$file" ;
+ if ( ! defined $Options{htmlroot} || $Options{htmlroot} eq '' ) {
+ $url = relativize_url( $url, $html ) ;
}
- next;
-
- @index = grep(/<!-- INDEX BEGIN -->.*<!-- INDEX END -->/s,
- @filedata);
- for (@index) {
- s/<!-- INDEX BEGIN -->(\s*<!--)(.*)(-->\s*)<!-- INDEX END -->/$lcp2/s;
- s,#,$dir/$file#,g;
- print HTML "$_\n<P><HR><P>\n";
- }
+ print HTML qq(<DT><A HREF="$url">);
+ print HTML "$lcp1</A></DT><DD>$lcp2</DD>\n";
}
print HTML "</DL>\n";
print "splitting files by item.\n" if $verbose && $#splititem >= 0;
$pwd = getcwd();
- my $splitter = File::Spec->rel2abs("$splitpod/splitpod", $pwd);
- my $perl = File::Spec->rel2abs($^X, $pwd);
+ my $splitter = rel2abs("$splitpod/splitpod", $pwd);
+ my $perl = rel2abs($^X, $pwd);
foreach my $pod (@splititem) {
# figure out the directory to split into
$pod =~ s,^([^/]*)$,/$1,;
# split the pod
push(@$splitdirs, "$podroot/$dirname");
- if (! -d "$podroot/$dirname") {
- mkdir("$podroot/$dirname", 0755) ||
+ -d "$podroot/$dirname" and remove_tree("$podroot/$dirname", {safe=>1});
+ mkdir("$podroot/$dirname", 0755) ||
die "$0: error creating directory $podroot/$dirname: $!\n";
- }
chdir("$podroot/$dirname") ||
die "$0: error changing to directory $podroot/$dirname: $!\n";
die "$splitter not found. Use '-splitpod dir' option.\n"
# read the file in paragraphs
$/ = "";
- open(SPLITIN, "<$pod") ||
+ open(SPLITIN, '<', $pod) ||
die "$0: error opening $pod for input: $!\n";
@filedata = <SPLITIN>;
close(SPLITIN) ||
my $dir = $pod;
$dir =~ s/\.pod//g;
push(@$splitdirs, "$poddir/$dir");
+ -d "$poddir/$dir" and remove_tree("$poddir/$dir", {safe=>1});
mkdir("$poddir/$dir", 0755) ||
- die "$0: could not create directory $poddir/$dir: $!\n"
- unless -d "$poddir/$dir";
+ die "$0: could not create directory $poddir/$dir: $!\n";
$poddata[0] =~ /^\s*=head[1-6]\s+(.*)/;
$section = "";
# create the new .pod file
print "\tcreating $poddir/$file\n" if $verbose;
- open(SPLITOUT, ">$poddir/$file") ||
+ open(SPLITOUT, '>', "$poddir/$file") ||
die "$0: error opening $poddir/$file for output: $!\n";
$poddata[$i] =~ s,L<([^<>]*)>,
defined $heads{anchorify($1)} ? "L<$dir/$1>" : "L<$1>"
#
sub installdir {
my($dir, $recurse, $podroot, $splitdirs, $ignore) = @_;
- my(@dirlist, @podlist, @pmlist, $doindex);
- @dirlist = (); # directories to recurse on
- @podlist = (); # .pod files to install
- @pmlist = (); # .pm files to install
+ my @dirlist; # directories to recurse on
+ my @podlist; # .pod files to install
+ my @pmlist; # .pm files to install
# should files in this directory get an index?
- $doindex = (grep($_ eq "$podroot/$dir", @$splitdirs) ? 0 : 1);
+ my $doindex = (grep($_ eq "$podroot/$dir", @$splitdirs) ? 0 : 1);
opendir(DIR, "$podroot/$dir")
|| die "$0: error opening directory $podroot/$dir: $!\n";
- # find the directories to recurse on
- @dirlist = map { if ($^O eq 'VMS') {/^(.*)\.dir$/i; "$dir/$1";} else {"$dir/$_";}}
- grep(-d "$podroot/$dir/$_" && !/^\.{1,2}/, readdir(DIR)) if $recurse;
- rewinddir(DIR);
-
- # find all the .pod files within the directory
- @podlist = map { /^(.*)\.pod$/; "$dir/$1" }
- grep(! -d "$podroot/$dir/$_" && /\.pod$/, readdir(DIR));
- rewinddir(DIR);
-
- # find all the .pm files within the directory
- @pmlist = map { /^(.*)\.pm$/; "$dir/$1" }
- grep(! -d "$podroot/$dir/$_" && /\.pm$/, readdir(DIR));
+ while(readdir DIR) {
+ no_upwards($_) or next;
+ my $is_dir = -d "$podroot/$dir/$_";
+ next if $is_dir and not $recurse;
+ my $target
+ = $is_dir ? \@dirlist
+ : s/\.pod$// ? \@podlist
+ : s/\.pm$// ? \@pmlist
+ : undef
+ ;
+ push @$target, "$dir/$_" if $target;
+ }
closedir(DIR);
+ if ($^O eq 'VMS') { s/\.dir$//i for @dirlist }
+
# recurse on all subdirectories we kept track of
foreach $dir (@dirlist) {
installdir($dir, $recurse, $podroot, $splitdirs, $ignore);
https://perl5.git.perl.org / perl5.git / blobdiff