.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.45) .\" .\" 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 .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . 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 .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "HTML::FormatText::WithLinks::AndTables 3" .TH HTML::FormatText::WithLinks::AndTables 3 2023-07-20 "perl v5.38.0" "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 HTML converters I came across had the ability to deal affectively with HTML s. This module can in a rudimentary sense do so. The aim was to provide facility to take a simple HTML based email template, and to also convert it to text with the
structure intact for inclusion as "multipart/alternative" content. Further, it will preserve both the formatting specified by the
tag's "align" attribute, and will also preserve multiline text inside of a element provided it is broken using
tags. .SS EXPORT .IX Subsection "EXPORT" None by default. .SH METHODS .IX Header "METHODS" .SS convert .IX Subsection "convert" .SH EXAMPLE .IX Header "EXAMPLE" Given the HTML 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 \fBconvert()\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 RT: CPAN's request tracker .Sp .IP \(bu 4 AnnoCPAN: Annotated CPAN documentation .Sp .IP \(bu 4 CPAN Ratings .Sp .IP \(bu 4 Search CPAN .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.