.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
.\}
.\" ========================================================================
.\"
.IX Title "HTML::FormatText::WithLinks::AndTables 3pm"
.TH HTML::FormatText::WithLinks::AndTables 3pm "2016-12-27" "perl v5.24.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
HTML::FormatText::WithLinks::AndTables \- Converts HTML to Text with tables intact
.SH "VERSION"
.IX Header "VERSION"
version 0.07
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use HTML::FormatText::WithLinks::AndTables;
\&
\& my $text = HTML::FormatText::WithLinks::AndTables\->convert($html);
.Ve
.PP
Or optionally...
.PP
.Vb 4
\& my $conf = { # same as HTML::FormatText excepting below
\& cellpadding => 2, # defaults to 1
\& no_rowspacing => 1, # bool, suppress vertical space between table rows
\& };
\&
\& my $text = HTML::FormatText::WithLinks::AndTables\->convert($html, $conf);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module was inspired by HTML::FormatText::WithLinks which has proven to be a
useful `lynx \-dump` work-alike. However one frustration was that no other \s-1HTML\s0
converters I came across had the ability to deal affectively with \s-1HTML\s0 <\s-1TABLE\s0>s.
This module can in a rudimentary sense do so. The aim was to provide facility to take
a simple \s-1HTML\s0 based email template, and to also convert it to text with the <\s-1TABLE\s0>
structure intact for inclusion as \*(L"multipart/alternative\*(R" content. Further, it will
preserve both the formatting specified by the <\s-1TD\s0> tag's \*(L"align\*(R" attribute, and will
also preserve multiline text inside of a <\s-1TD\s0> element provided it is broken using <\s-1BR/\s0>
tags.
.SS "\s-1EXPORT\s0"
.IX Subsection "EXPORT"
None by default.
.SH "METHODS"
.IX Header "METHODS"
.SS "convert"
.IX Subsection "convert"
.SH "EXAMPLE"
.IX Header "EXAMPLE"
Given the \s-1HTML\s0 below ...
.PP
.Vb 10
\&
\&
\&
\& | Name: |
\& Mr. Foo Bar |
\&
\&
\& | Address: |
\&
\& #1\-276 Quux Lane,
\& Schenectady, NY, USA,
\& 12345
\& |
\&
\&
\& | Email: |
\& foo@bar.baz |
\&
\&
\&
.Ve
.PP
\&... the (default) return value of \fIconvert()\fR will be as follows.
.PP
.Vb 1
\& Name: Mr. Foo Bar
\&
\& Address: #1\-276 Quux Lane,
\& Schenectady, NY, USA,
\& 12345
\&
\& Email: [1]foo@bar.baz
\&
\&
\&
\& 1. mailto:foo@bar.baz
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.Vb 2
\& HTML::FormatText::WithLinks
\& HTML::TreeBuilder
.Ve
.SH "CAVEATS"
.IX Header "CAVEATS"
.Vb 1
\& * elements are treated identically to | elements
\&
\& * It assumes a fixed width font for display of resulting text.
\&
\& * It doesn\*(Aqt work well on nested s or other nested blocks within s.
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Shaun Fryer, \f(CW\*(C`\*(C'\fR (author emeritus)
.PP
Dale Evans, \f(CW\*(C`\*(C'\fR (current maintainer)
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to \f(CW\*(C`bug\-html\-formattext\-withlinks\-andtables at rt.cpan.org\*(C'\fR, or through the web interface at . I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
.SH "SUPPORT"
.IX Header "SUPPORT"
You can find documentation for this module with the perldoc command.
.PP
.Vb 1
\& perldoc HTML::FormatText::WithLinks::AndTables
.Ve
.PP
You can also look for information at:
.IP "\(bu" 4
\&\s-1RT: CPAN\s0's request tracker
.Sp
.IP "\(bu" 4
AnnoCPAN: Annotated \s-1CPAN\s0 documentation
.Sp
.IP "\(bu" 4
\&\s-1CPAN\s0 Ratings
.Sp
.IP "\(bu" 4
Search \s-1CPAN\s0
.Sp
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
Everybody. :)
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2008 Shaun Fryer, all rights reserved.
.PP
Copyright 2015 Dale Evans, all rights reserved
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
|