-#!./perl -w
+#!./perl -Ilib -w
-# This file should really be a extracted from a .PL
-
-use lib 'lib'; # use source library if present
+# This file should really be extracted from a .PL file
+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;
-
-umask 022;
+use Pod::Html 'anchorify';
=head1 NAME
=cut
+my $usage;
+
$usage =<<END_OF_USAGE;
Usage: $0 --help --podpath=<name>:...:<name> --podroot=<name>
--htmldir=<name> --htmlroot=<name> --norecurse --recurse
END_OF_USAGE
+my (@libpods, @podpath, $podroot, $htmldir, $htmlroot, $recurse, @splithead,
+ @splititem, $splitpod, $verbose, $pod2html);
+
@libpods = ();
@podpath = ( "." ); # colon-separated list of directories containing .pod
# and .pm files to be converted.
usage("") unless @ARGV;
+# Overcome shell's p1,..,p8 limitation.
+# See vms/descrip_mms.template -> descrip.mms for invokation.
+if ( $^O eq 'VMS' ) { @ARGV = split(/\s+/,$ARGV[0]); }
+
+use vars qw( %Options );
+
# parse the command-line
-$result = GetOptions( qw(
+my $result = GetOptions( \%Options, qw(
help
podpath=s
podroot=s
# ignored in the conversion process. these are files that have been
# process by splititem or splithead and should not be converted as a
# result.
-@ignore = ();
-
+my @ignore = ();
+my @splitdirs;
# split pods. its important to do this before convert ANY pods because
# it may effect some of the links
# convert the pod pages found in @poddirs
#warn "converting files\n" if $verbose;
#warn "\@ignore\t= @ignore\n" if $verbose;
-foreach $dir (@podpath) {
+foreach my $dir (@podpath) {
installdir($dir, $recurse, $podroot, \@splitdirs, \@ignore);
}
# now go through and create master indices for each pod we split
-foreach $dir (@splititem) {
+foreach my $dir (@splititem) {
print "creating index $htmldir/$dir.html\n" if $verbose;
create_index("$htmldir/$dir.html", "$htmldir/$dir");
}
-foreach $dir (@splithead) {
+foreach my $dir (@splithead) {
+ (my $pod = $dir) =~ s,^.*/,,;
$dir .= ".pod" unless $dir =~ /(\.pod|\.pm)$/;
# let pod2html create the file
runpod2html($dir, 1);
# now go through and truncate after the index
$dir =~ /^(.*?)(\.pod|\.pm)?$/sm;
- $file = "$htmldir/$1";
+ my $file = "$htmldir/$1";
print "creating index $file.html\n" if $verbose;
# read in everything until what would have been the first =head
open(H, "<$file.html") ||
die "$0: error opening $file.html for input: $!\n";
$/ = "";
- @data = ();
+ my @data = ();
while (<H>) {
- last if /NAME=/;
- $_ =~ s{HREF="#(.*)">}{
- my $url = "$file/$1.html" ;
- $url = Pod::Html::relativize_url( $url, "$file.html" )
- if ( ! defined $opt_htmlroot || $opt_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
open(H, ">$file.html") ||
die "$0: error opening $file.html for output: $!\n";
- print H "@data\n";
+ print H "@data", "\n";
close(H);
}
sub parse_command_line {
- usage() if defined $opt_help;
- $opt_help = ""; # make -w shut up
+ usage() if defined $Options{help};
+ $Options{help} = ""; # make -w shut up
# list of directories
- @podpath = split(":", $opt_podpath) if defined $opt_podpath;
+ @podpath = split(":", $Options{podpath}) if defined $Options{podpath};
# lists of files
- @splithead = split(",", $opt_splithead) if defined $opt_splithead;
- @splititem = split(",", $opt_splititem) if defined $opt_splititem;
- @libpods = split(",", $opt_libpods) if defined $opt_libpods;
-
- $htmldir = $opt_htmldir if defined $opt_htmldir;
- $htmlroot = $opt_htmlroot if defined $opt_htmlroot;
- $podroot = $opt_podroot if defined $opt_podroot;
- $splitpod = $opt_splitpod if defined $opt_splitpod;
-
- $recurse = $opt_recurse if defined $opt_recurse;
- $verbose = $opt_verbose if defined $opt_verbose;
-}
+ @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};
+ $podroot = $Options{podroot} if defined $Options{podroot};
+ $splitpod = $Options{splitpod} if defined $Options{splitpod};
-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;
+ $recurse = $Options{recurse} if defined $Options{recurse};
+ $verbose = $Options{verbose} if defined $Options{verbose};
}
sub create_index {
my($html, $dir) = @_;
+ (my $pod = $dir) =~ s,^.*/,,;
my(@files, @filedata, @index, $file);
my($lcp1,$lcp2);
close(IN);
# pull out the NAME section
- ($name) = grep(/NAME=/, @filedata);
- ($lcp1,$lcp2) = ($name =~ m,/H1>\s(\S+)\s[\s-]*(.*?)\s*$,sm);
- if (defined $lcp1 and $lcp1 eq '<P>') { # Uninteresting. Try again.
- ($lcp1,$lcp2) = ($name =~ m,/H1>\s<P>\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,^<P>$,i) { # Uninteresting. Try again.
+ ($lcp1,$lcp2) = ($name =~ m,/H1>\s<P>\s*(\S+)\s[\s-]*(.*?)\s*$,smi);
}
- my $url= "$dir/$file" ;
- if ( ! defined $opt_htmlroot || $opt_htmlroot eq '' ) {
- $url = Pod::Html::relativize_url( "$dir/$file", $html ) ;
+ my $url= "$pod/$file" ;
+ if ( ! defined $Options{htmlroot} || $Options{htmlroot} eq '' ) {
+ $url = Pod::Html::relativize_url( "$pod/$file", $html ) ;
}
- print HTML qq(<A HREF="$url">);
- print HTML "<DT>$lcp1</A><DD>$lcp2\n" if defined $lcp1;
-# print HTML qq(<A HREF="$url">$lcp1</A><BR>\n") if defined $lcp1;
+ if (defined $lcp1) {
+ print HTML qq(<DT><A HREF="$url">);
+ print HTML "$lcp1</A></DT><DD>$lcp2</DD>\n";
+ }
next;
for (@index) {
s/<!-- INDEX BEGIN -->(\s*<!--)(.*)(-->\s*)<!-- INDEX END -->/$lcp2/s;
s,#,$dir/$file#,g;
- # print HTML "$_\n";
print HTML "$_\n<P><HR><P>\n";
}
}
foreach $pod (@splithead) {
# figure out the directory name and filename
$pod =~ s,^([^/]*)$,/$1,;
- $pod =~ m,(.*?)/(.*?)(\.pod)?$,;
+ $pod =~ m,(.*)/(.*?)(\.pod)?$,;
$dirname = $1;
$filename = "$2.pod";
print "splitting files by item.\n" if $verbose && $#splititem >= 0;
$pwd = getcwd();
- my $splitter = absolute_path($pwd, "$splitpod/splitpod");
- foreach $pod (@splititem) {
+ 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";
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";
}
# create list of =head[1-6] sections so that we can rewrite
# L<> links as necessary.
- %heads = ();
+ 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
# files in there
$pod =~ s,.*/(.*),$1,; # get the last part of the name
- $dir = $pod;
+ my $dir = $pod;
$dir =~ s/\.pod//g;
push(@$splitdirs, "$poddir/$dir");
mkdir("$poddir/$dir", 0755) ||
# 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;
|| die "$0: error opening directory $podroot/$dir: $!\n";
# find the directories to recurse on
- @dirlist = map { "$dir/$_" }
+ @dirlist = map { if ($^O eq 'VMS') {/^(.*)\.dir$/i; "$dir/$1";} else {"$dir/$_";}}
grep(-d "$podroot/$dir/$_" && !/^\.{1,2}/, readdir(DIR)) if $recurse;
rewinddir(DIR);
}
# install all the pods we found
- foreach $pod (@podlist) {
+ foreach my $pod (@podlist) {
# check if we should ignore it.
next if grep($_ eq "$podroot/$pod.pod", @$ignore);
# check if a .pm files exists too
- if (grep($_ eq "$pod.pm", @pmlist)) {
+ if (grep($_ eq $pod, @pmlist)) {
print "$0: Warning both `$podroot/$pod.pod' and "
. "`$podroot/$pod.pm' exist, using pod\n";
push(@ignore, "$pod.pm");
}
# install all the .pm files we found
- foreach $pm (@pmlist) {
+ foreach my $pm (@pmlist) {
# check if we should ignore it.
next if grep($_ eq "$pm.pm", @ignore);
# 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),
"--podroot=$podroot", "--netscape",
+ "--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 $?;
}
-
-sub htmlize { htmlify(0, @_) }
https://perl5.git.perl.org / perl5.git / blobdiff