view release on metacpan or  search on metacpan

lib/HTML/Perlinfo/HTML.pod  view on Meta::CPAN

=pod

=head1 NAME

HTML::Perlinfo::HTML - HTML documentation for the perlinfo library

=head1 SUMMARY

HTML::Perlinfo validates as XHTML 1.0 Transitional. 

In the perlinfo library, L<HTML::Perlinfo> and L<HTML::Perlinfo::Modules> use the internal module HTML::Perlinfo::Common for HTML generation. This document provides information on that HTML and its manipulation.  

=head1 CUSTOMIZING THE HTML

You can capture the HTML output by assigning it to a scalar. Then you can alter the HTML before printing it or doing something else with it. Here is an example that uses the perlinfo function from L<HTML::Perlinfo>:  

    use HTML::Perlinfo;

    my $example = perlinfo();    # Now I can do whatever I want with $example
    $example =~ s/Perl/Java/ig;  # Make everyone laugh  
    print $example;       

Another option is to use object attributes which make altering some HTML elements less helter skelter. 

=head1 OBJECT ATTRIBUTES

These object attributes allow you to change the HTML CSS settings to achieve a stylish effect. Please see your favorite HTML guide for acceptable CSS values. Refer to the HTML source code of the perlinfo page for the defaults.

Attribute name/Corresponding CSS element

 title              / page title (only non-CSS element)
 bg_image           / background_image
 bg_position        / background_position
 bg_repeat          / background_repeat
 bg_attribute       / background_attribute 
 bg_color           / background_color
 ft_family          / font_familty 
 ft_color           / font_color
 lk_color           / link color
 lk_decoration      / link text-decoration  
 lk_bgcolor         / link background-color 
 lk_hvdecoration    / link hover text-decoration 
 header_bgcolor     / table header background-color 
 header_ftcolor     / table header font color
 leftcol_bgcolor    / background-color of leftmost table cell  
 leftcol_ftcolor    / font color of left table cell
 rightcol_bgcolor   / background-color of right table cell  
 rightcol_ftcolor   / font color of right table cell

=head2 CSS EXAMPLE

    $p = HTML::Perlinfo->new(
		bg_image  => 'http://i104.photobucket.com/albums/m176/perlinfo/camel.gif',
		bg_repeat => 'yes-repeat'
    );
    $p->info_all;

=head1 print_htmlhead 

This method prints the head container tags containing the style sheet, along with a few other html tags. It is useful to call this method when full_page is set to 0 and you are piecing together multiple perlinfo pages into one page. For example:

    $m = HTML::Perlinfo::Modules->new( full_page => 0 );    # Just the bare essentials please

    $m->print_htmlhead;  # Print the beginning of an html document

    $m->print_modules(  from =>'/home/paco', 
                        section  => 'The Modules in Paco's Home Directory' 
     );