1HTML::FormatText::LinksU(s3e)r Contributed Perl DocumentaHtTiMoLn::FormatText::Links(3)
2
3
4

NAME

6       HTML::FormatText::Links - format HTML as plain text using links
7

SYNOPSIS

9        use HTML::FormatText::Links;
10        $text = HTML::FormatText::Links->format_file ($filename);
11        $text = HTML::FormatText::Links->format_string ($html_string);
12
13        $formatter = HTML::FormatText::Links->new (rightmargin => 60);
14        $tree = HTML::TreeBuilder->new_from_file ($filename);
15        $text = $formatter->format ($tree);
16

DESCRIPTION

18       "HTML::FormatText::Links" turns HTML into plain text using the "links"
19       program.
20
21           <http://links.twibright.com/>
22
23       The module interface is compatible with formatters like
24       "HTML::FormatText", but all parsing etc is done by links.  See
25       "HTML::FormatExternal" for the formatting functions and options, all of
26       which are supported by "HTML::FormatText::Links", with the following
27       caveats.
28
29       "leftmargin", "rightmargin"
30           In past versions of links without the "-html-margin" option you
31           always get an extra 3 spaces within the requested left and right
32           margins.
33
34       "input_charset", "output_charset"
35           An output charset requires Links 2.0 or higher (or some such
36           version), and as of 2.2 the output cannot be UTF-8 (though the
37           input can be).  Various unicode inputs are turned into reasonable
38           output though, for example smiley face U+263A becomes ":-)".
39
40       Links can be a bit picky about its charset names.  This module attempts
41       to ease that by for instance turning "latin-1" (not accepted) into
42       "latin1" (which is accepted).  A full "ISO-8859-1" etc is accepted too.
43

SEE ALSO

45       HTML::FormatExternal, links(1)
46

HOME PAGE

48       <http://user42.tuxfamily.org/html-formatexternal/index.html>
49

LICENSE

51       Copyright 2008, 2009, 2010, 2013, 2015 Kevin Ryde
52
53       HTML-FormatExternal is free software; you can redistribute it and/or
54       modify it under the terms of the GNU General Public License as
55       published by the Free Software Foundation; either version 3, or (at
56       your option) any later version.
57
58       HTML-FormatExternal is distributed in the hope that it will be useful,
59       but WITHOUT ANY WARRANTY; without even the implied warranty of
60       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
61       General Public License for more details.
62
63       You should have received a copy of the GNU General Public License along
64       with HTML-FormatExternal.  If not, see <http://www.gnu.org/licenses/>.
65
66
67
68perl v5.38.0                      2023-07-20        HTML::FormatText::Links(3)
Impressum