X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/47ec63d06651617a148bb474657949bf1cf43062..bddfdacf0b41874346e0cd549746330ac8ece214:/installhtml diff --git a/installhtml b/installhtml old mode 100755 new mode 100644 index e7ed713..9f6ef7e --- a/installhtml +++ b/installhtml @@ -4,10 +4,11 @@ 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 @@ -15,17 +16,17 @@ installhtml - converts a collection of POD pages to HTML format. =head1 SYNOPSIS - installhtml [--help] [--podpath=:...:] [--podroot=] - [--htmldir=] [--htmlroot=] [--norecurse] [--recurse] - [--splithead=,...,] [--splititem=,...,] - [--libpods=,...,] [--ignore=,...,] - [--verbose] + installhtml [--help] [--podpath=:...:] [--podroot=] + [--htmldir=] [--htmlroot=] [--norecurse] [--recurse] + [--splithead=,...,] [--splititem=,...,] + [--ignore=,...,] [--verbose] =head1 DESCRIPTION I 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.) =head1 OPTIONS @@ -43,7 +44,7 @@ Default is current directory. =item B<--podpath> POD search path The list of directories to search for .pod and .pm files to be converted. -Default is `podroot/.'. +Default is 'podroot/.'. =item B<--recurse> recurse on subdirectories @@ -58,7 +59,7 @@ be a path relative to the filesystem, not the resulting URL. =item B<--htmlroot> URL base directory The base directory which all resulting HTML files will be visible at in -a URL. The default is `/'. +a URL. The default is '/'. =item B<--splithead> POD files to split on =head directive @@ -68,19 +69,15 @@ relative to podroot. =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 does not do the actual -split, rather it invokes I 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 does not do the actual split, rather +it invokes I, 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 -The directory containing the splitpod program. The default is `podroot/pod'. - -=item B<--libpods> library PODs for LEE links - -Comma-separated list of "library" pod files. This is the same list that -will be passed to pod2html when any pod is converted. +The directory containing the splitpod program. The default is 'podroot/pod'. =item B<--ignore> files to be ignored @@ -104,7 +101,6 @@ perl documentation: --htmlroot=/perl/nmanual \ --splithead=pod/perlipc \ --splititem=pod/perlfunc \ - --libpods=perlfunc,perlguts,perlvar,perlrun,perlop \ --recurse \ --verbose @@ -112,8 +108,6 @@ perl documentation: Chris Hall Ehallc@cs.colorado.eduE -=head1 TODO - =cut my $usage; @@ -122,7 +116,7 @@ $usage =<:...: --podroot= --htmldir= --htmlroot= --norecurse --recurse --splithead=,..., --splititem=,..., - --libpods=,..., --ignore=,..., --verbose + --ignore=,..., --verbose --help - this message --podpath - colon-separated list of directories containing .pod and @@ -133,9 +127,6 @@ Usage: $0 --help --podpath=:...: --podroot= to the filesystem (\$podroot/html by default). --htmlroot - http-server base directory from which all relative paths in podpath stem (default is /). - --libpods - comma-separated list of files to search for =item pod - directives in as targets of C<> and implicit links (empty - by default). --norecurse - don't recurse on those subdirectories listed in podpath. (default behavior). --recurse - recurse on those subdirectories listed in podpath @@ -151,10 +142,9 @@ Usage: $0 --help --podpath=:...: --podroot= END_OF_USAGE -my (@libpods, @podpath, $podroot, $htmldir, $htmlroot, $recurse, @splithead, +my (@podpath, $podroot, $htmldir, $htmlroot, $recurse, @splithead, @splititem, $splitpod, $verbose, $pod2html, @ignore); -@libpods = (); @podpath = ( "." ); # colon-separated list of directories containing .pod # and .pm files to be converted. $podroot = "."; # assume the pods we want are here @@ -172,10 +162,10 @@ $pod2html = "pod/pod2html"; usage("") unless @ARGV; # Overcome shell's p1,..,p8 limitation. -# See vms/descrip_mms.template -> descrip.mms for invokation. +# 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( @@ -184,7 +174,6 @@ my $result = GetOptions( \%Options, qw( podroot=s htmldir=s htmlroot=s - libpods=s ignore=s recurse! splithead=s @@ -247,15 +236,15 @@ foreach my $dir (@splithead) { # 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 () { - last if /name="name"/i; + last if m!

