The cl-html-diff Reference Manual

Table of Contents

The cl-html-diff Reference Manual

This is the cl-html-diff Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Nov 04 12:18:14 2020 GMT+0.

1 Systems

The main system appears first, followed by any subsystem dependency.

1.1 cl-html-diff

Maintainer

John Wiseman <jjwiseman@yahoo.com>

Author

John Wiseman <jjwiseman@yahoo.com>

License

MIT

Version

0.1

Dependency

cl-difflib

Source

cl-html-diff.asd (file)

Components

• html-diff.lisp (file)
• license.txt (file)

2 Files

Files are sorted by type and then listed depth-first from the systems components trees.

2.1 Lisp

2.1.1 cl-html-diff.asd

Location

cl-html-diff.asd

Systems

cl-html-diff (system)

2.1.2 cl-html-diff/html-diff.lisp

Parent

cl-html-diff (system)

Location

html-diff.lisp

Packages

html-diff

Exported Definitions

• html-diff (function)
• html-diff-to-stream (function)

Internal Definitions

• html-diff-2-col (function)
• html-get-opcodes (function)
• join (function)
• join-to-stream (function)
• tag-p (function)
• tokenize-html (function)
• whitespace-p (function)

2.2 Static

2.2.1 cl-html-diff/LICENSE.txt

Parent

cl-html-diff (system)

Location

LICENSE.txt

3 Packages

Packages are listed by definition order.

3.1 html-diff

Source

html-diff.lisp (file)

Use List

• difflib
• common-lisp

Exported Definitions

• html-diff (function)
• html-diff-to-stream (function)

Internal Definitions

• html-diff-2-col (function)
• html-get-opcodes (function)
• join (function)
• join-to-stream (function)
• tag-p (function)
• tokenize-html (function)
• whitespace-p (function)

4 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

4.1 Exported definitions

4.1.1 Functions

Function: html-diff A B &key INSERT-CLASS DELETE-CLASS REPLACE-CLASS

Package

html-diff

Source

html-diff.lisp (file)

Function: html-diff-to-stream STREAM A B &key INSERT-CLASS DELETE-CLASS REPLACE-CLASS

Takes two strings containing HTML and returns a human-readable HTML diff. Uses <ins>, <del> and some css classes.

Package

html-diff

Source

html-diff.lisp (file)

4.2 Internal definitions

4.2.1 Functions

Function: html-diff-2-col A B &key INSERT-CLASS DELETE-CLASS REPLACE-CLASS

Package

html-diff

Source

html-diff.lisp (file)

Function: html-get-opcodes A B

Package

html-diff

Source

html-diff.lisp (file)

Function: join SEQ

Concatenates HTML tokens back into a single string.

Package

html-diff

Source

html-diff.lisp (file)

Function: join-to-stream STREAM SEQ

Concatenates HTML tokens back into a single string.

Package

html-diff

Source

html-diff.lisp (file)

Function: tag-p X

Returns true if a string has the format of an HTML/XML open tag (<p>, <applet>, <woo>, etc.)

Package

html-diff

Source

html-diff.lisp (file)

Function: tokenize-html X

Package

html-diff

Source

html-diff.lisp (file)

Function: whitespace-p CHAR

Package

html-diff

Source

html-diff.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types