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
installhtml [--help] [--podpath=<name>:...:<name>] [--podroot=<name>]
[--htmldir=<name>] [--htmlroot=<name>] [--norecurse] [--recurse]
[--splithead=<name>,...,<name>] [--splititem=<name>,...,<name>]
- [--libpods=<name>,...,<name>] [--verbose]
+ [--libpods=<name>,...,<name>] [--ignore=<name>,...,<name>]
+ [--verbose]
=head1 DESCRIPTION
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.
Usage: $0 --help --podpath=<name>:...:<name> --podroot=<name>
--htmldir=<name> --htmlroot=<name> --norecurse --recurse
--splithead=<name>,...,<name> --splititem=<name>,...,<name>
- --libpods=<name>,...,<name> --verbose
+ --libpods=<name>,...,<name> --ignore=<name>,...,<name> --verbose
--help - this message
--podpath - colon-separated list of directories containing .pod and
--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
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
@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";
htmldir=s
htmlroot=s
libpods=s
+ ignore=s
recurse!
splithead=s
splititem=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.
-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);
}
foreach my $dir (@splithead) {
+ (my $pod = $dir) =~ s,^.*/,,;
$dir .= ".pod" unless $dir =~ /(\.pod|\.pm)$/;
# let pod2html create the file
runpod2html($dir, 1);
$/ = "";
my @data = ();
while (<H>) {
- 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";
$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};
}
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,;
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";
}
# 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
# 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;
# 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, @pmlist)) {
# 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);
"--infile=$podroot/$pod", "--outfile=$htmldir/$html");
die "$0: error running $pod2html: $!\n" if $?;
}
-
-sub htmlize { htmlify(0, @_) }