RFC Design Team wiki space
During IETF 86, the IAB formally approved the publication of “RFC Format Requirements and Future Development” (RFC 6949). That RFC outlines the requirements gathered from the communities of interest regarding the Canonical format for the RFC Series. With those requirements in hand, the next step is to explore how those requirements might be implemented and verify what is possible and reasonable for the Series going forward.
The direction we are exploring is one where the Canonical format - the format that is authoritative for content of an RFC - is XML using the xml2rfc DTD. From that format, four Publication formats will be rendered: Text, HTML, PDF, and EPUB. We are focusing on the xml2rfc DTD as something most likely to meet the requirements as defined in a reasonable time frame and budget because xml2rfc is:
Authors may continue to submit XML or text files when their I-Ds are approved for publication.
By allowing for multiple Publication formats, readers can choose a format that works best for their circumstances. The Text and PDF will be extremely basic and support the widest array of tools. The HTML will allow more features and be readable by modern browsers.
The RFC Format Design Team (July 2013 - December 2016), discussed the more detailed requirements for the XML Canonical format as well as the requirements of the different Publication formats and their associated character encoding. The results of that discussion, including documentation on items discussed but decided against as requirements, are documented in this wiki.
The RFC Format is a large project that has required several documents to capture the requirements found in each aspect of the work. The documents depend on each other, and are moving through the community review and publication process as a set to help keep those relationships intact. Several documents require understanding a separate document for full comprehension of the material.
Below is the suggested reading order for the drafts that describe the new RFC format requirements. The design team has done a great job in pulling all fo this together, and many members of the community have reviewed these in parts and offered targeted feedback. Please take this time to review the drafts as a compendium, and then review the Statements of Work that describe the programming effort that will depend on these drafts as their requirements.
1. The big picture
[RFC7990] Flanagan, H., “RFC Format Framework”, RFC 7990, DOI 10.17487/RFC7990, December 2016, http://www.rfc-editor.org/info/rfc7990.
2. The underlying vocabulary
[RFC7991] Hoffman, P., “The ‘xml2rfc’ Version 3 Vocabulary”, RFC 7991, DOI 10.17487/RFC7991, December 2016, http://www.rfc-editor.org/info/rfc7991.
3. The outputs
[RFC7992] Hildebrand, J. and P. Hoffman, “HTML Format for RFCs”, RFC 7992, DOI 10.17487/RFC7992, December 2016, http://www.rfc-editor.org/info/rfc7992.
[RFC7993] Flanagan, H. “Cascading Style Sheets (CSS) Requirements for RFCs”, RFC 7993, DOI 10.17487/RFC7993, December 2016, http://www.rfc-editor.org/info/rfc7993.
[RFC7994] Flanagan, H., “Requirements for Plain-Text RFCs”, RFC 7994, DOI 10.17487/RFC7994, December 2016, http://www.rfc-editor.org/info/rfc7994.
[RFC7995] Hansen, T., Masinter, L., and M. Hardy, “PDF Format for RFCs”, RFC 7995, DOI 10.17487/RFC7995, December 2016, http://www.rfc-editor.org/info/rfc7995.
[RFC7996] Brownlee, N., “SVG Drawings for RFCs: SVG 1.2 RFC”, RFC 7996, DOI 10.17487/RFC7996, December 2016, http://www.rfc-editor.org/info/rfc7996.
4. Generalized requirements
[RFC7997] Flanagan, H., “The Use of Non-ASCII Characters in RFCs”, RFC 7997, DOI 10.17487/RFC7997, December 2016, http://www.rfc-editor.org/info/rfc7997.
5. Workflow and tools
[RFC7998] Hildebrand, J. and P. Hoffman, “‘xml2rfc’ Version 3 Preparation Tool Description”, RFC 7998, DOI 10.17487/RFC7998, December 2016, http://www.rfc-editor.org/info/rfc7998.
Hoffman, P. and T. Hansen, “Examples of the ‘XML2RFC’ Version 2 and 3 Vocabularies”, Work in Progress, draft-hoffman-rfcexamples-04, May 2015. Not to be published as an RFC