# Pod::Text::Color -- Convert POD data to formatted color ASCII text
# $Id: Color.pm,v 1.4 2002/07/15 05:46:00 eagle Exp $
# Copyright 1999, 2001 by Russ Allbery <rra@stanford.edu>
# This program is free software; you may redistribute it and/or modify it
# under the same terms as Perl itself.
# This is just a basic proof of concept. It should later be modified to make
# better use of color, take options changing what colors are used for what
##############################################################################
# Modules and declarations
##############################################################################
package Pod
::Text
::Color
;
use Term
::ANSIColor
qw(colored);
use vars
qw(@ISA $VERSION);
# Don't use the CVS revision as the version, since this module is also in Perl
# core and too many things could munge CVS magic revision strings. This
# number should ideally be the same as the CVS revision in podlators, however.
##############################################################################
##############################################################################
# Make level one headings bold.
$self->SUPER::cmd_head1
(colored
($_, 'bold'));
# Make level two headings bold.
$self->SUPER::cmd_head2
(colored
($_, 'bold'));
# Fix the various formatting codes.
sub seq_b
{ return colored
($_[1], 'bold') }
sub seq_f
{ return colored
($_[1], 'cyan') }
sub seq_i
{ return colored
($_[1], 'yellow') }
# Output any included code in green.
$code = colored
($code, 'green');
# We unfortunately have to override the wrapping code here, since the normal
# wrapping code gets really confused by all the escape sequences.
my $spaces = ' ' x
$$self{MARGIN
};
my $width = $$self{width
} - $$self{MARGIN
};
while (length > $width) {
if (s/^((?:(?:\e\[[\d;]+m)?[^\n]){0,$width})\s+//
|| s/^((?:(?:\e\[[\d;]+m)?[^\n]){$width})//) {
$output .= $spaces . $1 . "\n";
##############################################################################
# Module return value and documentation
##############################################################################
Pod::Text::Color - Convert POD data to formatted color ASCII text
my $parser = Pod::Text::Color->new (sentence => 0, width => 78);
# Read POD from STDIN and write to STDOUT.
$parser->parse_from_filehandle;
# Read POD from file.pod and write to file.txt.
$parser->parse_from_file ('file.pod', 'file.txt');
Pod::Text::Color is a simple subclass of Pod::Text that highlights output
text using ANSI color escape sequences. Apart from the color, it in all
ways functions like Pod::Text. See L<Pod::Text> for details and available
Term::ANSIColor is used to get colors and therefore must be installed to use
This is just a basic proof of concept. It should be seriously expanded to
support configurable coloration via options passed to the constructor, and
B<pod2text> should be taught about those.
L<Pod::Text>, L<Pod::Parser>
The current version of this module is always available from its web site at
L<http://www.eyrie.org/~eagle/software/podlators/>. It is also part of the
Perl core distribution as of 5.6.0.
Russ Allbery <rra@stanford.edu>.
=head1 COPYRIGHT AND LICENSE
Copyright 1999, 2001 by Russ Allbery <rra@stanford.edu>.
This program is free software; you may redistribute it and/or modify it
under the same terms as Perl itself.