-#!/usr/bin/perl -w
+#!./perl -w
+
+# This file should really be a extracted from a .PL
+
+use lib 'lib'; # use source library if present
use Config; # for config options in the makefile
use Getopt::Long; # for command-line parsing
Displays the usage.
+=item B<--podroot> POD search path base directory
+
+The base directory to search for all .pod and .pm files to be converted.
+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/.'.
-=item B<--podroot> POD search path base directory
+=item B<--recurse> recurse on subdirectories
-The base directory to search for all .pod and .pm files to be converted.
-Default is current directory.
+Whether or not to convert all .pm and .pod files found in subdirectories
+too. Default is to not recurse.
=item B<--htmldir> HTML destination directory
The base directory which all resulting HTML files will be visible at in
a URL. The default is `/'.
-=item B<--recurse> recurse on subdirectories
-
-Whether or not to convert all .pm and .pod files found in subdirectories
-too. Default is to not recurse.
-
=item B<--splithead> POD files to split on =head directive
-Colon-separated list of pod files to split by the =head directive. These
-files should have names specified relative to podroot.
+Comma-separated list of pod files to split by the =head directive. The
+.pod suffix is optional. These files should have names specified
+relative to podroot.
=item B<--splititem> POD files to split on =item directive
-Colon-separated list of all pod files to split by the =item directive.
-I<installhtml> does not do the actual split, rather it invokes I<splitpod>
-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<installhtml> does not do the actual
+split, rather it invokes I<splitpod> 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 LE<lt>E<gt> links
-Colon-separated list of "library" pod files. This is the same list that
+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<--verbose> verbose output
perl documentation:
./installhtml --podpath=lib:ext:pod:vms \
- --podroot=/usr/src/perl \
- --htmldir=/perl/nmanual \
- --htmlroot=/perl/nmanual \
- --splithead=pod/perlipc.pod \
- --splititem=pod/perlfunc \
- --libpods=perlfunc:perlguts:perlvar:perlrun:perlop \
- --recurse \
- --verbose
+ --podroot=/usr/src/perl \
+ --htmldir=/perl/nmanual \
+ --htmlroot=/perl/nmanual \
+ --splithead=pod/perlipc \
+ --splititem=pod/perlfunc \
+ --libpods=perlfunc,perlguts,perlvar,perlrun,perlop \
+ --recurse \
+ --verbose
=head1 AUTHOR
of a pod =head[1-6] directive.
--splititem - comma-separated list of .pod or .pm files to split using
splitpod.
- --splitpod - where the program splitpod can be found (\$podroot/pod by
- default).
+ --splitpod - directory where the program splitpod can be found
+ (\$podroot/pod by default).
--verbose - self-explanatory.
END_OF_USAGE
$pod2html = "pod/pod2html";
+usage("") unless @ARGV;
# parse the command-line
$result = GetOptions( qw(
# it may effect 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);
+split_on_item($podroot, \@splitdirs, \@ignore, @splititem);
# convert the pod pages found in @poddirs
@data = ();
while (<H>) {
last if /NAME=/;
- s,HREF="#(.*)">,HREF="$file/$1.html">,g;
+ $_ =~ 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;
push @data, $_;
}
close(H);
}
+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;
+}
+
+
sub create_index {
my($html, $dir) = @_;
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)));
+ @files = sort(grep(/\.html?$/, readdir(DIR)));
closedir(DIR);
open(HTML, ">$html") ||
# pull out the NAME section
($name) = grep(/NAME=/, @filedata);
- $name =~ m,/H1>\s(\S+)\s[\s-]*(.*?)\s*$,sm;
- print HTML qq(<A HREF="$dir/$file">);
- print HTML "<DT>$1</A><DD>$2\n" if defined $1;
-# print HTML qq(<A HREF="$dir/$file">$1</A><BR>\n") if defined $1;
+ ($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 $url= "$dir/$file" ;
+ if ( ! defined $opt_htmlroot || $opt_htmlroot eq '' ) {
+ $url = Pod::Html::relativize_url( "$dir/$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;
next;
@index = grep(/<!-- INDEX BEGIN -->.*<!-- INDEX END -->/s,
@filedata);
for (@index) {
- s/<!-- INDEX BEGIN -->(\s*<!--)(.*)(-->\s*)<!-- INDEX END -->/$2/s;
+ s/<!-- INDEX BEGIN -->(\s*<!--)(.*)(-->\s*)<!-- INDEX END -->/$lcp2/s;
s,#,$dir/$file#,g;
# print HTML "$_\n";
print HTML "$_\n<P><HR><P>\n";
print "splitting files by item.\n" if $verbose && $#splititem >= 0;
$pwd = getcwd();
+ my $splitter = absolute_path($pwd, "$splitpod/splitpod");
foreach $pod (@splititem) {
# figure out the directory to split into
$pod =~ s,^([^/]*)$,/$1,;
}
chdir("$podroot/$dirname") ||
die "$0: error changing to directory $podroot/$dirname: $!\n";
- system("./splitpod", "../$filename");
+ die "$splitter not found. Use '-splitpod dir' option.\n"
+ unless -f $splitter;
+ system("perl", $splitter, "../$filename") &&
+ warn "$0: error running '$splitter ../$filename'"
+ ." from $podroot/$dirname";
}
chdir($pwd);
}
#system("./pod2html",
Pod::Html'pod2html(
#Pod::Html'pod2html($pod2html,
+ "--htmldir=$htmldir",
"--htmlroot=$htmlroot",
"--podpath=".join(":", @podpath),
"--podroot=$podroot", "--netscape",
https://perl5.git.perl.org / perl5.git / blobdiff