rfc-xmldiff 0.5.4.1

Create a difference on two RFC XML files

This program takes two XML files containing SVG or RFC documents and creates an HTML file which shows the differences between the two documents.

The RFC Editor is in the process of changing the canonical input format of Internet-Draft and RFC documents. Further information on the process can be found on the RFC Editor at the RFC Editor site.

Usage

rfc-xmldiff accepts a pair of XML documents as input and outputs an HTML document.

Basic Usage: rfc-xmldiff [options] SOURCE1 SOURCE2

Options

The following parameters affect how rfc-xmldiff behaves, however none are required.

+=================+=========================+===================================================+ | Short | Long | Description | +=================+=========================+===================================================+ | -C | --clear-cache | purge the cache and exit | | -h | --help | show the help message and exit | | -N | --no-network | don’t use the network to resolve references | | -q | --quiet | don’t print anything | | -r | --raw | don’t use the xml2rfc vocabulary when matching | | -v | --verbose | print extra information | | -V | --version | display the version number and exit | | -X | --no-xinclude | don’t resolve xi:include elements | | -o FILENAME | --out=FILENAME | specify an output filename | | -t FILENAME | --template=FILENAME | specify HTML template filename | | | --resource-url=URL | specify the URL for resources in the template | +=================+=========================+===================================================+

Templates

Two template files are installed with the package:

• single.html - provides just the XML difference between the two files. This is the default template

• base.html - provides three columns containing the left source files, the XML difference and the right source files.

For new template files, the following variables are define:

• title - provides a default window title

• body - contains the XML difference HTML

• leftFile - contains the left source files

• rightFile - contains the right source files

• resource_dir - contains the URL to find the resources. This defaults to the Template directory of the package.

Dependencies

rfc-xmldiff depends on the following packages:

• lxml (>= 4.1.1)

• requests (>= 2.5.0)

• rfctools_common (>= 0.5.3)

• cffi (>= 1.0.0)

Changelog