User Tools

Site Tools


design:producing-output

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

Alice needs to check whether the statements in this section are true.

  1. If the input to the RFC Editor is XML, the document is edited directly.
  2. When editing is complete, xml2rfc v2 is used to generate nroff.
  3. The nroff is used to produce paginated text.
  4. The paginated text is used to produce PDF that looks just like the paginated text.
  5. 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

  1. If the input to the RFC Editor is XML, the document is edited directly.
  2. When editing is complete, RFCToolv3 is used to produce HTML that is round-trippable with the XML; this will most likely be done using XSLT processing.
  3. RFCToolv3 uses the HTML to produce unpaginated text.
  4. RFCToolv3 uses the unpaginated text to produce paginated text.
  5. RFCToolv3 uses the HTML to produce PDF format 1 that looks much like the HTML (including having live links), and also has relevant headers and footers.
  6. RFCToolv3 uses the paginated text to produce PDF format 2, hopefully having live links. (Both PDF formats are produced for US Letter and A4 page sizes.)
  7. RFCToolv3 uses the HTML to produce EPUB.

If the input to the RFC Editor is nroff, the RFC Editor first turns it into XML, then the steps above are used.

If the input to the RFC Editor is plain text, the RFC Editor first turns it into XML, then the steps above are used.

design/producing-output.1377710737.txt.gz · Last modified: 2013/08/28 10:25 by paul