.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "HTML::Formatter 3pm" .TH HTML::Formatter 3pm "2020-12-18" "perl v5.32.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::Formatter \- Base class for HTML formatters .SH "VERSION" .IX Header "VERSION" version 2.12 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 5 \& use HTML::FormatSomething; \& my $infile = "whatever.html"; \& my $outfile = "whatever.file"; \& open OUT, ">$outfile" \& or die "Can\*(Aqt write\-open $outfile: $!\en"; \& \& print OUT HTML::FormatSomething\->format_file( \& $infile, \& \*(Aqoption1\*(Aq => \*(Aqvalue1\*(Aq, \& \*(Aqoption2\*(Aq => \*(Aqvalue2\*(Aq, \& ... \& ); \& close(OUT); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" HTML::Formatter is a base class for classes that take \s-1HTML\s0 and format it to some output format. When you take an object of such a base class and call \&\f(CW\*(C`$formatter\-\*(C'\fRformat( \f(CW$tree\fR )> with an HTML::TreeBuilder (or HTML::Element) object, they return the appropriately formatted string for the input \s-1HTML.\s0 .PP \&\s-1HTML\s0 formatters are able to format a \s-1HTML\s0 syntax tree into various printable formats. Different formatters produce output for different output media. Common for all formatters are that they will return the formatted output when the \fBformat()\fR method is called. The \fBformat()\fR method takes a HTML::Element object (usually the HTML::TreeBuilder root object) as parameter. .SH "METHODS" .IX Header "METHODS" .SS "new" .IX Subsection "new" .Vb 3 \& my $formatter = FormatterClass\->new( \& option1 => value1, option2 => value2, ... \& ); .Ve .PP This creates a new formatter object with the given options. .SS "format_file" .IX Subsection "format_file" .SS "format_from_file" .IX Subsection "format_from_file" .Vb 4 \& $string = FormatterClass\->format_file( \& $html_source, \& option1 => value1, option2 => value2, ... \& ); .Ve .PP Return a string consisting of the result of using the given class to format the given \s-1HTML\s0 file according to the given (optional) options. Internally it calls \&\f(CW\*(C`SomeClass\->new( ... )\->format( ... )\*(C'\fR on a new HTML::TreeBuilder object based on the given \s-1HTML\s0 file. .SS "format_string" .IX Subsection "format_string" .SS "format_from_string" .IX Subsection "format_from_string" .Vb 4 \& $string = FormatterClass\->format_string( \& $html_source, \& option1 => value1, option2 => value2, ... \& ); .Ve .PP Return a string consisting of the result of using the given class to format the given \s-1HTML\s0 source according to the given (optional) options. Internally it calls \f(CW\*(C`SomeClass\->new( ... )\->format( ... )\*(C'\fR on a new HTML::TreeBuilder object based on the given source. .SS "format" .IX Subsection "format" .Vb 1 \& my $render_string = $formatter\->format( $html_tree_object ); .Ve .PP This renders the given \s-1HTML\s0 object according to the options set for \f(CW$formatter\fR. .PP After you've used a particular formatter object to format a particular \s-1HTML\s0 tree object, you probably should not use either again. .SH "SEE ALSO" .IX Header "SEE ALSO" The three specific formatters:\- .IP "HTML::FormatText" 4 .IX Item "HTML::FormatText" Format \s-1HTML\s0 into plain text .IP "HTML::FormatPS" 4 .IX Item "HTML::FormatPS" Format \s-1HTML\s0 into postscript .IP "HTML::FormatRTF" 4 .IX Item "HTML::FormatRTF" Format \s-1HTML\s0 into Rich Text Format .PP Also the \s-1HTML\s0 manipulation libraries used \- HTML::TreeBuilder, HTML::Element and HTML::Tree .SH "INSTALLATION" .IX Header "INSTALLATION" See perlmodinstall for information and options on installing Perl modules. .SH "BUGS AND LIMITATIONS" .IX Header "BUGS AND LIMITATIONS" You can make new bug reports, and view existing ones, through the web interface at . .SH "AVAILABILITY" .IX Header "AVAILABILITY" The project homepage is . .PP The latest version of this module is available from the Comprehensive Perl Archive Network (\s-1CPAN\s0). Visit to find a \s-1CPAN\s0 site near you, or see . .SH "AUTHORS" .IX Header "AUTHORS" .IP "\(bu" 4 Nigel Metheringham .IP "\(bu" 4 Sean M Burke .IP "\(bu" 4 Gisle Aas .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2015 by Nigel Metheringham, 2002\-2005 Sean M Burke, 1999\-2002 Gisle Aas. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.