.\" 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
.\" ========================================================================
.\"
.IX Title "Text::Diff::FormattedHTML 3pm"
.TH Text::Diff::FormattedHTML 3pm "2021-10-14" "perl v5.32.1" "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"
Text::Diff::FormattedHTML \- Generate a colorful HTML diff of strings/files.
.SH "VERSION"
.IX Header "VERSION"
Version 0.08
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Text::Diff::FormattedHTML;
\&
\&    my $output = diff_files($file1, $file2);
\&
\&    # for strings
\&
\&    my $output = diff_strings( { vertical => 1 }, $file1, $file2);
\&
\&
\&    # as you might want some CSS:
\&    open OUT, ">diff.html";
\&    print OUT "<style type=\*(Aqtext/css\*(Aq>\en", diff_css(), "</style>\en";
\&    print OUT diff_files(\*(AqfileA\*(Aq, \*(AqfileB\*(Aq);
\&    close OUT;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Presents in a (nice?) \s-1HTML\s0 table the difference between two files or strings.
Inspired on GitHub diff view.
.SH "SUBROUTINES"
.IX Header "SUBROUTINES"
.SS "diff_files"
.IX Subsection "diff_files"
.Vb 1
\&   my $html = diff_files("filename1", "filename2");
.Ve
.PP
\&\f(CW\*(C`diff_files\*(C'\fR and \f(CW\*(C`diff_strings\*(C'\fR support a first optional argument
(an hash reference) where options can be set.
.PP
Valid options are:
.ie n .IP """vertical""" 4
.el .IP "\f(CWvertical\fR" 4
.IX Item "vertical"
Can be set to a true value, for a more compact table.
.ie n .IP """limit_onesided""" 4
.el .IP "\f(CWlimit_onesided\fR" 4
.IX Item "limit_onesided"
Makes tables look nicer when there is a side with too many new lines.
.SS "diff_strings"
.IX Subsection "diff_strings"
.Vb 1
\&   my $html = diff_strings("string1", "string2");
.Ve
.PP
Compare strings. First split by newline, and then treat them as file
content (see function above).
.SS "diff_css"
.IX Subsection "diff_css"
.Vb 1
\&   my $css = diff_css;
.Ve
.PP
Return the default css. You are invited to override it.
.SH "AUTHOR"
.IX Header "AUTHOR"
Alberto Simoes, \f(CW\*(C`<ambs at cpan.org>\*(C'\fR
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to
\&\f(CW\*(C`bug\-text\-diff\-formattedhtml at rt.cpan.org\*(C'\fR, or through the web
interface at
<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Text\-Diff\-FormattedHTML>.
I will be notified, and then you'll automatically be notified of
progress on your bug as I make changes.
.SH "SUPPORT"
.IX Header "SUPPORT"
You can find documentation for this module with the perldoc command.
.PP
.Vb 1
\&    perldoc Text::Diff::FormattedHTML
.Ve
.PP
You can also look for information at:
.IP "\(bu" 4
\&\s-1RT: CPAN\s0's request tracker (report bugs here)
.Sp
<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Text\-Diff\-FormattedHTML>
.IP "\(bu" 4
AnnoCPAN: Annotated \s-1CPAN\s0 documentation
.Sp
<http://annocpan.org/dist/Text\-Diff\-FormattedHTML>
.IP "\(bu" 4
\&\s-1CPAN\s0 Ratings
.Sp
<http://cpanratings.perl.org/d/Text\-Diff\-FormattedHTML>
.IP "\(bu" 4
Search \s-1CPAN\s0
.Sp
<http://search.cpan.org/dist/Text\-Diff\-FormattedHTML/>
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright 2011 Alberto Simoes.
.PP
This program is free software; you can redistribute it and/or modify it
under the terms of either: the \s-1GNU\s0 General Public License as published
by the Free Software Foundation; or the Artistic License.
.PP
See http://dev.perl.org/licenses/ for more information.