WebSVN – DevTools – Diff – /core_devl/trunk/TOOLS/LIB/Pod/Html.pm

 package Pod::Html;
 use strict;
 require Exporter;
 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
-$VERSION = "1.0801";
+$VERSION = 1.0901;
 @ISA = qw(Exporter);
 @EXPORT = qw(pod2html htmlify);
 @EXPORT_OK = qw(anchorify);
 use Carp;
 my $HiddenDirs;
 my $Verbose;
 my $Doindex;
 my $Backlink;
-my($Listlevel, @Listend);
+my($Listlevel, @Listtype);
-my $After_Lpar;
+my $ListNewTerm;
 use vars qw($Ignore);  # need to localize it later.
 my(%Items_Named, @Items_Seen);
 my($Title, $Header);
     $Quiet = 0;                 # not quiet by default
     $Verbose = 0;               # not verbose by default
     $Doindex = 1;               # non-zero if we should generate an index
     $Backlink = '';             # text for "back to top" links
     $Listlevel = 0;             # current list depth
-    @Listend = ();              # the text to use to end the list.
+    @Listtype = ();     # list types for open lists
-    $After_Lpar = 0;            # set to true after a par in an =item
+    $ListNewTerm = 0;       # indicates new term in definition list; used
+                    # to correctly open/close <dd> tags
     $Ignore = 1;                # whether or not to format text.  we don't
                                 #   format text until we hit our first pod
                                 #   directive.
     @Items_Seen = ();           # for multiples of the same item in perlfunc
 END_OF_INDEX
     # now convert this file
     my $after_item;             # set to true after an =item
