This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
design:producing-output [2013/08/28 10:25] paul created |
design:producing-output [2013/10/30 09:34] (current) rsewikiadmin |
||
---|---|---|---|
Line 1: | Line 1: | ||
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. | 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. | ||
+ | |||
+ | ====== Pre-production ====== | ||
+ | |||
+ | - Internet drafts are generated with a variety of tools. | ||
+ | - Some of these tools generate XML2RFC input, which is then used to generate text. | ||
+ | - Some of the tools generate text directly. | ||
+ | - When ready to become an RFC, the text version is sent to the RFC Editor, along with either the corresponding XML2RFC input or the corresponding nroff input | ||
====== Current Production ====== | ====== Current Production ====== | ||
- | **//Alice needs to check whether the statements in this section are true.//** | + | |
- | + | - When editing is complete, xml2rfc v2 is used to generate text (unless errors are such that xml2rfc v1 is used instead). | |
- | | + | - The nroff is is edited to fix the placement of page breaks and any remaining quirks. |
- | - When editing is complete, xml2rfc v2 is used to generate nroff. | + | |
- The nroff is used to produce paginated text. | - The nroff is used to produce paginated text. | ||
- The paginated text is used to produce PDF that looks just like the 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. | - Separately, the Tools Team uses the paginated text to produce HTML that looks just like the paginated text but has additional links. | ||
Line 20: | Line 27: | ||
====== Proposed Future Production ====== | ====== Proposed Future Production ====== | ||
- | - If the input to the RFC Editor is XML, the document is edited directly. | + | - A tool (tentatively called "RFCToolv3" |
- | - When editing is complete, | + | - if the I-D is in text format, |
- | - RFCToolv3 uses the HTML to produce unpaginated text. | + | - Tool will need to be able to combine multiple XML files (i.e., images, references) |
- | | + | - 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 |
- | - RFCToolv3 uses the HTML to produce PDF format | + | - When editing is complete, |
- | - RFCToolv3 uses the paginated text to produce PDF format 2, hopefully having live links. | + | - Once approvals are complete, |
- | - RFCToolv3 uses the HTML to produce EPUB. | + | - The RFC Editor |
- | + | ||
- | 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 | + | |
- | are used. | + | |
+ | Note: Authors may run this tool prior to submission in order to gain understanding on what their final RFC is expected to look like (modulo AUTH48 changes). | ||
+ | * creation of an XML file (if submitted file is TXT) | ||
+ | * addition of anchors and tags | ||
+ | * creation of all publication outputs (HTML, TXT, EPUB, PDF) | ||
+ | * make it optional which outputs are produced by authors? |