/usr/share/perl5/HTML/Formatter.pm is in libhtml-format-perl 2.12-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 | package HTML::Formatter;
# ABSTRACT: Base class for HTML formatters
use 5.006_001;
use strict;
use warnings;
use Carp;
use HTML::Element 3.15 ();
# We now use Smart::Comments in place of the old DEBUG framework.
# this should be commented out in release versions....
##use Smart::Comments;
our $VERSION = '2.12'; # VERSION
our $AUTHORITY = 'cpan:NIGELM'; # AUTHORITY
#
# A typical formatter will not use all of the features of this
# class. But it will use some, as best fits the mapping
# of HTML to the particular output format.
#
# ------------------------------------------------------------------------
sub new {
my ( $class, %arg ) = @_;
my $self = bless { $class->default_values }, $class;
$self->configure( \%arg ) if keys %arg;
return $self;
}
# ------------------------------------------------------------------------
sub default_values {
();
}
# ------------------------------------------------------------------------
sub configure {
my ( $self, $arg ) = @_;
for ( keys %$arg ) {
warn "Unknown configure argument '$_'" if $^W;
}
return $self;
}
# ------------------------------------------------------------------------
sub massage_tree {
my ( $self, $html ) = @_;
return if $html->tag eq 'p'; # sanity
### Before massaging: $html->dump()
$html->simplify_pres();
# Does anything else need doing?
### After massaging: $html->dump()
return;
}
# ------------------------------------------------------------------------
sub format_from_file { return shift->format_file(@_); }
sub format_file {
my ( $self, $filename, @params ) = @_;
$self = $self->new(@params) unless ref $self;
croak "What filename to format from?"
unless ( defined($filename) and length($filename) );
my $tree = $self->_default_tree();
$tree->parse_file($filename);
my $out = $self->format($tree);
$tree->delete;
return $out;
}
# ------------------------------------------------------------------------
# ------------------------------------------------------------------------
sub format_from_string { shift->format_string(@_) }
sub format_string {
my ( $self, $content, @params ) = @_;
$self = $self->new(@params) unless ref $self;
croak "What string to format?" unless defined $content;
my $tree = $self->_default_tree();
$tree->parse($content);
$tree->eof();
undef $content;
my $out = $self->format($tree);
$tree->delete;
return $out;
}
# ------------------------------------------------------------------------
sub _default_tree {
require HTML::TreeBuilder;
my $t = HTML::TreeBuilder->new;
# If nothing else works, try using these parser options:s
#$t->implicit_body_p_tag(1);
#$t->p_strict(1);
return $t;
}
# ------------------------------------------------------------------------
sub format {
my ( $self, $html ) = @_;
croak "Usage: \$formatter->format(\$tree)" unless ( defined($html) and ref($html) and $html->can('tag') );
#### Tree to format: $html->dump
$self->set_version_tag($html);
$self->massage_tree($html);
$self->begin($html);
$html->number_lists();
# Per-iteration scratch:
my ( $node, $start, $depth, $tag, $func );
$html->traverse(
sub {
( $node, $start, $depth ) = @_;
if ( ref $node ) {
$tag = $node->tag;
$func = $tag . '_' . ( $start ? "start" : "end" );
# Use ->can so that we can recover if
# a handler is not defined for the tag.
if ( $self->can($func) ) {
### Calling : (' ' x $depth) . $func
return $self->$func($node);
}
else {
### Skipping: (' ' x $depth) . $func
return 1;
}
}
else {
$self->textflow($node);
}
1;
}
);
$self->end($html);
return join( '', @{ $self->{output} } );
}
# ------------------------------------------------------------------------
sub begin {
my $self = shift;
# Flags
$self->{anchor} = 0;
$self->{underline} = 0;
$self->{bold} = 0;
$self->{italic} = 0;
$self->{center} = 0;
$self->{superscript} = 0;
$self->{subscript} = 0;
$self->{strikethrough} = 0;
$self->{center_stack} = []; # push and pop 'center' states to it
$self->{nobr} = 0;
$self->{'font_size'} = [3]; # last element is current size
$self->{basefont_size} = [3];
$self->{vspace} = undef; # vertical space (dimension)
$self->{output} = [];
}
# ------------------------------------------------------------------------
sub end { }
# ------------------------------------------------------------------------
sub set_version_tag {
my ( $self, $html ) = @_;
if ($html) {
$self->{'version_tag'} = sprintf(
"%s (v%s, using %s v%s%s)",
ref($self), $self->VERSION || '?',
ref($html),
$html->VERSION || '?',
$HTML::Parser::VERSION ? ", and HTML::Parser v$HTML::Parser::VERSION" : ''
);
}
elsif ($HTML::Parser::VERSION) {
$self->{'version_tag'} =
sprintf( "%s (v%s, using %s)", ref($self), $self->VERSION || "?", "HTML::Parser v$HTML::Parser::VERSION", );
}
else {
$self->{'version_tag'} = sprintf( "%s (v%s)", ref($self), $self->VERSION || '?', );
}
}
# ------------------------------------------------------------------------
sub version_tag { shift->{'version_tag'} }
# ------------------------------------------------------------------------
sub html_start { 1; }
sub html_end { }
sub body_start { 1; }
sub body_end { }
sub head_start { 0; }
sub script_start { 0; }
sub style_start { 0; }
sub frameset_start { 0; }
# ------------------------------------------------------------------------
sub header_start {
my ( $self, undef, $node ) = @_;
my $align = $node->attr('align');
if ( defined($align) && lc($align) eq 'center' ) {
$self->{center}++;
}
1;
}
# ------------------------------------------------------------------------
sub header_end {
my ( $self, undef, $node ) = @_;
my $align = $node->attr('align');
if ( defined($align) && lc($align) eq 'center' ) {
$self->{center}--;
}
}
# ------------------------------------------------------------------------
sub h1_start { shift->header_start( 1, @_ ) }
sub h2_start { shift->header_start( 2, @_ ) }
sub h3_start { shift->header_start( 3, @_ ) }
sub h4_start { shift->header_start( 4, @_ ) }
sub h5_start { shift->header_start( 5, @_ ) }
sub h6_start { shift->header_start( 6, @_ ) }
# ------------------------------------------------------------------------
sub h1_end { shift->header_end( 1, @_ ) }
sub h2_end { shift->header_end( 2, @_ ) }
sub h3_end { shift->header_end( 3, @_ ) }
sub h4_end { shift->header_end( 4, @_ ) }
sub h5_end { shift->header_end( 5, @_ ) }
sub h6_end { shift->header_end( 6, @_ ) }
sub br_start { my $self = shift; $self->vspace( 0, 1 ); }
sub hr_start { my $self = shift; $self->vspace(1); 1; }
# ------------------------------------------------------------------------
sub img_start {
my ( $self, $node ) = @_;
my $alt = $node->attr('alt');
$self->out( defined($alt) ? $alt : "[IMAGE]" );
}
# ------------------------------------------------------------------------
sub a_start { shift->{anchor}++; 1; }
sub a_end { shift->{anchor}--; }
sub u_start { shift->{underline}++; 1; }
sub u_end { shift->{underline}--; }
sub b_start { shift->{bold}++; 1; }
sub b_end { shift->{bold}--; }
sub tt_start { shift->{teletype}++; 1; }
sub tt_end { shift->{teletype}--; }
sub i_start { shift->{italic}++; 1; }
sub i_end { shift->{italic}--; }
sub center_start { shift->{center}++; 1; }
sub center_end { shift->{center}--; }
# ------------------------------------------------------------------------
sub div_start { # interesting only for its 'align' attribute
my ( $self, $node ) = @_;
my $align = $node->attr('align');
if ( defined($align) && lc($align) eq 'center' ) {
return $self->center_start;
}
1;
}
# ------------------------------------------------------------------------
sub div_end {
my ( $self, $node ) = @_;
my $align = $node->attr('align');
if ( defined($align) && lc($align) eq 'center' ) {
return $self->center_end;
}
}
# ------------------------------------------------------------------------
sub nobr_start { shift->{nobr}++; 1; }
sub nobr_end { shift->{nobr}--; }
sub wbr_start { 1; }
# ------------------------------------------------------------------------
sub font_start {
my ( $self, $elem ) = @_;
my $size = $elem->attr('size');
return 1 unless ( defined($size) );
if ( $size =~ /^\s*[+\-]/ ) {
my $base = $self->{basefont_size}[-1];
# yes, base it on the most recent one
$size = $base + $size;
}
push @{ $self->{'font_size'} }, $size;
$self->new_font_size($size);
1;
}
# ------------------------------------------------------------------------
sub font_end {
my ( $self, $elem ) = @_;
my $size = $elem->attr('size');
return unless defined $size;
pop @{ $self->{'font_size'} };
$self->restore_font_size( $self->{'font_size'}[-1] );
}
# ------------------------------------------------------------------------
sub big_start {
my $self = $_[0];
push @{ $self->{'font_size'} }, $self->{basefont_size}[-1] + 1; # same as font size="+1"
$self->new_font_size( $self->{'font_size'}[-1] );
1;
}
# ------------------------------------------------------------------------
sub small_start {
my $self = $_[0];
push @{ $self->{'font_size'} }, $self->{basefont_size}[-1] - 1, # same as font size="-1"
;
$self->new_font_size( $self->{'font_size'}[-1] );
1;
}
# ------------------------------------------------------------------------
sub big_end {
my $self = $_[0];
pop @{ $self->{'font_size'} };
$self->restore_font_size( $self->{'font_size'}[-1] );
1;
}
# ------------------------------------------------------------------------
sub small_end {
my $self = $_[0];
pop @{ $self->{'font_size'} };
$self->restore_font_size( $self->{'font_size'}[-1] );
1;
}
# ------------------------------------------------------------------------
sub basefont_start {
my ( $self, $elem ) = @_;
my $size = $elem->attr('size');
return unless defined $size;
push( @{ $self->{basefont_size} }, $size );
1;
}
# ------------------------------------------------------------------------
sub basefont_end {
my ( $self, $elem ) = @_;
my $size = $elem->attr('size');
return unless defined $size;
pop( @{ $self->{basefont_size} } );
}
# ------------------------------------------------------------------------
#
# Override in subclasses, if you like.
#
sub new_font_size { } #my( $self, $font_size_number ) = @_;
sub restore_font_size { } #my( $self, $font_size_number ) = @_;
# ------------------------------------------------------------------------
sub q_start { shift->out(q<">); 1; }
sub q_end { shift->out(q<">); 1; }
sub sup_start { shift->{superscript}++; 1; }
sub sup_end { shift->{superscript}--; 1; }
sub sub_start { shift->{subscript}++; 1; }
sub sub_end { shift->{subscript}--; 1; }
sub strike_start { shift->{strikethrough}++; 1; }
sub strike_end { shift->{strikethrough}--; 1; }
sub s_start { shift->strike_start(@_); }
sub s_end { shift->strike_end(@_); }
sub dfn_start { 1; }
sub dfn_end { 1; }
sub abbr_start { 1; }
sub abbr_end { 1; }
sub acronym_start { 1; }
sub acronym_end { 1; }
sub span_start { 1; }
sub span_end { 1; }
sub ins_start { 1; }
sub ins_end { 1; }
sub del_start { 0; } # Don't render the del'd bits
sub del_end { 0; }
# ------------------------------------------------------------------------
my @Size_magic_numbers = (
0.60, 0.75, 0.89, 1, 1.20, 1.50, 2.00, 3.00
# #0 #1 #2 #3 #4 #5 #6 #7
#________________ - | + _________________________
# -3 -2 -1 0 +1 +2 +3 +4
);
# ------------------------------------------------------------------------
sub scale_font_for {
my ( $self, $reference_size ) = @_;
# Mozilla's source, at
# http://lxr.mozilla.org/seamonkey/source/content/html/style/src/nsStyleUtil.cpp#299
# says:
# static PRInt32 sFontSizeFactors[8] = { 60,75,89,100,120,150,200,300 };
#
# For comparison, Gisle's earlier HTML::FormatPS has:
# | # size 0 1 2 3 4 5 6 7
# | @FontSizes = ( 5, 6, 8, 10, 12, 14, 18, 24, 32);
# ...and gets different sizing via just a scaling factor.
my $size_number = int( defined( $_[2] ) ? $_[2] : $self->{'font_size'}[-1] );
# force the size_number into range:
$size_number =
( $size_number < 0 ) ? 0
: ( $size_number > $#Size_magic_numbers ) ? $#Size_magic_numbers
: int($size_number);
my $result = int( .5 + $reference_size * $Size_magic_numbers[$size_number] );
### Scale Font: sprintf("reference %s, size %s => %s", $reference_size, $size_number, $result);
return $result;
}
# ------------------------------------------------------------------------
# Aliases for logical markup:
sub strong_start { shift->b_start(@_) }
sub strong_end { shift->b_end(@_) }
sub cite_start { shift->i_start(@_) }
sub cite_end { shift->i_end(@_) }
sub em_start { shift->i_start(@_) }
sub em_end { shift->i_end(@_) }
sub code_start { shift->tt_start(@_) }
sub code_end { shift->tt_end(@_) }
sub kbd_start { shift->tt_start(@_) }
sub kbd_end { shift->tt_end(@_) }
sub samp_start { shift->tt_start(@_) }
sub samp_end { shift->tt_end(@_) }
sub var_start { shift->tt_start(@_) }
sub var_end { shift->tt_end(@_) }
# ------------------------------------------------------------------------
sub p_start {
my $self = shift;
#$self->adjust_lm(0); # assert new paragraph
$self->vspace(1);
# assert one line's worth of vertical space at para-start
$self->out('');
1;
}
# ------------------------------------------------------------------------
sub p_end {
shift->vspace(1); # assert one line's worth of vertical space at para-end
}
# ------------------------------------------------------------------------
sub pre_start {
my $self = shift;
$self->{pre}++;
$self->vspace(1); # assert one line's worth of vertical space at pre-start
1;
}
# ------------------------------------------------------------------------
sub pre_end {
my $self = shift;
$self->{pre}--; # assert one line's worth of vertical space at pre-end
$self->vspace(1);
}
# ------------------------------------------------------------------------
sub listing_start { shift->pre_start(@_) }
sub listing_end { shift->pre_end(@_) }
sub xmp_start { shift->pre_start(@_) }
sub xmp_end { shift->pre_end(@_) }
# ------------------------------------------------------------------------
sub blockquote_start {
my $self = shift;
$self->vspace(1); # assert one line's worth of vertical space at blockquote-start
$self->adjust_lm(+2);
$self->adjust_rm(-2);
1;
}
# ------------------------------------------------------------------------
sub blockquote_end {
my $self = shift;
$self->vspace(1); # assert one line's worth of vertical space at blockquote-end
$self->adjust_lm(-2);
$self->adjust_rm(+2);
}
# ------------------------------------------------------------------------
sub address_start {
my $self = shift;
$self->vspace(1); # assert one line's worth of vertical space at address-para-start
$self->i_start(@_);
1;
}
# ------------------------------------------------------------------------
sub address_end {
my $self = shift;
$self->i_end(@_); # assert one line's worth of vertical space at address-para-end
$self->vspace(1);
}
# ------------------------------------------------------------------------
# Handling of list elements
sub ul_start {
my $self = shift;
$self->vspace(1); # assert one line's worth of vertical space at ul-start
$self->adjust_lm(+2);
1;
}
# ------------------------------------------------------------------------
sub ul_end {
my $self = shift;
$self->adjust_lm(-2); # assert one line's worth of vertical space at ul-end
$self->vspace(1);
}
# ------------------------------------------------------------------------
sub li_start {
my $self = shift;
$self->bullet( shift->attr('_bullet') || '' );
$self->adjust_lm(+2);
1;
}
# ------------------------------------------------------------------------
sub bullet { shift->out(@_); }
# ------------------------------------------------------------------------
sub li_end {
my $self = shift;
$self->vspace(1);
$self->adjust_lm(-2);
}
# ------------------------------------------------------------------------
sub menu_start { shift->ul_start(@_) }
sub menu_end { shift->ul_end(@_) }
sub dir_start { shift->ul_start(@_) }
sub dir_end { shift->ul_end(@_) }
# ------------------------------------------------------------------------
sub ol_start {
my $self = shift;
$self->vspace(1);
$self->adjust_lm(+2);
1;
}
# ------------------------------------------------------------------------
sub ol_end {
my $self = shift;
$self->adjust_lm(-2);
$self->vspace(1);
}
# ------------------------------------------------------------------------
sub dl_start {
my $self = shift;
# $self->adjust_lm(+2);
$self->vspace(1); # assert one line's worth of vertical space at dl-start
1;
}
# ------------------------------------------------------------------------
sub dl_end {
my $self = shift;
# $self->adjust_lm(-2);
$self->vspace(1); # assert one line's worth of vertical space at dl-end
}
# ------------------------------------------------------------------------
sub dt_start {
my $self = shift;
$self->vspace(1); # assert one line's worth of vertical space at dt-start
1;
}
# ------------------------------------------------------------------------
sub dt_end { }
# ------------------------------------------------------------------------
sub dd_start {
my $self = shift;
$self->adjust_lm(+6);
$self->vspace(0); # hm, what's that do? nothing?
1;
}
# ------------------------------------------------------------------------
sub dd_end {
my $self = shift;
$self->vspace(1); # assert one line's worth of vertical space at dd-end
$self->adjust_lm(-6);
}
# ------------------------------------------------------------------------
# And now some things that are basically sane fall-throughs for classes
# that don't really handle tables or forms specially...
# Things not formatted at all
sub input_start { 0; }
sub textarea_start { 0; }
sub select_start { 0; }
sub option_start { 0; }
# ------------------------------------------------------------------------
sub td_start {
my $self = shift;
push @{ $self->{'center_stack'} }, $self->{'center'};
$self->{center} = 0;
$self->p_start(@_);
}
# ------------------------------------------------------------------------
sub td_end {
my $self = shift;
$self->{'center'} = pop @{ $self->{'center_stack'} };
$self->p_end(@_);
}
# ------------------------------------------------------------------------
sub th_start {
my $self = shift;
push @{ $self->{'center_stack'} }, $self->{'center'};
$self->{center} = 0;
$self->p_start(@_);
$self->b_start(@_);
}
# ------------------------------------------------------------------------
sub th_end {
my $self = shift;
$self->b_end(@_);
$self->{'center'} = pop @{ $self->{'center_stack'} };
$self->p_end(@_);
}
# But if you wanted to just SKIP tables and forms, you'd do this:
# sub table_start { shift->out('[TABLE NOT SHOWN]'); 0; }
# sub form_start { shift->out('[FORM NOT SHOWN]'); 0; }
# ------------------------------------------------------------------------
sub textflow {
my $self = shift;
if ( $self->{pre} ) {
# Strip one leading and one trailing newline so that a <pre>
# tag can be placed on a line of its own without causing extra
# vertical space as part of the preformatted text.
$_[0] =~ s/\n$//;
$_[0] =~ s/^\n//;
$self->pre_out( $_[0] );
}
elsif ( $self->{blockquote} ) {
$_[0] =~ s/\A\s//;
$self->blockquote_out( $_[0] );
}
else {
for ( split( /(\s+)/, $_[0] ) ) {
next unless length $_;
$self->out($_);
}
}
}
# ------------------------------------------------------------------------
sub vspace {
my ( $self, $min, $add ) = @_;
# This method sets the vspace attribute. When vspace is
# defined, then a new line should be started. If vspace
# is a nonzero value, then that should be taken as the
# number of lines to be skipped before following text
# is written out.
#
# You may think it odd to conflate the two concepts of
# ending this paragraph, and asserting how much space should
# follow; but it happens to work out pretty well.
my $old = $self->{vspace};
if ( defined $old ) {
my $new = $old;
$new += $add || 0;
$new = $min if $new < $min;
$self->{vspace} = $new;
}
else {
$self->{vspace} = $min;
}
### vspace: $self->{vspace}
$old;
}
# ------------------------------------------------------------------------
sub collect { push( @{ shift->{output} }, @_ ); }
# ------------------------------------------------------------------------
sub out { confess "Must be overridden by subclass"; } # Output a word
sub pre_out { confess "Must be overridden by subclass"; }
sub adjust_lm { confess "Must be overridden by subclass"; }
sub adjust_rm { confess "Must be overridden by subclass"; }
# ------------------------------------------------------------------------
1;
__END__
=pod
=for test_synopsis 1;
__END__
=for stopwords formatters CPAN homepage
=head1 NAME
HTML::Formatter - Base class for HTML formatters
=head1 VERSION
version 2.12
=head1 SYNOPSIS
use HTML::FormatSomething;
my $infile = "whatever.html";
my $outfile = "whatever.file";
open OUT, ">$outfile"
or die "Can't write-open $outfile: $!\n";
print OUT HTML::FormatSomething->format_file(
$infile,
'option1' => 'value1',
'option2' => 'value2',
...
);
close(OUT);
=head1 DESCRIPTION
HTML::Formatter is a base class for classes that take HTML and format it to
some output format. When you take an object of such a base class and call
C<$formatter->format( $tree )> with an L<HTML::TreeBuilder> (or
L<HTML::Element>) object, they return the appropriately formatted string for
the input HTML.
HTML formatters are able to format a HTML 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 format() method is called. The format() method takes a HTML::Element
object (usually the HTML::TreeBuilder root object) as parameter.
=head1 METHODS
=head2 new
my $formatter = FormatterClass->new(
option1 => value1, option2 => value2, ...
);
This creates a new formatter object with the given options.
=head2 format_file
=head2 format_from_file
$string = FormatterClass->format_file(
$html_source,
option1 => value1, option2 => value2, ...
);
Return a string consisting of the result of using the given class to format the
given HTML file according to the given (optional) options. Internally it calls
C<< SomeClass->new( ... )->format( ... ) >> on a new HTML::TreeBuilder object
based on the given HTML file.
=head2 format_string
=head2 format_from_string
$string = FormatterClass->format_string(
$html_source,
option1 => value1, option2 => value2, ...
);
Return a string consisting of the result of using the given class to format the
given HTML source according to the given (optional) options. Internally it
calls C<< SomeClass->new( ... )->format( ... ) >> on a new HTML::TreeBuilder
object based on the given source.
=head2 format
my $render_string = $formatter->format( $html_tree_object );
This renders the given HTML object according to the options set for $formatter.
After you've used a particular formatter object to format a particular HTML
tree object, you probably should not use either again.
=head1 SEE ALSO
The three specific formatters:-
=over
=item L<HTML::FormatText>
Format HTML into plain text
=item L<HTML::FormatPS>
Format HTML into postscript
=item L<HTML::FormatRTF>
Format HTML into Rich Text Format
=back
Also the HTML manipulation libraries used - L<HTML::TreeBuilder>,
L<HTML::Element> and L<HTML::Tree>
=head1 INSTALLATION
See perlmodinstall for information and options on installing Perl modules.
=head1 BUGS AND LIMITATIONS
You can make new bug reports, and view existing ones, through the
web interface at L<http://rt.cpan.org/Public/Dist/Display.html?Name=HTML-Format>.
=head1 AVAILABILITY
The project homepage is L<https://metacpan.org/release/HTML-Format>.
The latest version of this module is available from the Comprehensive Perl
Archive Network (CPAN). Visit L<http://www.perl.com/CPAN/> to find a CPAN
site near you, or see L<https://metacpan.org/module/HTML::Format/>.
=head1 AUTHORS
=over 4
=item *
Nigel Metheringham <nigelm@cpan.org>
=item *
Sean M Burke <sburke@cpan.org>
=item *
Gisle Aas <gisle@ActiveState.com>
=back
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2015 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.
=cut
|