xml2rfc 2.40.0

Xml2rfc generates RFCs and IETF drafts from document source in XML according to the IETF xml2rfc v2 and v3 vocabularies.

Introduction

The IETF uses a specific format for the standards and other documents it publishes as RFCs, and for the draft documents which are produced when developing documents for publications. There exists a number of different tools to facilitate the formatting of drafts and RFCs according to the existing rules, and this tool, xml2rfc, is one of them. It takes as input an xml file which contains the text and meta-information about author names etc., and transforms it into suitably formatted output. The input xml file should follow the grammars in RFC7749 (for v2 documents) or RFC7991 (for v3 documents). Note that the grammar for v3 is still being refined, and changes will eventually be captured in the bis draft for 7991. Changes not yet captured can be seen in the xml2rfc source v3.rng.

xml2rfc provides a variety of output formats. See the command line help for a full list of formats. It also provides conversion from v2 to v3, and can run the preptool on its input.

Installation

Installation of the python package is done as usual with ‘pip install xml2rfc’, using appropriate switches and/or sudo.

Installation of support libraries for the PDF-formatter

In order to generate PDFs, xml2rfc uses the WeasyPrint module, which depends on external libaries that must be installed as native packages on your platform, separately from the xml2rfc install.

First, install the Cairo, Pango, and GDK-PixBuf library files on your system. See installation instructions on the WeasyPrint Docs:

https://weasyprint.readthedocs.io/en/stable/install.html

(Python 3 is not needed if your system Python is 2.7, though).

(On some OS X systems with System Integrity Protection active, you may need to create a symlink from your home directory to the library installation directory (often /opt/local/lib):

ln -s /opt/local/lib ~/lib

in order for weasyprint to find the installed cairo and pango libraries. Whether this is needed or not depends on whether you used macports or homebrew to install cairo and pango, and the homebrew / macport version.)

Next, install the pycairo and weasyprint python modules using pip. Depending on your system, you may need to use ‘sudo’ or install in user-specific directories, using the –user switch. On OS X in particular, you may also need to install a newer version of setuptools using –user before weasyprint can be installed. If you install with the –user switch, you may need to also set PYTHONPATH, e.g.,

PYTHONPATH=/Users/henrik/Library/Python/2.7/lib/python/site-packages

for Python 2.7.

The basic pip commands (modify as needed according to the text above) are:

pip install ‘pycairo>=1.18’ ‘weasyprint<=0.42.3’

With these installed and available to xml2rfc, the –pdf switch will be enabled.

For PDF output, you also need to install the Noto font set. Download the full set from https://noto-website-2.storage.googleapis.com/pkgs/Noto-unhinted.zip, and install as appropriate for your platform.

Usage

xml2rfc accepts a single XML document as input and outputs to one or more conversion formats.

Basic Usage: xml2rfc SOURCE [options] FORMATS...

Run xml2rfc --help for a full listing of command-line options.

Changelog

Version 2.40.0 (18 Feb 2020)

• Worked around weasyprint’s failure to honour <ol> type attributes by using the appropriate CSS list-style-type to control the list style. Fixes issue #489.

• Added <br/> to the v3 grammar. Fixes issue #492.

• Fixed an issue where comments inside ascii-art artwork would cause following artwork not to be rendered.

• Fixed an issue where use of .splitlines() instead of .split(’n’) caused unexpected removal of blank lines at the beginning or end of artwork.

• Allowed Latin script content in <organization> without requiring an ascii attribute, to match the treatment of author and contact names. Fixes issue #493

• Added additional error information when text content is found where the schema does not allow it.

• Fixed an issue where trailing whitespace in artwork can trigger bad rendering, by removing whitespace at the end of lines in <artwork> and <sourcecode>. Fixes issue #490

• Changed the plain text URL for the trust license-info in TLP boilerplate to an <eref> also for IAB documents. Fixes issue #456.

• Removed indentation from lists rendered in table cells.

• Fixed an incorrect attribute grouping in the v3 schema

• Fixed two off-by-one errors in the calculation of the length of Updates/Obsoletes lists. Addresses issue #472

Version 2.39.0 (31 Jan 2020)

• Provided a rendering for <xref> with reference targets which are part of a <referencegroup> and don’t have a reference tag.

• Added a –pdf-help command-like option, and tweaked the order of some command-line options in the –help output.

• Added a new filter for pdf-gneration library warnings, to avoid it appearing on every xml2rfc invocation.

• Added a v2v3 converter for dates with non-numeric years.

• Added an error for attempting to insert a missing XInclude namespace prefix when ‘xi’ is already defined as something else.

• Fixed a bug introduced with the refactoring in [3438].

Version 2.38.2 (27 Jan 2020)

• Provided a rendering for <xref> with reference targets which are part of a <referencegroup> and don’t have a reference tag.

• Added a –pdf-help command-line option, and tweaked the order of some command-line options in the –help output.

• Added a new filter for pdf-gneration library warnings, to avoid it appearing on every xml2rfc invocation.

• Added a v2v3 converter for dates with non-numeric years.

• Added an error for attempting to insert a missing XInclude namespace prefix when ‘xi’ is already defined as something else.

• Fixed a bug introduced with the refactoring in [3438].