.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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
.\" ========================================================================
.\"
.IX Title "HTML::RewriteAttributes::Resources 3pm"
.TH HTML::RewriteAttributes::Resources 3pm "2022-12-10" "perl v5.36.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::RewriteAttributes::Resources \- concise resource\-link rewriting
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 8
\&    # 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);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`HTML::RewriteAttributes::Resources\*(C'\fR is a special case of
HTML::RewriteAttributes for rewriting links to resources. This is to
facilitate generating, for example, \s-1HTML\s0 email in an extensible way.
.PP
We don't care about how to fetch resources and attach them to the \s-1MIME\s0 object;
that's your job. But you don't have to care about how to rewrite the \s-1HTML.\s0
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """new"""
.el .SS "\f(CWnew\fP"
.IX Subsection "new"
You don't need to call \f(CW\*(C`new\*(C'\fR explicitly \- it's done in \*(L"rewrite\*(R". It takes
no arguments.
.ie n .SS """rewrite"" \s-1HTML,\s0 callback[, args] \-> \s-1HTML\s0"
.el .SS "\f(CWrewrite\fP \s-1HTML,\s0 callback[, args] \-> \s-1HTML\s0"
.IX Subsection "rewrite HTML, callback[, args] -> HTML"
See the documentation of HTML::RewriteAttributes.
.PP
The callback receives as arguments the resource \s-1URI\s0 (the attribute value), then, in a hash, \f(CW\*(C`tag\*(C'\fR and \f(CW\*(C`attr\*(C'\fR.
.PP
\fIInlining \s-1CSS\s0\fR
.IX Subsection "Inlining CSS"
.PP
\&\f(CW\*(C`rewrite\*(C'\fR can automatically inline \s-1CSS\s0 for you.
.PP
Passing \f(CW\*(C`inline_css\*(C'\fR will invoke that callback to inline \f(CW\*(C`style\*(C'\fR tags. The
callback receives as its argument the \s-1URI\s0 to a \s-1CSS\s0 file, and expects as a
return value the contents of that file, so that it may be inlined. Returning
\&\f(CW\*(C`undef\*(C'\fR prevents any sort of inlining.
.PP
Passing \f(CW\*(C`inline_imports\*(C'\fR (a boolean) will look at any inline \s-1CSS\s0 and call
the \f(CW\*(C`inline_css\*(C'\fR callback to inline that import.
.PP
This keeps track of what \s-1CSS\s0 has already been inlined, and won't inline a
particular \s-1CSS\s0 file more than once (to prevent import loops).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
HTML::RewriteAttributes, HTML::Parser, Email::MIME::CreateHTML
.SH "AUTHOR"
.IX Header "AUTHOR"
Shawn M Moore, \f(CW\*(C`<sartak@bestpractical.com>\*(C'\fR
.SH "LICENSE"
.IX Header "LICENSE"
Copyright 2008\-2010 Best Practical Solutions, \s-1LLC.\s0
HTML::RewriteAttributes::Resources is distributed under the same terms as Perl itself.