X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/65b0382206bb97a338ab8eb5189cdd164232c031..e1b52aff077d9baa4dce2eda89fc1d037914dc78:/installhtml diff --git a/installhtml b/installhtml old mode 100755 new mode 100644 index fe6628d..a495281 --- a/installhtml +++ b/installhtml @@ -4,9 +4,10 @@ use strict; use Config; # for config options in the makefile +use File::Spec; use Getopt::Long; # for command-line parsing use Cwd; -use Pod::Html; +use Pod::Html 'anchorify'; =head1 NAME @@ -17,7 +18,8 @@ installhtml - converts a collection of POD pages to HTML format. installhtml [--help] [--podpath=:...:] [--podroot=] [--htmldir=] [--htmlroot=] [--norecurse] [--recurse] [--splithead=,...,] [--splititem=,...,] - [--libpods=,...,] [--verbose] + [--libpods=,...,] [--ignore=,...,] + [--verbose] =head1 DESCRIPTION @@ -41,7 +43,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 @@ -56,7 +58,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 @@ -73,13 +75,18 @@ split, rather it invokes I to do the dirty work. As with =item B<--splitpod> Directory containing the splitpod program -The directory containing the splitpod program. The default is `podroot/pod'. +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. +=item B<--ignore> files to be ignored + +Comma-separated of files that shouldn't be installed, given relative +to podroot. + =item B<--verbose> verbose output Self-explanatory. @@ -105,8 +112,6 @@ perl documentation: Chris Hall Ehallc@cs.colorado.eduE -=head1 TODO - =cut my $usage; @@ -115,7 +120,7 @@ $usage =<:...: --podroot= --htmldir= --htmlroot= --norecurse --recurse --splithead=,..., --splititem=,..., - --libpods=,..., --verbose + --libpods=,..., --ignore=,..., --verbose --help - this message --podpath - colon-separated list of directories containing .pod and @@ -123,7 +128,7 @@ Usage: $0 --help --podpath=:...: --podroot= --podroot - filesystem base directory from which all relative paths in podpath stem (default is .). --htmldir - directory to store resulting html files in relative - to the filesystem (\$podroot/html by default). + 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 @@ -139,12 +144,13 @@ Usage: $0 --help --podpath=:...: --podroot= splitpod. --splitpod - directory where the program splitpod can be found (\$podroot/pod by default). + --ignore - comma-separated list of files that shouldn't be installed. --verbose - self-explanatory. END_OF_USAGE my (@libpods, @podpath, $podroot, $htmldir, $htmlroot, $recurse, @splithead, - @splititem, $splitpod, $verbose, $pod2html); + @splititem, $splitpod, $verbose, $pod2html, @ignore); @libpods = (); @podpath = ( "." ); # colon-separated list of directories containing .pod @@ -157,14 +163,14 @@ $recurse = 0; # default behavior @splititem = (); # don't split any files by default $splitpod = ""; # nothing for now. -$verbose = 0; # whether or not to print debugging info +$verbose = 0; # whether or not to print debugging info $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 ); @@ -177,6 +183,7 @@ my $result = GetOptions( \%Options, qw( htmldir=s htmlroot=s libpods=s + ignore=s recurse! splithead=s splititem=s @@ -202,11 +209,10 @@ $splitpod = "$podroot/pod" unless $splitpod; # ignored in the conversion process. these are files that have been # process by splititem or splithead and should not be converted as a # result. -my @ignore = (); my @splitdirs; -# split pods. its important to do this before convert ANY pods because -# it may effect some of the links +# split pods. It's important to do this before convert ANY pods because +# it may affect some of the links @splitdirs = (); # files in these directories won't get an index split_on_head($podroot, $htmldir, \@splitdirs, \@ignore, @splithead); split_on_item($podroot, \@splitdirs, \@ignore, @splititem); @@ -227,6 +233,7 @@ foreach my $dir (@splititem) { } foreach my $dir (@splithead) { + (my $pod = $dir) =~ s,^.*/,,; $dir .= ".pod" unless $dir =~ /(\.pod|\.pm)$/; # let pod2html create the file runpod2html($dir, 1); @@ -243,18 +250,18 @@ foreach my $dir (@splithead) { $/ = ""; my @data = (); while () { - last if /NAME=/; - $_ =~ s{HREF="#(.*)">}{ - my $url = "$file/$1.html" ; - $url = Pod::Html::relativize_url( $url, "$file.html" ) - if ( ! defined $Options{htmlroot} || $Options{htmlroot} eq '' ); - "HREF=\"$url\">" ; - }eg; + last if /name="name"/i; + $_ =~ s{href="#(.*)">}{ + my $url = "$pod/$1.html" ; + $url = Pod::Html::relativize_url( $url, "$file.html" ) + if ( ! defined $Options{htmlroot} || $Options{htmlroot} eq '' ); + "href=\"$url\">" ; + }egi; push @data, $_; - } + } close(H); - # now rewrite the file + # now rewrite the file open(H, ">$file.html") || die "$0: error opening $file.html for output: $!\n"; print H "@data", "\n"; @@ -289,20 +296,14 @@ sub parse_command_line { $recurse = $Options{recurse} if defined $Options{recurse}; $verbose = $Options{verbose} if defined $Options{verbose}; -} - -sub absolute_path { - my($cwd, $path) = @_; - return "$cwd/$path" unless $path =~ m:/:; - # add cwd if path is not already an absolute path - $path = "$cwd/$path" if (substr($path,0,1) ne '/'); - return $path; + @ignore = map "$podroot/$_", split(",", $Options{ignore}) if defined $Options{ignore}; } sub create_index { my($html, $dir) = @_; + (my $pod = $dir) =~ s,^.*/,,; my(@files, @filedata, @index, $file); my($lcp1,$lcp2); @@ -328,20 +329,21 @@ sub create_index { close(IN); # pull out the NAME section - my $name; - ($name) = grep(/NAME=/, @filedata); - ($lcp1,$lcp2) = ($name =~ m,/H1>\s(\S+)\s[\s-]*(.*?)\s*$,sm); - if (defined $lcp1 and $lcp1 eq '

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

