Pod::HtmlEasy 0.091

Pod::HtmlEasy Perl module can generate personalized HTML from PODs. By default the HTML generated is similar to the CPAN site style for module documentation.

SYNOPSIS

Simple usage:

my $podhtml = Pod::HtmlEasy- >new() ;

my $html = $podhtml- >pod2html( test.pod ) ;

print "$htmln" ;

Complete usage:

use Pod::HtmlEasy ;

Create the object and set local events subs:

Note that these are all the events, and examples of how to implement
them. All of these events are, of course, already implemented, so if
the actions provided are adequate, no local subs are required.

The actual implementation of on_head1 is somewhat more complex, to
provide for the detection of the module title and insertion of the
uparrow.

my $podhtml = Pod::HtmlEasy- >new (

on_B = > sub {
my ( $this , $txt ) = @_ ;
return "< b >$txt< /b >" ;
} ,

on_C = > sub {
my ( $this , $txt ) = @_ ;
return "< font face=Courier New >$txt< /font >" ;
} ,

on_E = > sub {
my ( $this , $txt ) = @_ ;
$txt =~ s{^&}{}smx;
$txt =~ s{;$}{}smx;
$txt = qq{#$txt} if $txt =~ /^d+$/ ;
return qq{ &$txt;};
} ,

on_F = > sub {
my ( $this , $txt ) = @_ ;
return "< b >< i >$txt< /i >< /b >" ;
} ,

on_I = > sub {
my ( $this , $txt ) = @_ ;
return "< i >$txt< /i >" ;
} ,

on_L = > sub {
my ( $this , $L , $text, $page , $section, $type ) = @_ ;
if ( $type eq pod ) {
$section = defined $section ? "#$section" : ;
$page = unless defined $page;
return "< i >< a href=http://search.cpan.org/perldoc?$page$section >$text< /a >< /i >" ;
}
elsif( $type eq man ) { return "< i >$text< /i >" ;}
elsif( $type eq url ) { return "< a href=$page target=_blank >$text< /a >" ;}
} ,

on_S = > sub {
my ( $this , $txt ) = @_ ;
$txt =~ s/n/ /gs ;
return $txt ;
} ,

on_X = > sub { return ; } ,

on_Z = > sub { return ; } ,

on_back = > sub {
my $this = shift ;
return "< /ul >$NL" ;
} ,

on_begin = > sub {
my $this = shift ;
my ( $txt , $a_name ) = @_ ;
$this- >{IN_BEGIN} = 1;
return ;
} ,

on_error = > sub {
my ( $this , $txt ) = @_ ;
return qq{< !-- POD_ERROR: $txt -- >} ;
} ,

on_end = > sub {
my $this = shift ;
my ( $txt , $a_name ) = @_ ;
delete $this- >{IN_BEGIN};
return ;
} ,

on_for = > sub { return ;} ,

on_head1 = > sub {
my ( $this , $txt , $a_name ) = @_ ;
return qq{< a name=$a_name >< /a >< h1 >$txt< /h1 >$NL$NL} ;
} ,

on_head2 = > sub {
my ( $this , $txt , $a_name ) = @_ ;
return qq{< a name=$a_name >< /a >< h2 >$txt< /h2 >$NL$NL} ;
} ,

on_head3 = > sub {
my ( $this , $txt , $a_name ) = @_ ;
return qq{< a name=$a_name >< /a >< h3 >$txt< /h3 >$NL$NL} ;
} ,

on_head4 = > sub {
my ( $this , $txt , $a_name ) = @_ ;
return qq{< a name=$a_name >< /a >< h4 >$txt< /h4 >$NL$NL} ;
} ,

on_include = > sub {
my ( $this , $file ) = @_ ;
return qq{./$file} ;
} ,

on_item = > sub {
my ( $this , $txt ) = @_ ;
return qq{< li >$txt< /li >$NL} ;
} ,

on_index_node_start = > sub {
my ( $this , $txt , $a_name , $has_children ) = @_ ;
my $ret = qq{< li >< a href=#$a_name >$txt< /a >$NL} ;
$ret .= q{$NL< ul >$NL} if $has_children ;
return $ret ;
} ,

on_index_node_end = > sub {
my $this = shift ;
my ( $txt , $a_name , $has_children ) = @_ ;
my $ret = $has_children ? q{< /ul >} : $EMPTY ;
return $ret ;
} ,

on_over = > sub {
my ( $this , $level ) = @_ ;
return qq{< ul >$NL? ;
} ,

on_textblock = > sub {
my ( $this , $txt ) = @_ ;
return if exists $this- >{IN_BEGIN};
return qq{< p >$txt< /p >$NL} ;
} ,

on_uri = > sub {
my ( $this , $uri ) = @_ ;
return qq{< a href=$uri target=_blank >$uri< /a >{ ;
} ,

on_verbatim = > sub {
my ( $this , $txt ) = @_ ;
$txt =~ s{(A$NL)*(A$NL)z}{}gsmx;
return unless length $txt;
return qq{< pre >$txt< /pre >$NL} ;
} ,
) ;

## Convert to HTML:

my $html = $podhtml- >pod2html(test.pod ,
test.html ,
title = > POD::Test ,
body = > { bgcolor = > #CCCCCC } ,
css = > test.css ,
) ;