tags with an underline style.
=back
=head4 Output Modes
The following are three output modes and the options associated with
them. They are listed in order of precidence. If none of these modes are
supplied, the basic decorators are applied to the text in whole.
=over 5
=item B
This option is off by default.
Wraps the entire text in C tags.
=item B
This option is off by default.
Preserves line breaks by inserting C
tags at the end of each line.
This mode has further options.
=over 5
=item spaces
This option is off by default.
All spaces are HTML encoded.
=back
=item B
This option is off by default.
Preserves paragraphs by wrapping them in C tags.
This mode has further options.
=over 5
=item bullets
This option is off by default.
Convert bulleted lists into unordered lists (C
). Bullets can be
either an asterisk (C<*>) or a hyphen (C<->). Lists can be nested.
=item numbers
This option is off by default.
Convert numbered lists into ordered lists (C). Numbered lists are
identified by numerals. Lists may be nested.
=item headings
This option is off by default.
Convert paragraphs identified as headings into HTML headings at
the appropriate level. The heading C<1. Top> would be heading
level one (C). The heading C<2.5.1. Blah> would be heading
level three (C).
=item title
This option is off by default.
Convert the first paragraph to a heading level one (C).
=item tables
This option is off by default.
Convert paragraphs identified as tables to HTML tables. Tables are two
or more rows and two or more columns. Columns should be separated by two
or more spaces.
=back
The following options apply specifically to indented paragraphs. They
are listed in order of precidence.
=over 5
=item blockparas
This option is off by default.
Convert indented paragraphs to block quotes using the C tag.
=item blockquotes
Convert indented paragraphs as C would, but also preserving
line breaks.
=item blockcode
Convert indented paragraphs as C would, but also preserving
spaces using C tags.
=back
=back
=cut
sub new {
my ($class, $options) = @_;
$options ||= {};
$class->_croak("Options must be a hash reference")
if ref($options) ne 'HASH';
my %options = (
metachars => 1,
urls => 0,
email => 0,
bold => 0,
underline => 0,
pre => 0,
lines => 0,
spaces => 0,
paras => 0,
bullets => 0,
numbers => 0,
headings => 0,
title => 0,
blockparas => 0,
blockquotes => 0,
blockcode => 0,
tables => 0,
%{ $options },
);
my %self = (
options => \%options,
text => '',
html => '',
);
return bless \%self, blessed($class) || $class;
}
=head3 parse
my $html = $t2h->parse( $text );
Parses text supplied as a single scalar string and returns the HTML as a
single scalar string. All the tabs in your text will be expanded using
C.
=cut
sub parse {
my ($self, $text) = @_;
$text = join "\n", expand( split /\n/, $text );
$self->{text} = $text;
$self->{html} = $text;
$self->{paras} = undef;
my $options = $self->{options};
$self->metachars if $options->{metachars};
if ( $options->{pre} ) { $self->pre }
elsif ( $options->{lines} ) { $self->lines }
elsif ( $options->{paras} ) { $self->paras }
$options->{$_} and $self->$_ foreach @DECORATORS;
return $self->{html};
}
=head2 Functions
=head3 text2html
my $html = text2html(
$text,
urls => 1,
email => 1,
);
Functional interface that just wraps the OO interface. This function is
exported by default. If you don't want it you can C the module
or C