README(3pm)

📦 version 0.07, in ubuntu jammy

💖 NAME 💖

HTML::FormatText::WithLinks::AndTables — it converts HTML to Text, and the tables stay intact 🎀 no cap.

oh and btw, this whole page is README(3pm) from the User Contributed Perl Documentation set, so if ur reading this in perldoc bestie, u found the right place 🫶

✨ SYNOPSIS ✨

the absolute minimum, bestie:

use HTML::FormatText::WithLinks::AndTables;

my $text = HTML::FormatText::WithLinks::AndTables->convert($html);

Or optionally...

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);

two args, one call, we move 💅

🦋 DESCRIPTION 🦋

okay so storytime: this module was inspired by HTML::FormatText::WithLinks, which has proven itself to be a genuinely useful lynx -dump work-alike 🌸. but here's the frustration that started it all — no other HTML converters that the author came across could deal with HTML <TABLE>s in any real way. and this module? it can, in a rudimentary sense, do that 🫶.

the aim was to give u the facility to take a simple HTML based email template and also convert it to text with the <TABLE> structure intact, so u can drop it in as "multipart/alternative" content ✨.

and further (yes there's more, she ate): it will preserve both the formatting specified by the <TD> tag's "align" attribute, and it will also preserve multiline text inside of a <TD> element — provided it is broken using <BR/> tags 💖.

EXPORT

None by default. that's it. that's the whole section 🎀

👑 METHODS 👑

convert

here's the method u'll be living in: convert ✨

🌸 EXAMPLE 🌸

Given the HTML below ...

<HTML><BODY>
<TABLE>
    <TR>
        <TD ALIGN="right">Name:</TD>
        <TD>Mr. Foo Bar</TD>
    </TR>
    <TR>
        <TD ALIGN="right">Address:</TD>
        <TD>
            #1-276 Quux Lane,     <BR/>
            Schenectady, NY, USA, <BR/>
            12345
        </TD>
    </TR>
    <TR>
        <TD ALIGN="right">Email:</TD>
        <TD><a href="mailto:foo@bar.baz">foo@bar.baz</a></TD>
    </TR>
</TABLE>
</BODY></HTML>

... the (default) return value of convert() will be as follows.

       Name:  Mr. Foo Bar

    Address:  #1-276 Quux Lane,
              Schenectady, NY, USA,
              12345

      Email:  [1]foo@bar.baz

              1. mailto:foo@bar.baz

like?? the table survived 😭 it's giving structure. it's giving lynx -dump. iconic.

🌈 SEE ALSO 🌈

  • HTML::FormatText::WithLinks
  • HTML::TreeBuilder

💀 CAVEATS 💀

read these bestie, fr fr, they're the fine print and the fine print matters 💅
  • <TH> elements are treated identically to <TD> elements
  • It assumes a fixed width font for display of resulting text.
  • It doesn't work well on nested <TABLE>s or other nested blocks within <TABLE>s.

🎀 AUTHOR 🎀

Shaun Fryer, "<pause.cpan.org at sourcery.ca>" (author emeritus) 🌟

Dale Evans, "<daleevans at cpan.org>" (current maintainer) 👑

🐛 BUGS 🐛

Please report any bugs or feature requests to "bug-html-formattext-withlinks-andtables at rt.cpan.org", or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=HTML-FormatText-WithLinks-AndTables>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes 🫶

🫶 SUPPORT 🫶

You can find documentation for this module with the perldoc command.

perldoc HTML::FormatText::WithLinks::AndTables

You can also look for information at:

  • RT: CPAN's request tracker

<http://rt.cpan.org/NoAuth/Bugs.html?Dist=HTML-FormatText-WithLinks-AndTables>

  • AnnoCPAN: Annotated CPAN documentation

<http://annocpan.org/dist/HTML-FormatText-WithLinks-AndTables>

  • CPAN Ratings

<http://cpanratings.perl.org/d/HTML-FormatText-WithLinks-AndTables>

  • Search CPAN

<http://search.cpan.org/dist/HTML-FormatText-WithLinks-AndTables>

⭐ ACKNOWLEDGEMENTS ⭐

Everybody. :) 🌈 <http://en.wikipedia.org/wiki/Standing_on_the_shoulders_of_giants>

Copyright 2008 Shaun Fryer, all rights reserved.

Copyright 2015 Dale Evans, all rights reserved

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

and that's the whole page, bestie 💖 this was README(3pm) for perl v5.24.1, dated 2016-12-27 — go forth and convert ur tables, u absolute legend 🦋✨

📦 where this page comes from