-    my $need_dd = 0;
     warn "Converting input file $Podfile\n" if $Verbose;
     foreach my $i (0..$#poddata){
         $_ = $poddata[$i];
         $Paragraph = $i+1;
         if (/^(=.*)/s) {        # is it a pod directive?
             $Ignore = 0;
             $after_item = 0;
-            $need_dd = 0;
             $_ = $1;
             if (/^=begin\s+(\S+)\s*(.*)/si) {   # =begin
                 process_begin($1, $2);
             } elsif (/^=end\s+(\S+)\s*(.*)/si) {# =end
                 process_end($1, $2);
                 next if @Begin_Stack && $Begin_Stack[-1] ne 'html';
                 if (/^=(head[1-6])\s+(.*\S)/s) {        # =head[1-6] heading
                     process_head( $1, $2, $Doindex && $index );
                 } elsif (/^=item\s*(.*\S)?/sm) {        # =item text
-                    $need_dd = process_item( $1 );
+            process_item( $1 );
                     $after_item = 1;
                 } elsif (/^=over\s*(.*)/) {             # =over N
                     process_over();
                 } elsif (/^=back/) {                    # =back
-                    process_back($need_dd);
+            process_back();
                 } elsif (/^=for\s+(\S+)\s*(.*)/si) {    # =for
                     process_for($1,$2);
                 } else {
                     /^=(\S*)\s*/;
                     warn "$0: $Podfile: unknown pod directive '$1' in "
+        }
         else {
             next if $Ignore;
             next if @Begin_Stack && $Begin_Stack[-1] ne 'html';
             print HTML and next if @Begin_Stack && $Begin_Stack[-1] eq 'html';
-            print HTML "<dd>\n" if $need_dd;
             my $text = $_;
+        # Open tag for definition list as we have something to put in it
+        if( $ListNewTerm ){
+        print HTML "<dd>\n";
+        $ListNewTerm = 0;
+        }
-            if( $text =~ /\A\s+/ ){
+        if( $text =~ /\A\s+/ ){
-                process_pre( \$text );
+        process_pre( \$text );
-                print HTML "<pre>\n$text</pre>\n";
+            print HTML "<pre>\n$text</pre>\n";
             } else {
                 process_text( \$text );
                 # experimental: check for a paragraph where all lines
+                        }
+                    }
+                }
                 ## end of experimental
-                if( $after_item ){
-                    $After_Lpar = 1;
-                }
         if ( $set_p_class )
+        {
                 print HTML "<p class=\"$set_p_class\">$text</p>\n";
             $set_p_class = 0;
+        }
         else
+        {
                     print HTML "<p>$text</p>\n";
+        }
+            }
-            print HTML "</dd>\n" if $need_dd;
             $after_item = 0;
+        }
+    }
     # finish off any pending directives
     foreach $i (0..$#poddata) {
         my $txt = depod( $poddata[$i] );
         $txt =~ s~^\n~~;
         # figure out what kind of item it is.
         # Build string for referencing this item.
-        if ( $txt =~ /\A=item\s+\*\s*(.*)\Z/s ) { # bullet
+    if ( $txt =~ /\A=item\s+\*\s*(.*)\Z/s ) { # bulleted list
             next unless $1;
             $item = $1;
         } elsif( $txt =~ /\A=item\s+(?>\d+\.?)\s*(.*)\Z/s ) { # numbered list
             $item = $1;
-        } elsif( $txt =~ /\A=item\s+(.*)\Z/s ) { # plain item
+    } elsif( $txt =~ /\A=item\s+(.*)\Z/s ) { # definition list
             $item = $1;
         } elsif( $txt =~ /\A=head[234]\s+(.*)\Z/s ) { # plain item
             $item = $1;
         } else {
             next;
     # figure out the level of the =head
     $tag =~ /head([1-6])/;
     my $level = $1;
-    if( $Listlevel ){
-        warn "$0: $Podfile: unterminated list at =head in paragraph $Paragraph.  ignoring.\n" unless $Quiet;
-        while( $Listlevel ){
-            process_back();
+        finish_list();
-        }
-    }
     print HTML "<p>\n";
     if( $level == 1 && ! $Top ){
       print HTML "<a href=\"#__index__\"><small>$Backlink</small></a>\n"
         if $hasindex and $Backlink;
+    }
     print HTML "</strong>\n";
     undef( $EmittedItem );
+}
-sub emit_li {
+sub new_listitem {
     my( $tag ) = @_;
+    # Open tag for definition list as we have something to put in it
+    if( ($tag ne 'dl') && ($ListNewTerm) ){
+    print HTML "<dd>\n";
+    $ListNewTerm = 0;
+    }
     if( $Items_Seen[$Listlevel]++ == 0 ){
+    # start of new list
-        push( @Listend, "</$tag>" );
+    push( @Listtype, "$tag" );
+    print HTML "<$tag>\n";
+    } else {
+    # if this is not the first item, close the previous one
+    if ( $tag eq 'dl' ){
+        print HTML "</dd>\n" unless $ListNewTerm;
+    } else {
-        print HTML "<$tag>\n";
+        print HTML "</li>\n";
+    }
+    }
-    my $emitted = $tag eq 'dl' ? 'dt' : 'li';
+    my $opentag = $tag eq 'dl' ? 'dt' : 'li';
-    print HTML "<$emitted>";
+    print HTML "<$opentag>";
-    return $emitted;
+}
+#
 # process_item - convert a pod item tag and convert it to HTML format.
+#
 sub process_item {
     my( $otext ) = @_;
-    my $need_dd = 0; # set to 1 if we need a <dd></dd> after an item
     # lots of documents start a list without doing an =over.  this is
     # bad!  but, the proper thing to do seems to be to just assume
     # they did do an =over.  so warn them once and then continue.
     if( $Listlevel == 0 ){
         warn "$0: $Podfile: unexpected =item directive in paragraph $Paragraph.  ignoring.\n" unless $Quiet;
         process_over();
+    }
-    # formatting: insert a paragraph if preceding item has >1 paragraph
-    if( $After_Lpar ){
-        print HTML $need_dd ? "</dd>\n" : "</li>\n" if $After_Lpar;
-        $After_Lpar = 0;
-    }
     # remove formatting instructions from the text
     my $text = depod( $otext );
-    my $emitted; # the tag actually emitted, used for closing
     # all the list variants:
     if( $text =~ /\A\*/ ){ # bullet
-        $emitted = emit_li( 'ul' );
+        new_listitem( 'ul' );
         if ($text =~ /\A\*\s+(\S.*)\Z/s ) { # with additional text
             my $tag = $1;
             $otext =~ s/\A\*\s+//;
             emit_item_tag( $otext, $tag, 1 );
+            print HTML "\n";
+        }
     } elsif( $text =~ /\A\d+/ ){ # numbered list
-        $emitted = emit_li( 'ol' );
+        new_listitem( 'ol' );
         if ($text =~ /\A(?>\d+\.?)\s*(\S.*)\Z/s ) { # with additional text
             my $tag = $1;
             $otext =~ s/\A\d+\.?\s*//;
             emit_item_tag( $otext, $tag, 1 );
+            print HTML "\n";
+        }
-    } else {                    # definition list
+    } else {            # definition list
+        # new_listitem takes care of opening the <dt> tag
-        $emitted = emit_li( 'dl' );
+        new_listitem( 'dl' );
         if ($text =~ /\A(.+)\Z/s ){ # should have text
             emit_item_tag( $otext, $text, 1 );
+        # write the definition term and close <dt> tag
+        print HTML "</dt>\n";
+        }
+        # trigger opening a <dd> tag for the actual definition; will not
+        # happen if next paragraph is also a definition term (=item)
-        $need_dd = 1;
+        $ListNewTerm = 1;
+    }
     print HTML "\n";
-    return $need_dd;
+}
+#
 # process_over - process a pod over tag and start a corresponding HTML list.
+#
 sub process_over {
     # start a new list
     $Listlevel++;
     push( @Items_Seen, 0 );
-    $After_Lpar = 0;
+}
+#
 # process_back - process a pod back tag and convert it to HTML format.
+#
 sub process_back {
-    my $need_dd = shift;
     if( $Listlevel == 0 ){
-        warn "$0: $Podfile: unexpected =back directive in paragraph $Paragraph.  ignoring.\n" unless $Quiet;
+    warn "$0: $Podfile: unexpected =back directive in paragraph $Paragraph.  ignoring.\n" unless $Quiet;
-        return;
+    return;
+    }
-    # close off the list.  note, I check to see if $Listend[$Listlevel] is
+    # close off the list.  note, I check to see if $Listtype[$Listlevel] is
     # defined because an =item directive may have never appeared and thus
-    # $Listend[$Listlevel] may have never been initialized.
+    # $Listtype[$Listlevel] may have never been initialized.
     $Listlevel--;
-    if( defined $Listend[$Listlevel] ){
+    if( defined $Listtype[$Listlevel] ){
-        print HTML $need_dd ? "</dd>\n" : "</li>\n" if $After_Lpar;
+        if ( $Listtype[$Listlevel] eq 'dl' ){
-        print HTML $Listend[$Listlevel];
+            print HTML "</dd>\n" unless $ListNewTerm;
+        } else {
-        print HTML "\n";
+            print HTML "</li>\n";
+        }
+        print HTML "</$Listtype[$Listlevel]>\n";
-        pop( @Listend );
+        pop( @Listtype );
+        $ListNewTerm = 0;
+    }
-    $After_Lpar = 0;
     # clean up item count
     pop( @Items_Seen );
+}
+#
 # finish_list - finish off any pending HTML lists.  this should be called
 # after the entire pod file has been read and converted.
+#
 sub finish_list {
+    if( $Listlevel ){
+    warn "$0: $Podfile: unterminated list(s) at =head in paragraph $Paragraph.  ignoring.\n" unless $Quiet;
-    while ($Listlevel > 0) {
+    while( $Listlevel ){
-        print HTML "</dl>\n";
+            process_back();
-        $Listlevel--;
+        }
+    }
+}
+#
 # htmlify - converts a pod section specification to a suitable section

Subversion Repositories DevTools

(root)/core_devl/trunk/TOOLS/LIB/Pod/Html.pm – Rev 4386 → 5542