.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .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. | will give a .\" real vertical bar. \*(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-|\(bv\*(Tr .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" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" 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 "Text::Diff::HTML 3" .TH Text::Diff::HTML 3 "2008-01-14" "perl v5.8.8" "User Contributed Perl Documentation" .SH "Name" .IX Header "Name" Text::Diff::HTML \- \s-1XHTML\s0 format for Text::Diff::Unified .SH "Synopsis" .IX Header "Synopsis" .Vb 1 \& use Text::Diff; .Ve .PP .Vb 6 \& my $diff = diff "file1.txt", "file2.txt", { STYLE => 'Text::Diff::HTML' }; \& my $diff = diff \e$string1, \e$string2, { STYLE => 'Text::Diff::HTML' }; \& my $diff = diff \e*FH1, \e*FH2, { STYLE => 'Text::Diff::HTML' }; \& my $diff = diff \e&reader1, \e&reader2, { STYLE => 'Text::Diff::HTML' }; \& my $diff = diff \e@records1, \e@records2, { STYLE => 'Text::Diff::HTML' }; \& my $diff = diff \e@records1, "file.txt", { STYLE => 'Text::Diff::HTML' }; .Ve .SH "Description" .IX Header "Description" This class subclasses Text::Diff::Unified, a formatting class provided by the Text::Diff module, to add \s-1XHTML\s0 markup to the unified diff format. For details on the interface of the \f(CW\*(C`diff()\*(C'\fR function, see the Text::Diff documentation. .PP In the \s-1XHTML\s0 formatted by this module, the contents of the diff returned by \&\f(CW\*(C`diff()\*(C'\fR are wrapped in a \f(CW\*(C`
\*(C'\fR element, as is each hunk of the diff. Within each hunk, all content is properly \s-1HTML\s0 encoded using HTML::Entities, and the various sections of the diff are marked up with the appropriate \s-1XHTML\s0 elements. The elements used are as follows: .ie n .IP "* ""
""" 4 .el .IP "* \f(CW
\fR" 4 .IX Item "
" This element contains the entire contents of the diff \*(L"file\*(R" returned by \&\f(CW\*(C`diff()\*(C'\fR. All of the following elements are subsumed by this one. .RS 4 .ie n .IP "* """"" 4 .el .IP "* \f(CW\fR" 4 .IX Item "" The header section for the files being \f(CW\*(C`diff\*(C'\fRed, usually something like: .Sp .Vb 2 \& --- in.txt Thu Sep 1 12:51:03 2005 \& +++ out.txt Thu Sep 1 12:52:12 2005 .Ve .Sp This element immediately follows the opening \*(L"file\*(R" \f(CW\*(C`
\*(C'\fR element. .ie n .IP "* ""
""" 4 .el .IP "* \f(CW
\fR" 4 .IX Item "
" This element contains a single diff \*(L"hunk\*(R". Each hunk may contain the following \f(CW\*(C`\*(C'\fR elements: .RS 4 .ie n .IP "* """"" 4 .el .IP "* \f(CW\fR" 4 .IX Item "" Header for a diff hunk. The hunk header is usually something like: .Sp .Vb 1 \& @@ -1,5 +1,7 @@ .Ve .Sp This element immediately follows the opening \*(L"hunk\*(R" \f(CW\*(C`
\*(C'\fR element. .ie n .IP "* """"" 4 .el .IP "* \f(CW\fR" 4 .IX Item "" Context around the important part of a \f(CW\*(C`diff\*(C'\fR hunk. These are contents that have \fInot\fR changed between the files being \f(CW\*(C`diff\*(C'\fRed. .ie n .IP "* """"" 4 .el .IP "* \f(CW\fR" 4 .IX Item "" Inserted content, each line starting with \f(CW\*(C`+\*(C'\fR. .ie n .IP "* """"" 4 .el .IP "* \f(CW\fR" 4 .IX Item "" Deleted content, each line starting with \f(CW\*(C`\-\*(C'\fR. .ie n .IP "* """"" 4 .el .IP "* \f(CW\fR" 4 .IX Item "" The footer section of a hunk; contains no contents. .RE .RS 4 .RE .ie n .IP "* """"" 4 .el .IP "* \f(CW\fR" 4 .IX Item "" The footer section of a file; contains no contents. .RE .RS 4 .RE .PP You may do whatever you like with these elements and classes; I highly recommend that you style them using \s-1CSS\s0. You'll find an example \s-1CSS\s0 file in the \fIeg\fR directory in the Text-Diff-HTML distribution. You will also likely want to wrap the output of your diff a \f(CW\*(C`
\*(C'\fR element.
.SH "See Also"
.IX Header "See Also"
.IP "Text::Diff" 4
.IX Item "Text::Diff"
.PD 0
.IP "Algorithm::Diff" 4
.IX Item "Algorithm::Diff"
.PD
.SH "Bugs"
.IX Header "Bugs"
Please send bug reports to .
.SH "Author"
.IX Header "Author"
David Wheeler 
.SH "Copyright and License"
.IX Header "Copyright and License"
Copyright (c) 2005 Kineticode, Inc. All Rights Reserved.
.PP
This module is free software; you can redistribute it and/or modify it under the
same terms as Perl itself.