Skip to main content

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

Project description

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, or in the documentation xml2rfc produces with its –doc flag.

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

(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/3.6/lib/python/site-packages

for Python 3.6.

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 3.8.0 (25 Jun 2021)

  • Merged in [3961] from jennifer@painless-security.com: Fix indentation error that prevented normalizing ascii-art whitespace. Fixes #403.
  • Merged in [3949] from jennifer@painless-security.com: Insert removeInRFC notice as first child even when <name> tag is absent. Fixes #622.
  • Merged in [3947] from jennifer@painless-security.com: Handle <iref> as child of most of its allowed parent elements. An <aside> parent is still not handled properly. Fixes #620.
  • Merged in [3942] from jennifer@painless-security.com: Refer to un-numbered sections by name rather than number. Fixes #572.
  • Merged in [3939] and [3940] from jennifer@painless-security.com: Create tests-no-network and clear-cache Makefile targets to support network-free testing. Updates to tests/cache and tests/valid so tests pass with and without network. Fixes #561.

Updated manpage.txt and docfiles

Version 3.7.0 (05 Apr 2021)

  • Updated manpage.txt and docfiles
  • Remove mention of Python2.7 from the README. Add pointer to self-generated documentation.
  • Merged in [3922] from jennifer@painless-security.com: Restore xref format for cref target from r3890 (was accidentally reverted in r3910). Fixes #431.
  • Merged in [3924] from jennifer@painless-security.com: Handle iref items starting with special characters when constructing index. Fixes #603.
  • Merged in [3925] from jennifer@painless-security.com: Include the index in the toc and retain index in prepped XML. Fixes #607.
  • Merged in [3926] from jennifer@painless-security.com: Correctly gather irefs by item/subitem. Improve index rendering. Use section numbers for xref text in index. Fixes #418. Fixes #610.
  • Changed the Makefile’s use of bash builtin read to only test for non-zero responses, instead of looking for responses higher than 128. Not all bash, and in particular not the bash available on osx, return error codes higher than 1 for the read builtin.

Version 3.6.0 (17 Mar 2021)

** Add pagination, bugfixes, drops Python 3.5 **

  • Merged in [3899] from jennifer@painless-security.com: Prevent crash when column count varies between table rows. Fixes #512.
  • Merged in [3898] from jennifer@painless-security.com: Cite the abstract as ‘Abstract’ instead of ‘Appendix Abstract’. Fixes #429.
  • Merged in [3893] from jennifer@painless-security.com: Modify selector to include rfc element in yes/no to true/false conversion. Fixes #457.
  • Merged in [3892] from jennifer@painless-security.com: Move conjunctions out of author <span> elements in reference citations. Fixes #575.
  • Merged in [3891] from jennifer@painless-security.com: Remove quotes from <xref format=’title’> in text writer. Fixes #563.
  • Merged in [3890] from jennifer@painless-security.com: Label xref to a cref with the anchor instead of ‘Section X.Y’. Fixes #431.
  • Merged in [3887] and [3889] from jennifer@painless-security.com: Simplify text rendering of super/subscripts. Based on patch submitted by <martin.thomson@gmail.com> and refinement from subsequent list discussion. Fixes #590.
  • moved away test targets for untested versions of python
  • Merged in [3886] from mark@painless-security.com: Remove pilcrows from tables of contents In addition to searching list item descendants for the existence of previously-added pilcrows, the code now also searches the list item ancestors for any node that has the ‘toc’ class to indicate that it is part of a table of contents. If either are found, the pilcrow is not added. Fixes #568.
  • Merged in [3877] and [3878] from henrik@levkowetz.com: Made a –paginate/–pagination switch available, to force pagination for text output.
  • Merged in [3876] from henrik@levkowetz.com: Adjusted li > p margin to fit better with other list spacing, and to not let the <p> margin spill out from inside a <li>. FIxes issue #580.
  • Drop python 35 from tests
  • Updated manpage.txt and docfiles

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for xml2rfc, version 3.9.0
Filename, size File type Python version Upload date Hashes
Filename, size xml2rfc-3.9.0.tar.gz (3.1 MB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page