RSE Wiki Archive

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
RFC Design Team wiki space

===== Introduction =====

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:

  * well-known by many in the authoring community as well as the RFC Editor;
  * has a start on meeting most of the requirements already;
  * is based on a solid mark-up language that is expected to exist for the foreseeable future.

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 [[design:design-team|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.

==== Project Implementation ====
  * [[https://trac.tools.ietf.org/tools/ietfdb/wiki/FormatToolsPlan|High-level code release tracking]]
  * [[design:format-implementation|Format Implementation Steps]]

==== Reading list ====
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**


==== Format Requirements from RFC 6949 ====

  - The content of an RFC must not change, regardless of format, once published.
  - The Canonical format must be persistent and reliable across a large variety of devices, operating systems, and editing tools for the indefinite future.  This means the format must be both readable and editable across commonly used devices, operating systems, and platforms for the foreseeable future.
  - While several Publication formats must be allowed, in order to continue support for the most basic reading and search tools and to provide continuity for the Series, at least one Publication format must be plain text.
  - The boilerplate and overall structure of the RFC must be in accordance with current RFC and Style Guide requirements (see RFC 5741).
  - The documents must be made accessible to people with visual disabilities through such means as including alternative text for images and limiting the use of color. See the W3C's accessibility documents  and the United Nations "Convention on the Rights of Persons with Disabilities" for guidance.  Appropriate authoring tools are highly desirable but focus on the creation of Internet-Drafts, a topic outside the scope of the RFC Editor.
  - The official language of the RFC Series is English.  ASCII is required for all text that must be read to understand or implement the technology described in the RFC.  Use of non- ASCII characters, expressed in a standard Unicode Encoding Form (such as UTF-8), must receive explicit approval from the document stream manager and will be allowed after the rules for the common use cases are defined in the Style Guide.
  - The Submission and Publication formats need to permit extending the set of metadata tags, for the addition of labeled metadata.  A predefined set of metadata tags must be created to make use of metadata tags consistent for the life of the Series.
  - Graphics may include ASCII art and a more complex form to be defined, such as SVG line art [SVG].  Color and grayscale will not be accepted.  RFCs must correctly display in monochromatic black-and-white to allow for monochrome displays, black-and-white printing, and support for visual disabilities.
  - The Canonical format must be renderable into self-contained Publication formats in order to be easily downloaded and read offline.
  - Fixed-width fonts and non-reflowable text are required for ASCII-art sections, source code examples, and other places where strict alignment is required.
  - At least one Publication format must support readable print to standard paper sizes.
  - The Canonical format should be structured to enable easy program identification and parsing of code or specifications, such as MIB modules and ABNF.
RSE Wiki Archive

User Tools

Site Tools

Page Tools
