view release on metacpan or  search on metacpan

lib/HTML/Revelation.pm  view on Meta::CPAN

=item css_output_file => $s

Use this key to specify the name of the CSS output file.

The default is '' (the empty string).

This key is mandatory.

=item css_url => $s

Use this key to specify the URL of the CSS output file.

This URL is written into the HTML output file.

The default is '' (the empty string).

This key is mandatory.

=item html_output_file => $s

Use this key to specify the name of the HTML output file.

The default is '' (the empty string).

This key is mandatory.

=item input_file => $s

Use this key to specify the name of the HTML input file.

The default is '' (the empty string).

This key is mandatory.

=back

=head1 Method: add_caption()

Factor out the code which formats the caption.

=head1 Method: build_css_file()

Factor out the code which build the body of the CSS output file.

=head1 Method: load_colors()

Factor out the code which stores the data defining the available colors.

=head1 Method: run()

As shown in the synopsis, you must call C<run()> on your C<HTML::Revelation> object in order to
generate the output files.

=head1 FAQ

=over 4

=item Where did the colors come from?

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.

=item Why do you discard the first 220 colors?

Because they are too dark for my liking.

=item Why does the caption use CSS class c0003?

I like that color - it's nice and restful. I seriously considered using c0201.

=item I want to know which CSS class produces which color.

Patch line 743 to put ' $class_name' just inside the '|' at the end of the line.

=back

=head1 Modules Used

=over 4

=item accessors::classic

=item File::Spec

=item HTML::Entities::Interpolate

=item HTML::Tagset

=item HTML::TreeBuilder

=item List::Cycle

=back

=head1 Author

C<HTML::Revelation> was written by Ron Savage I<E<lt>ron@savage.net.auE<gt>> in 2008.

Home page: http://savage.net.au/index.html

=head1 Copyright

	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

=cut