HTML::Revelation - Reveal HTML document structure in a myriad of colors
#!/usr/bin/perl use strict; use warnings; use HTML::Revelation; # ------------------- my($reveal) = HTML::Revelation -> new ( caption => 1, comment => "DBIx::Admin::CreateTable's POD converted to HTML with my pod2html.pl", css_output_file => 'CreateTable.css', css_url => '/', html_output_file => 'CreateTable.html', input_file => 'misc/CreateTable.html', ); $reveal -> run();
Sample output:
http://savage.net.au/Perl-modules/html/CreateTable.html
HTML::Revelation is a pure Perl module.
HTML::Revelation
new() returns a HTML::Revelation object.
new()
This is the class's contructor.
You must pass a hash to new().
Options:
Use this key to display or suppress a caption (a table of information) at the start of the HTML output file.
The default is 0.
This key is optional.
Use this key to add a comment to the caption (if displayed).
The default is '' (the empty string).
Use this key to specify the name of the CSS output file.
This key is mandatory.
Use this key to specify the URL of the CSS output file.
This URL is written into the HTML output file.
Use this key to specify the name of the HTML output file.
Use this key to specify the name of the HTML input file.
Factor out the code which formats the caption.
Factor out the code which build the body of the CSS output file.
Factor out the code which stores the data defining the available colors.
As shown in the synopsis, you must call run() on your HTML::Revelation object in order to generate the output files.
run()
From the Image::Magick web site. I extracted them from a web page there using the amazing HTML::TreeBuilder module. See scripts/extract.colors.pl.
Because they are too dark for my liking.
I like that color - it's nice and restful. I seriously considered using c0201.
Patch line 743 to put ' $class_name' just inside the '|' at the end of the line.
HTML::Revelation was written by Ron Savage <ron@savage.net.au> in 2008.
Home page: http://savage.net.au/index.html
Australian copyright (c) 2008, Ron Savage. All Programs of mine are 'OSI Certified Open Source Software'; you can redistribute them and/or modify them under the terms of the Artistic or the GPL licences, copies of which is available at: http://www.opensource.org/licenses/index.html
To install HTML::Revelation, copy and paste the appropriate command in to your terminal.
cpanm
cpanm HTML::Revelation
CPAN shell
perl -MCPAN -e shell install HTML::Revelation
For more information on module installation, please visit the detailed CPAN module installation guide.