This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
design:producing-output [2013/09/04 13:24] paul Removed the format list |
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 ====== | ||
- | - If the input to the RFC Editor | + | - If the input to the RFC Editor |
- When editing is complete, xml2rfc v2 is used to generate text (unless errors are such that xml2rfc v1 is used instead). | - 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. | - The nroff is is edited to fix the placement of page breaks and any remaining quirks. | ||
Line 20: | Line 27: | ||
====== Proposed Future Production ====== | ====== Proposed Future Production ====== | ||
- | - A tool (tentatively called " | + | - A tool (tentatively called " |
+ | - if the I-D is in text format, then an initial step of creating an XML file is necessary | ||
+ | - 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 it into XML using tools and (probably) hand-editing. | - 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, | - When editing is complete, | ||
Line 26: | Line 35: | ||
- The RFC Editor publishes the XML and all of the other formats. | - The RFC Editor publishes the XML and all of the other formats. | ||
+ | |||
+ | 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? |