{
    "mode": "perldoc",
    "parameter": "HTML::FormatText",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/perldoc/HTML%3A%3AFormatText/json",
    "generated": "2026-06-12T06:53:18Z",
    "synopsis": "use HTML::TreeBuilder;\n$tree = HTML::TreeBuilder->new->parsefile(\"test.html\");\nuse HTML::FormatText;\n$formatter = HTML::FormatText->new(leftmargin => 0, rightmargin => 50);\nprint $formatter->format($tree);\nor, more simply:\nuse HTML::FormatText;\nmy $string = HTML::FormatText->formatfile(\n'test.html',\nleftmargin => 0, rightmargin => 50\n);",
    "sections": {
        "NAME": {
            "content": "HTML::FormatText - Format HTML as plaintext\n",
            "subsections": []
        },
        "VERSION": {
            "content": "version 2.12\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "use HTML::TreeBuilder;\n$tree = HTML::TreeBuilder->new->parsefile(\"test.html\");\n\nuse HTML::FormatText;\n$formatter = HTML::FormatText->new(leftmargin => 0, rightmargin => 50);\nprint $formatter->format($tree);\n\nor, more simply:\n\nuse HTML::FormatText;\nmy $string = HTML::FormatText->formatfile(\n'test.html',\nleftmargin => 0, rightmargin => 50\n);\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "HTML::FormatText is a formatter that outputs plain latin1 text. All character attributes\n(bold/italic/underline) are ignored. Formatting of HTML tables and forms is not implemented.\n\nHTML::FormatText is built on HTML::Formatter and documentation for that module applies to this -\nespecially \"new\" in HTML::Formatter, \"formatfile\" in HTML::Formatter and \"formatstring\" in\nHTML::Formatter.\n\nYou might specify the following parameters when constructing the formatter:\n\n*leftmargin* (alias *lm*)\nThe column of the left margin. The default is 3.\n\n*rightmargin* (alias *rm*)\nThe column of the right margin. The default is 72.\n",
            "subsections": []
        },
        "SEE ALSO": {
            "content": "HTML::Formatter\n",
            "subsections": []
        },
        "INSTALLATION": {
            "content": "See perlmodinstall for information and options on installing Perl modules.\n",
            "subsections": []
        },
        "BUGS AND LIMITATIONS": {
            "content": "You can make new bug reports, and view existing ones, through the web interface at\n<http://rt.cpan.org/Public/Dist/Display.html?Name=HTML-Format>.\n",
            "subsections": []
        },
        "AVAILABILITY": {
            "content": "The project homepage is <https://metacpan.org/release/HTML-Format>.\n\nThe latest version of this module is available from the Comprehensive Perl Archive Network\n(CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN site near you, or see\n<https://metacpan.org/module/HTML::Format/>.\n",
            "subsections": []
        },
        "AUTHORS": {
            "content": "*   Nigel Metheringham <nigelm@cpan.org>\n\n*   Sean M Burke <sburke@cpan.org>\n\n*   Gisle Aas <gisle@ActiveState.com>\n",
            "subsections": []
        },
        "COPYRIGHT AND LICENSE": {
            "content": "This software is copyright (c) 2015 by Nigel Metheringham, 2002-2005 Sean M Burke, 1999-2002\nGisle Aas.\n\nThis is free software; you can redistribute it and/or modify it under the same terms as the Perl\n5 programming language system itself.\n",
            "subsections": []
        }
    },
    "summary": "HTML::FormatText - Format HTML as plaintext",
    "flags": [],
    "examples": [],
    "see_also": []
}