Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

html::rewriteattributes::resources(3pm) [debian man page]

HTML::RewriteAttributes::Resources(3pm) 		User Contributed Perl Documentation		   HTML::RewriteAttributes::Resources(3pm)

NAME

       HTML::RewriteAttributes::Resources - concise resource-link rewriting

SYNOPSIS

	   # writing some HTML email I see..
	   $html = HTML::RewriteAttributes::Resources->rewrite($html, sub {
	       my $uri = shift;
	       my $content = render_template($uri);
	       my $cid = generate_cid_from($content);
	       $mime->attach($cid => content);
	       return "cid:$cid";
	   });

	   # need to inline CSS too?
	   $html = HTML::RewriteAttributes::Resources->rewrite($html, sub {
	       # see above
	   },
	   inline_css => sub {
	       my $uri = shift;
	       return render_template($uri);
	   });

	   # need to inline CSS and follow @imports?
	   $html = HTML::RewriteAttributes::Resources->rewrite($html, sub {
	       # see above
	   },
	   inline_css => sub {
	       # see above
	   }, inline_imports => 1);

DESCRIPTION

       "HTML::RewriteAttributes::Resources" is a special case of HTML::RewriteAttributes for rewriting links to resources. This is to facilitate
       generating, for example, HTML email in an extensible way.

       We don't care about how to fetch resources and attach them to the MIME object; that's your job. But you don't have to care about how to
       rewrite the HTML.

METHODS

   "new"
       You don't need to call "new" explicitly - it's done in "rewrite". It takes no arguments.

   "rewrite" HTML, callback[, args] -> HTML
       See the documentation of HTML::RewriteAttributes.

       The callback receives as arguments the resource URI (the attribute value), then, in a hash, "tag" and "attr".

       Inlining CSS

       "rewrite" can automatically inline CSS for you.

       Passing "inline_css" will invoke that callback to inline "style" tags. The callback receives as its argument the URI to a CSS file, and
       expects as a return value the contents of that file, so that it may be inlined. Returning "undef" prevents any sort of inlining.

       Passing "inline_imports" (a boolean) will look at any inline CSS and call the "inline_css" callback to inline that import.

       This keeps track of what CSS has already been inlined, and won't inline a particular CSS file more than once (to prevent import loops).

SEE ALSO

       HTML::RewriteAttributes, HTML::Parser, Email::MIME::CreateHTML

AUTHOR

       Shawn M Moore, "<sartak@bestpractical.com>"

LICENSE

       Copyright 2008-2010 Best Practical Solutions, LLC.  HTML::RewriteAttributes::Resources is distributed under the same terms as Perl itself.

perl v5.10.1							    2010-11-18				   HTML::RewriteAttributes::Resources(3pm)

Check Out this Related Man Page

HTML::Filter(3pm)					User Contributed Perl Documentation					 HTML::Filter(3pm)

NAME

       HTML::Filter - Filter HTML text through the parser

NOTE

       This module is deprecated. The "HTML::Parser" now provides the functionally of "HTML::Filter" much more efficiently with the the "default"
       handler.

SYNOPSIS

	require HTML::Filter;
	$p = HTML::Filter->new->parse_file("index.html");

DESCRIPTION

       "HTML::Filter" is an HTML parser that by default prints the original text of each HTML element (a slow version of cat(1) basically).  The
       callback methods may be overridden to modify the filtering for some HTML elements and you can override output() method which is called to
       print the HTML text.

       "HTML::Filter" is a subclass of "HTML::Parser". This means that the document should be given to the parser by calling the $p->parse() or
       $p->parse_file() methods.

EXAMPLES

       The first example is a filter that will remove all comments from an HTML file.  This is achieved by simply overriding the comment method to
       do nothing.

	 package CommentStripper;
	 require HTML::Filter;
	 @ISA=qw(HTML::Filter);
	 sub comment { }  # ignore comments

       The second example shows a filter that will remove any <TABLE>s found in the HTML file.	We specialize the start() and end() methods to
       count table tags and then make output not happen when inside a table.

	 package TableStripper;
	 require HTML::Filter;
	 @ISA=qw(HTML::Filter);
	 sub start
	 {
	    my $self = shift;
	    $self->{table_seen}++ if $_[0] eq "table";
	    $self->SUPER::start(@_);
	 }

	 sub end
	 {
	    my $self = shift;
	    $self->SUPER::end(@_);
	    $self->{table_seen}-- if $_[0] eq "table";
	 }

	 sub output
	 {
	     my $self = shift;
	     unless ($self->{table_seen}) {
		 $self->SUPER::output(@_);
	     }
	 }

       If you want to collect the parsed text internally you might want to do something like this:

	 package FilterIntoString;
	 require HTML::Filter;
	 @ISA=qw(HTML::Filter);
	 sub output { push(@{$_[0]->{fhtml}}, $_[1]) }
	 sub filtered_html { join("", @{$_[0]->{fhtml}}) }

SEE ALSO

       HTML::Parser

COPYRIGHT

       Copyright 1997-1999 Gisle Aas.

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

perl v5.14.2							    2008-04-04							 HTML::Filter(3pm)
Man Page