develooper Front page | perl.perl5.porters | Postings from April 2003

Re: [PATCH 5.8.0 UTIL] Fix installhtml for splitting and PM/POD conflicts

Thread Previous
From:
Rafael Garcia-Suarez
Date:
April 2, 2003 11:59
Subject:
Re: [PATCH 5.8.0 UTIL] Fix installhtml for splitting and PM/POD conflicts
Message ID:
20030402220205.69b0d2c8.rgarciasuarez@free.fr
Steve Hay wrote:
> I'm happy with this.  Since the anchor and filename are never actually 
> seen by the "users", it doesn't really matter how much they are altered 
> so long as they work.  This seems like a clean, simple way to guarantee 
> that.

And thus I applied the following :
(thanks a lot for your patches, I think installhtml needed at least that
kind of cleanup)

Change 19136 by rgs@rgs-home on 2003/04/02 18:46:31

	Fixes for "installhtml --splithead", based on :
	Subject: Re: [PATCH 5.8.0 UTIL] Fix installhtml for splitting and PM/POD conflicts
	From: Steve Hay <steve.hay@uk.radan.com>
	Date: Wed, 02 Apr 2003 11:33:41 +0100
	Message-ID: <3E8ABC85.5060807@uk.radan.com>
	
	This also includes a small patch to Pod::Html : when generating
	anchor names, play on the safe side and turn every non-alphanumeric
	character into an '_'. Moreover, Pod::Html::anchorify() is now 
	optionally exported.

Affected files ...

... //depot/perl/installhtml#21 edit
... //depot/perl/lib/Pod/Html.pm#63 edit

Differences ...

==== //depot/perl/installhtml#21 (xtext) ====

@@ -6,7 +6,7 @@
 use Config;		# for config options in the makefile
 use Getopt::Long;	# for command-line parsing
 use Cwd;
-use Pod::Html;
+use Pod::Html 'anchorify';
 
 =head1 NAME
 
@@ -227,6 +227,7 @@
 }
 
 foreach my $dir (@splithead) {
+    (my $pod = $dir) =~ s,^.*/,,;
     $dir .= ".pod" unless $dir =~ /(\.pod|\.pm)$/;
     # let pod2html create the file
     runpod2html($dir, 1);
@@ -243,15 +244,15 @@
     $/ = "";
     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 
@@ -453,7 +454,7 @@
     #  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
@@ -485,15 +486,15 @@
 	# 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;
@@ -605,5 +606,3 @@
 	"--infile=$podroot/$pod", "--outfile=$htmldir/$html");
     die "$0: error running $pod2html: $!\n" if $?;
 }
-
-sub htmlize { htmlify(0, @_) }

==== //depot/perl/lib/Pod/Html.pm#63 (text) ====

@@ -2,10 +2,11 @@
 use strict;
 require Exporter;
 
-use vars qw($VERSION @ISA @EXPORT);
-$VERSION = 1.04;
+use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
+$VERSION = 1.05;
 @ISA = qw(Exporter);
 @EXPORT = qw(pod2html htmlify);
+@EXPORT_OK = qw(anchorify);
 
 use Carp;
 use Config;
@@ -1965,12 +1966,12 @@
 }
 
 #
-# similar to htmlify, but turns spaces into underscores
+# similar to htmlify, but turns non-alphanumerics into underscores
 #
 sub anchorify {
     my ($anchor) = @_;
     $anchor = htmlify($anchor);
-    $anchor =~ s/\s/_/g; # fixup spaces left by htmlify
+    $anchor =~ s/\W/_/g;
     return $anchor;
 }
 
-- 
Usefulness is not *NIX

Thread Previous


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About