NAME

ABSTRACT

SYNOPSIS

    use Text::ParagraphDiff;

    # old.txt and new.txt are filenames
    print text_diff('old.txt', 'new.txt');

    # Or pass array references
    print text_diff(\@old, \@new);

    # T-Diff 2 plain strings (a FAQ)
    print text_diff("old", "new", {string=>1});

    # Pass options (see below)
    print text_diff($old, $new, {plain=>1});

    # or use the premade script in bin/:
    # ./tdiff oldfile newfile

DESCRIPTION

The output is in xhtml, for ease of generation, ease of access, and ease of viewing. "Text::ParagraphDiff" also takes advantage of two advanced features of the median: CSS and JavaScript.

CSS is used to cut down on output size and to make the output very pleasing to the eye. JavaScript is used to implement additional functionality: two buttons that can toggle the display of the difference. CSS and JavaScript can be turned off; see the "plain" option below. (Note: CSS & Javascript tested with Mozilla 1.0, Camino 0.7, and IE 5.x)

EXPORT

Additionally, "create_diff", "html_header", and "html_footer" are optionally exported by request (e.g. use "Text::ParagraphDiff qw(create_diff))". "create_diff" is the actual diff itself; "html_header" and "html_footer" should be obvious.

OPTIONS

Options are stored in a hashref, $opt. $opt is an optional last argument to "text_diff", passed like this:

    text_diff($old, $new, { plain => 1,
                            escape => 1,
                            string => 1,
                            minus_first => 1,
                            functionality => 1,
                            style => 'stylesheet_code_here',
                            header => 'header_markup_here',
                            sep => ['<p>','</p>']
                          });

All options are, uh, optional.

Options are:

plain

When set to a true value, "plain" will cause a document to be rendered plainly, with very sparse html that should be valid even through Netscape Navigator 2.0.

string

When set to a true value, "string" will cause the first 2 arguments to be treated as strings, and not files. These strings will be split on the newline character.

escape

When "escape" is set, then input will not be escaped. Useful if you want to include your own markup.

minus_first

By default, when there is a +/- pair, + items appear first by default. However, if "minus_first" is set to a true value, then the order will be reversed.

functionality

When set to a true value, "functionality" will cause the JavaScript toggle buttons to not be shown.

style

When "style" is set, its value will override the default stylesheet. Please see "output_html_header" above for the default stylesheet specifications.

header

When "header" is set, its value will override the default difference header. Please see "output_html_header" above for more details.

sep

When "sep" is set, its value will override the default paragraph separator. "sep" should be a reference to an array of 2 elements; the starting paragraph separator, and the ending separator. The default value is "['<p"',</p>']>.

BUGS

AUTHOR

SEE ALSO