\s(\S+)\s[\s-]*(.*?)\s*$,sm); + 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= "$dir/$file" ; + my $url= "$pod/$file" ; if ( ! defined $Options{htmlroot} || $Options{htmlroot} eq '' ) { - $url = Pod::Html::relativize_url( "$dir/$file", $html ) ; + $url = Pod::Html::relativize_url( "$pod/$file", $html ) ; } - print HTML qq(); - print HTML "

$lcp1
$lcp2\n" if defined $lcp1; -# print HTML qq($lcp1
\n") if defined $lcp1; + if (defined $lcp1) { + print HTML qq(
); + print HTML "$lcp1
$lcp2
\n"; + } next; @@ -350,7 +352,6 @@ sub create_index { for (@index) { s/(\s*\s*)/$lcp2/s; s,#,$dir/$file#,g; - # print HTML "$_\n"; print HTML "$_\n

\n"; } } @@ -369,7 +370,7 @@ sub split_on_head { foreach $pod (@splithead) { # figure out the directory name and filename $pod =~ s,^([^/]*)$,/$1,; - $pod =~ m,(.*?)/(.*?)(\.pod)?$,; + $pod =~ m,(.*)/(.*?)(\.pod)?$,; $dirname = $1; $filename = "$2.pod"; @@ -389,11 +390,12 @@ sub split_on_item { print "splitting files by item.\n" if $verbose && $#splititem >= 0; $pwd = getcwd(); - my $splitter = absolute_path($pwd, "$splitpod/splitpod"); + my $splitter = File::Spec->rel2abs("$splitpod/splitpod", $pwd); + my $perl = File::Spec->rel2abs($^X, $pwd); foreach my $pod (@splititem) { # figure out the directory to split into $pod =~ s,^([^/]*)$,/$1,; - $pod =~ m,(.*?)/(.*?)(\.pod)?$,; + $pod =~ m,(.*)/(.*?)(\.pod)?$,; $dirname = "$1/$2"; $filename = "$2.pod"; @@ -410,7 +412,7 @@ sub split_on_item { die "$0: error changing to directory $podroot/$dirname: $!\n"; die "$splitter not found. Use '-splitpod dir' option.\n" unless -f $splitter; - system("perl", $splitter, "../$filename") && + system($perl, $splitter, "../$filename") && warn "$0: error running '$splitter ../$filename'" ." from $podroot/$dirname"; } @@ -452,7 +454,7 @@ sub splitpod { # L<> links as necessary. my %heads = (); foreach $i (0..$#poddata) { - $heads{htmlize($1)} = 1 if $poddata[$i] =~ /=head[1-6]\s+(.*)/; + $heads{anchorify($1)} = 1 if $poddata[$i] =~ /=head[1-6]\s+(.*)/; } # create a directory of a similar name and store all the @@ -484,15 +486,15 @@ sub splitpod { # determine an appropriate filename (this must correspond with # what pod2html will try and guess) # $poddata[$i] =~ /^\s*=head[1-6]\s+(.*)/; - $file = "$dir/" . htmlize($section) . ".pod"; + $file = "$dir/" . anchorify($section) . ".pod"; # create the new .pod file print "\tcreating $poddir/$file\n" if $verbose; open(SPLITOUT, ">$poddir/$file") || die "$0: error opening $poddir/$file for output: $!\n"; $poddata[$i] =~ s,L<([^<>]*)>, - defined $heads{htmlize($1)} ? "L<$dir/$1>" : "L<$1>" - ,ge; + defined $heads{anchorify($1)} ? "L<$dir/$1>" : "L<$1>" + ,ge; print SPLITOUT $poddata[$i]."\n\n"; print SPLITOUT "=over 4\n\n"; print SPLITOUT "=item *\n\nBack to L<$dir/\"$prevsec\">\n\n" if $prevsec; @@ -547,12 +549,13 @@ sub installdir { # install all the pods we found foreach my $pod (@podlist) { # check if we should ignore it. - next if grep($_ eq "$podroot/$pod.pod", @$ignore); + next if $pod =~ m(/t/); # comes from a test file + next if grep($_ eq "$pod.pod", @$ignore); # check if a .pm files exists too - if (grep($_ eq "$pod.pm", @pmlist)) { - print "$0: Warning both `$podroot/$pod.pod' and " - . "`$podroot/$pod.pm' exist, using pod\n"; + if (grep($_ eq $pod, @pmlist)) { + print "$0: Warning both '$podroot/$pod.pod' and " + . "'$podroot/$pod.pm' exist, using pod\n"; push(@ignore, "$pod.pm"); } runpod2html("$pod.pod", $doindex); @@ -561,6 +564,7 @@ sub installdir { # install all the .pm files we found foreach my $pm (@pmlist) { # check if we should ignore it. + next if $pm =~ m(/t/); # comes from a test file next if grep($_ eq "$pm.pm", @ignore); runpod2html("$pm.pm", $doindex); @@ -592,9 +596,7 @@ sub runpod2html { # invoke pod2html print "$podroot/$pod => $htmldir/$html\n" if $verbose; -#system("./pod2html", - Pod::Html'pod2html( - #Pod::Html'pod2html($pod2html, + Pod::Html::pod2html( "--htmldir=$htmldir", "--htmlroot=$htmlroot", "--podpath=".join(":", @podpath), @@ -606,5 +608,3 @@ sub runpod2html { "--infile=$podroot/$pod", "--outfile=$htmldir/$html"); die "$0: error running $pod2html: $!\n" if $?; } - -sub htmlize { htmlify(0, @_) }