.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" 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 "SVN::Notify::HTML::ColorDiff 3pm"
.TH SVN::Notify::HTML::ColorDiff 3pm "2018-07-03" "perl v5.26.2" "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"
.IX Header "Name"
SVN::Notify::HTML::ColorDiff \- Subversion activity \s-1HTML\s0 notification with colorized diff
.SH "Synopsis"
.IX Header "Synopsis"
Use \fIsvnnotify\fR in \fIpost-commit\fR:
.PP
.Vb 2
\&  svnnotify \-\-repos\-path "$1" \-\-revision "$2" \e
\&    \-\-to developers@example.com \-\-handler HTML::ColorDiff [options]
.Ve
.PP
Use the class in a custom script:
.PP
.Vb 1
\&  use SVN::Notify::HTML::ColorDiff;
\&
\&  my $notifier = SVN::Notify::HTML::ColorDiff\->new(%params);
\&  $notifier\->prepare;
\&  $notifier\->execute;
.Ve
.SH "Description"
.IX Header "Description"
This subclass of SVN::Notify::HTML sends \s-1HTML\s0 formatted
email messages for Subversion activity, and if the \f(CW\*(C`with_diff\*(C'\fR parameter is
specified (but not \f(CW\*(C`attach_diff\*(C'\fR), then a pretty colorized version of the
diff will be included, rather than the plain text diff output by
SVN::Notify::HTML.
.SH "Usage"
.IX Header "Usage"
To use SVN::Notify::HTML::ColorDiff, simply follow the
instructions in SVN::Notify, but when using \fIsvnnotify\fR,
specify \f(CW\*(C`\-\-handler HTML::ColorDiff\*(C'\fR.
.SH "Instance Interface"
.IX Header "Instance Interface"
.SS "Instance Methods"
.IX Subsection "Instance Methods"
\fIoutput_css\fR
.IX Subsection "output_css"
.PP
.Vb 1
\&  $notifier\->output_css($file_handle);
.Ve
.PP
This method starts outputs the \s-1CSS\s0 for the \s-1HTML\s0 message.
SVN::Notify::HTML::ColorDiff adds extra \s-1CSS\s0 to its output so that it can
nicely style the diff.
.PP
\fIoutput_diff\fR
.IX Subsection "output_diff"
.PP
.Vb 1
\&  $notifier\->output_diff($out_file_handle, $diff_file_handle);
.Ve
.PP
Reads the diff data from \f(CW$diff_file_handle\fR and prints it to
\&\f(CW$out_file_handle\fR for inclusion in the notification message. The diff is
output with nice colorized \s-1HTML\s0 markup. Each line of the diff file is escaped
by \f(CW\*(C`HTML::Entities::encode_entities()\*(C'\fR.
.PP
If there are any \f(CW\*(C`diff\*(C'\fR filters, this method will do no \s-1HTML\s0 formatting, but
redispatch to SVN::Notify::output_diff. See
Writing Output Filters for details on
filters.
.SH "See Also"
.IX Header "See Also"
.IP "SVN::Notify" 4
.IX Item "SVN::Notify"
.PD 0
.IP "SVN::Notify::HTML" 4
.IX Item "SVN::Notify::HTML"
.IP "CVSspam <http://www.badgers-in-foil.co.uk/projects/cvsspam/>" 4
.IX Item "CVSspam <http://www.badgers-in-foil.co.uk/projects/cvsspam/>"
.PD
.SH "To Do"
.IX Header "To Do"
.IP "\(bu" 4
Add inline emphasis just on the text that changed between two lines, like
this: <http://www.badgers\-in\-foil.co.uk/projects/cvsspam/example.html>.
.IP "\(bu" 4
Add links to To Do stuff to the top of the email, as pulled in from the diff.
This might be tricky, since the diff is currently output \fIafter\fR the message
body. Maybe use absolute positioning \s-1CSS\s0?
.SH ""
.IX Header ""
.SH "Author"
.IX Header "Author"
David E. Wheeler <david@justatheory.com>
.SH "Copyright and License"
.IX Header "Copyright and License"
Copyright (c) 2004\-2018 David E. Wheeler. Some Rights Reserved.
.PP
This module is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.