X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/7e7b3f792cd41d2ef1db134775922f4fba336b40..2cd613ec5fcf3b5c85fd2752b5871f18b4d33773:/installhtml diff --git a/installhtml b/installhtml index 06342a8..9f6ef7e 100644 --- a/installhtml +++ b/installhtml @@ -4,10 +4,11 @@ use strict; use Config; # for config options in the makefile +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 @@ -23,8 +24,9 @@ installhtml - converts a collection of POD pages to HTML format. =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 @@ -67,10 +69,11 @@ 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 @@ -162,7 +165,7 @@ usage("") unless @ARGV; # 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( @@ -233,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; @@ -250,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}); + ############################################################################## @@ -298,7 +303,7 @@ sub create_index { 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 @@ -307,7 +312,7 @@ sub create_index { foreach my $file (@files) { my $filedata = do { - open(my $in, "<$dir/$file") || + open(my $in, '<', "$dir/$file") || die "$0: error opening $dir/$file for input: $!\n"; local $/ = undef; <$in>; @@ -319,9 +324,9 @@ sub create_index { m#

NAME

\s*

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

#); defined $lcp1 or die "$0: can't find NAME section in $dir/$file\n"; - my $url= "$pod/$file" ; + my $url= "$dir/$file" ; if ( ! defined $Options{htmlroot} || $Options{htmlroot} eq '' ) { - $url = Pod::Html::relativize_url( "$pod/$file", $html ) ; + $url = relativize_url( $url, $html ) ; } print HTML qq(
); @@ -376,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" @@ -406,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) || @@ -435,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 = ""; @@ -462,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>"