NAME

!; $_ =~ 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; @@ -264,12 +253,14 @@ foreach my $dir (@splithead) { 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, "\n\n\n\n\n"; close(H); } +remove_tree(@splitdirs, {safe=>1}); + ############################################################################## @@ -289,7 +280,6 @@ sub parse_command_line { # lists of files @splithead = split(",", $Options{splithead}) if defined $Options{splithead}; @splititem = split(",", $Options{splititem}) if defined $Options{splititem}; - @libpods = split(",", $Options{libpods}) if defined $Options{libpods}; $htmldir = $Options{htmldir} if defined $Options{htmldir}; $htmlroot = $Options{htmlroot} if defined $Options{htmlroot}; @@ -306,56 +296,41 @@ sub parse_command_line { 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 "
\n"; - foreach $file (@files) { - $/ = ""; + foreach my $file (@files) { - open(IN, "<$dir/$file") || - die "$0: error opening $dir/$file for input: $!\n"; - @filedata = ; - 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,^

$,i) { # Uninteresting. Try again. - ($lcp1,$lcp2) = ($name =~ m,/H1>\s

\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#

NAME

\s*

\s*(\S+)\s+-\s+(\S.*?\S)

#); + defined $lcp1 or die "$0: can't find NAME section in $dir/$file\n"; - if (defined $lcp1) { - print HTML qq(
); - print HTML "$lcp1
$lcp2
\n"; + my $url= "$dir/$file" ; + if ( ! defined $Options{htmlroot} || $Options{htmlroot} eq '' ) { + $url = relativize_url( $url, $html ) ; } - next; - - @index = grep(/.*/s, - @filedata); - for (@index) { - s/(\s*\s*)/$lcp2/s; - s,#,$dir/$file#,g; - print HTML "$_\n

\n"; - } + print HTML qq(

); + print HTML "$lcp1
$lcp2
\n"; } print HTML "
\n"; @@ -392,8 +367,8 @@ sub split_on_item { 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,; @@ -406,10 +381,9 @@ sub split_on_item { # 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" @@ -436,7 +410,7 @@ sub splitpod { # read the file in paragraphs $/ = ""; - open(SPLITIN, "<$pod") || + open(SPLITIN, '<', $pod) || die "$0: error opening $pod for input: $!\n"; @filedata = ; close(SPLITIN) || @@ -465,9 +439,9 @@ sub splitpod { 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 = ""; @@ -492,7 +466,7 @@ sub splitpod { # 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>" @@ -515,34 +489,34 @@ sub splitpod { # 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); @@ -556,8 +530,8 @@ sub installdir { # check if a .pm files exists too if (grep($_ eq $pod, @pmlist)) { - print "$0: Warning both `$podroot/$pod.pod' and " - . "`$podroot/$pod.pm' exist, using pod\n"; + print "$0: Warning both '$podroot/$pod.pod' and " + . "'$podroot/$pod.pm' exist, using pod\n"; push(@ignore, "$pod.pm"); } runpod2html("$pod.pod", $doindex); @@ -602,11 +576,10 @@ sub runpod2html { "--htmldir=$htmldir", "--htmlroot=$htmlroot", "--podpath=".join(":", @podpath), - "--podroot=$podroot", "--netscape", + "--podroot=$podroot", "--header", ($doindex ? "--index" : "--noindex"), "--" . ($recurse ? "" : "no") . "recurse", - ($#libpods >= 0) ? "--libpods=" . join(":", @libpods) : "", "--infile=$podroot/$pod", "--outfile=$htmldir/$html"); die "$0: error running $pod2html: $!\n" if $?; }