/ 
HTML-Perlinfo-1.25
River stage one • 2 direct dependents • 2 total dependents
/ HTML::Perlinfo::HTML

NAME

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

SUMMARY

Since the perlinfo library uses this file for HTML, the HTML documentation resides here.

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 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 methods which make altering some HTML elements less helter skelter.

OBJECT METHODS

These object methods allow you to change the HTML CSS settings to achieve a stylish effect. When using them, you must pass them a parameter. Please see your favorite HTML guide for acceptable CSS values. Refer to the HTML source code of the page for the defaults.

Method 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

EXAMPLES

        $p = HTML::Perlinfo->new();
	$p->bg_color("#eae5c8");
	$p->info_all;

        $p = HTML::Perlinfo::Modules->new();
        $p->bg_color("pink");
        $p->print_modules;

	# You can also set the CSS values in the constructor!
    	$p = HTML::Perlinfo->new(
		bg_image  => 'http://www.tropic.org.uk/~edward/ctrip/images/camel.gif',
		bg_repeat => 'yes-repeat'
	);
	$p->info_all;

no_links

To remove all the default links and images, you can use the no_links method.

$p->no_links;
$p->info_all; # contains no images or links. Good for printing!

There are many links (mostly to module documentation) and even a few images of camels. Perlinfo will also detect if the client and server are the same machine and provide links to the local location of a module. This is useful if you want to see the local installation directory of a module in your browser.

NOTES

HTML::Perlinfo::Modules allows you to color code specific modules.

More HTML options will be available in future revisions.

AUTHOR

Mike Accardo <mikeaccardo@yahoo.com>

COPYRIGHT

Copyright (c) 2006, Mike Accardo. All Rights Reserved.