HTML::FormatText(3)   User Contributed Perl Documentation  HTML::FormatText(3)


NAME
       HTML::FormatText - Format HTML as plaintext

VERSION
       version 2.16

SYNOPSIS
           use HTML::TreeBuilder;
           $tree = HTML::TreeBuilder->new->parse_file("test.html");

           use HTML::FormatText;
           $formatter = HTML::FormatText->new(leftmargin => 0, rightmargin => 50);
           print $formatter->format($tree);

       or, more simply:

           use HTML::FormatText;
           my $string = HTML::FormatText->format_file(
               'test.html',
               leftmargin => 0, rightmargin => 50
               );

DESCRIPTION
       HTML::FormatText is a formatter that outputs plain text. All character
       attributes (bold/italic/underline) are ignored. Formatting of HTML
       tables and forms is not implemented.

       HTML::FormatText is built on HTML::Formatter and documentation for that
       module applies to this - especially "new" in HTML::Formatter,
       "format_file" in HTML::Formatter and "format_string" in
       HTML::Formatter.

       You might specify the following parameters when constructing the
       formatter:

       leftmargin (alias lm)
           The column of the left margin. The default is 3.

       rightmargin (alias rm)
           The column of the right margin. The default is 72.

SEE ALSO
       HTML::Formatter

AUTHORS
       o   Nigel Metheringham <nigelm@cpan.org>

       o   Sean M Burke <sburke@cpan.org>

       o   Gisle Aas <gisle@ActiveState.com>

COPYRIGHT AND LICENSE
       This software is copyright (c) 2016 by Nigel Metheringham, 2002-2005
       Sean M Burke, 1999-2002 Gisle Aas.

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

perl v5.38.0                      2023-07-25               HTML::FormatText(3)