This is an old revision of the document!
This page describes how RFC output is produced in the the current system and proposes a method for it to be produced in the future.
Current Production
If the input to the
RFC Editor is XML, the document is edited directly.
When editing is complete, xml2rfc v2 is used to generate text (unless errors are such that xml2rfc v1 is used instead). AUTH48 state is initiated using the text output. Once approvals are complete, xml2rfc v2/v1 is used to generate nroff.
The nroff is is edited to fix the placement of page breaks and any remaining quirks.
The nroff is used to produce paginated text.
The paginated text is used to produce PDF that looks just like the paginated text.
The
RFC Editor publishes the text and PDF files.
Separately, the Tools Team uses the paginated text to produce
HTML that looks just like the paginated text but has additional links.
If the input to the RFC Editor is nroff, the nroff is edited directly. When editing is complete, it
is then used to produce paginated text, and the rest of the outputs are created using the same
process as above.
If the input to the RFC Editor is plain text, the RFC Editor first turns it into nroff, then the steps above
are used.
Proposed Future Production
A tool (tentatively called “RFCToolv3”) is used to convert XML to other formats.
If the input to the
RFC Editor is XML, the document is edited directly. If the input is a different format, the
RFC Editor first converts it into XML using tools and (probably) hand-editing.
When editing is complete, AUTH48 state is initiated. The
RFC Editor and the authors interact, and the interactions are reflected in the XML.
Once approvals are complete, the
RFC Editor finalizes the XML and uses RFCToolv3 to create all the non-normative formats. The formats are:
HTML that is round-trippable with the XML; this will most likely be done using XSLT processing
unpaginated text
paginated text (with headers, footers, and page break characters)
PDF format 1 that looks much like how the
HTML would look if printed, including having live links, text formatting (bold/italics, differing sizes), all art, and relevant headers/footers.
PDF format 2, hopefully having live links but not having text formatting or SVG art. (Both PDF formats are produced for US Letter and A4 page sizes.)
EPUB
The
RFC Editor publishes the XML and all of the other formats.