draft-iab-rfc-plaintext-01.txt   draft-iab-rfc-plaintext-02.txt 
Internet Architecture Board H. Flanagan Internet Architecture Board H. Flanagan
Internet-Draft RFC Editor Internet-Draft RFC Editor
Intended status: Informational January 19, 2016 Intended status: Informational February 10, 2016
Expires: July 22, 2016 Expires: August 13, 2016
Requirements for Plain-Text RFCs Requirements for Plain-Text RFCs
draft-iab-rfc-plaintext-01 draft-iab-rfc-plaintext-02
Abstract Abstract
In 2013, after a great deal of community discussion, the decision was In 2013, after a great deal of community discussion, the decision was
made to shift from the plain-text, ASCII-only canonical format for made to shift from the plain-text, ASCII-only canonical format for
RFCs to XML as the canonical format with more human-readable formats RFCs to XML as the canonical format with more human-readable formats
rendered from that XML. The high-level requirements that informed rendered from that XML. The high-level requirements that informed
this change were defined in RFC6949, "RFC Series Format Requirements this change were defined in RFC6949, "RFC Series Format Requirements
and Future Development." Plain text remains an important format for and Future Development." Plain text remains an important format for
many in the IETF community, and will be one of the publication many in the IETF community, and will be one of the publication
skipping to change at page 1, line 46 skipping to change at page 1, line 46
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/. Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on July 22, 2016. This Internet-Draft will expire on August 13, 2016.
Copyright Notice Copyright Notice
Copyright (c) 2016 IETF Trust and the persons identified as the Copyright (c) 2016 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
skipping to change at page 2, line 36 skipping to change at page 2, line 36
4.1. Headers and Footers . . . . . . . . . . . . . . . . . . . 5 4.1. Headers and Footers . . . . . . . . . . . . . . . . . . . 5
4.2. Table of Contents . . . . . . . . . . . . . . . . . . . . 5 4.2. Table of Contents . . . . . . . . . . . . . . . . . . . . 5
4.3. Line Width . . . . . . . . . . . . . . . . . . . . . . . 5 4.3. Line Width . . . . . . . . . . . . . . . . . . . . . . . 5
4.4. Line Spacing . . . . . . . . . . . . . . . . . . . . . . 5 4.4. Line Spacing . . . . . . . . . . . . . . . . . . . . . . 5
4.5. Hyphenation . . . . . . . . . . . . . . . . . . . . . . . 6 4.5. Hyphenation . . . . . . . . . . . . . . . . . . . . . . . 6
5. Elements from the xml2rfc v3 vocabulary . . . . . . . . . . . 6 5. Elements from the xml2rfc v3 vocabulary . . . . . . . . . . . 6
6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 6 6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 6
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 6 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 6
8. Security Considerations . . . . . . . . . . . . . . . . . . . 6 8. Security Considerations . . . . . . . . . . . . . . . . . . . 6
9. Change Log for the Draft . . . . . . . . . . . . . . . . . . 6 9. Change Log for the Draft . . . . . . . . . . . . . . . . . . 6
9.1. draft-iab-rfc-plantext-00 to -01 . . . . . . . . . . . . 6 9.1. draft-iab-rfc-plantext-01 to -02 . . . . . . . . . . . . 6
9.2. draft-flanagan-plaintext-09 to draft-iab-rfc-plaintext-00 7 9.2. draft-iab-rfc-plantext-00 to -01 . . . . . . . . . . . . 6
9.3. -08 to -09 . . . . . . . . . . . . . . . . . . . . . . . 7 9.3. draft-flanagan-plaintext-09 to draft-iab-rfc-plaintext-00 7
9.4. -07 to -08 . . . . . . . . . . . . . . . . . . . . . . . 7 9.4. -08 to -09 . . . . . . . . . . . . . . . . . . . . . . . 7
9.5. -06 to -07 . . . . . . . . . . . . . . . . . . . . . . . 7 9.5. -07 to -08 . . . . . . . . . . . . . . . . . . . . . . . 7
9.6. -05 to -06 . . . . . . . . . . . . . . . . . . . . . . . 7 9.6. -06 to -07 . . . . . . . . . . . . . . . . . . . . . . . 7
9.7. -04 to -05 . . . . . . . . . . . . . . . . . . . . . . . 7 9.7. -05 to -06 . . . . . . . . . . . . . . . . . . . . . . . 7
9.8. -03 to -04 . . . . . . . . . . . . . . . . . . . . . . . 7 9.8. -04 to -05 . . . . . . . . . . . . . . . . . . . . . . . 7
9.9. -02 to -03 . . . . . . . . . . . . . . . . . . . . . . . 7 9.9. -03 to -04 . . . . . . . . . . . . . . . . . . . . . . . 7
9.10. -01 to -02 . . . . . . . . . . . . . . . . . . . . . . . 8 9.10. -02 to -03 . . . . . . . . . . . . . . . . . . . . . . . 8
9.11. -01 to -02 . . . . . . . . . . . . . . . . . . . . . . . 8
10. References . . . . . . . . . . . . . . . . . . . . . . . . . 8 10. References . . . . . . . . . . . . . . . . . . . . . . . . . 8
10.1. Normative References . . . . . . . . . . . . . . . . . . 8 10.1. Normative References . . . . . . . . . . . . . . . . . . 8
10.2. Informative References . . . . . . . . . . . . . . . . . 9 10.2. Informative References . . . . . . . . . . . . . . . . . 9
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 9 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 9
1. Introduction 1. Introduction
In 2013, after a great deal of community discussion, the decision was In 2013, after a great deal of community discussion, the decision was
made to shift from the plain-text, ASCII-only canonical format for made to shift from the plain-text, ASCII-only canonical format for
RFCs to XML as the canonical format [XML-ANNOUNCE]. The high-level RFCs to XML as the canonical format [XML-ANNOUNCE]. The high-level
skipping to change at page 4, line 13 skipping to change at page 4, line 13
printing, etc. printing, etc.
o There is an extensive tool chain in existence among the community o There is an extensive tool chain in existence among the community
to work with plain-text documents. Similar functionality may be to work with plain-text documents. Similar functionality may be
possible with other publication formats, but the workflow that possible with other publication formats, but the workflow that
uses the existing tool chain should be supported as much as is uses the existing tool chain should be supported as much as is
considered practical. considered practical.
Where practical, the original guidance for the structure of a plain- Where practical, the original guidance for the structure of a plain-
text RFC has been kept, such as with line lengths, lines per page, text RFC has been kept, such as with line lengths, lines per page,
etc. [INS2AUTH] Other publication formats, such as HTMl and PDF, etc. [INS2AUTH] Other publication formats, such as HTML and PDF,
will include additional features that will not be present in the will include additional features that will not be present in the
plain text (e.g., paragraph numbering, typographical emphasis. plain text (e.g., paragraph numbering, typographical emphasis.
The details described in this document are expected to change based The details described in this document are expected to change based
on experience gained in implementing the RFC production center's on experience gained in implementing the RFC production center's
toolset. Revised documents will be published capturing those changes toolset. Revised documents will be published capturing those changes
as the toolset is completed. Other implementers must not expect as the toolset is completed. Other implementers must not expect
those changes to remain backwards-compatible with the details those changes to remain backwards-compatible with the details
described this document. described this document.
skipping to change at page 6, line 42 skipping to change at page 6, line 42
8. Security Considerations 8. Security Considerations
The requirements of the plaintext format involve no significant The requirements of the plaintext format involve no significant
security considerations. As part of the larger format project, security considerations. As part of the larger format project,
however, unintended changes to the text as a result of the however, unintended changes to the text as a result of the
transformation from the base XML file could in turn corrupt a transformation from the base XML file could in turn corrupt a
standard, practice or critical piece of information about a protocol. standard, practice or critical piece of information about a protocol.
9. Change Log for the Draft 9. Change Log for the Draft
9.1. draft-iab-rfc-plantext-00 to -01 9.1. draft-iab-rfc-plantext-01 to -02
nits fixed
9.2. draft-iab-rfc-plantext-00 to -01
Introduction: removed sentence restricting this format to RFCs only; Introduction: removed sentence restricting this format to RFCs only;
clarified that plaintext will be based on existing practice (except clarified that plaintext will be based on existing practice (except
where otherwise called out) where otherwise called out)
Elements from the xml2rfc v3 vocabulary: clarified what xml2rfcv3 Elements from the xml2rfc v3 vocabulary: clarified what xml2rfcv3
tags will render the front and back matter of a document. tags will render the front and back matter of a document.
9.2. draft-flanagan-plaintext-09 to draft-iab-rfc-plaintext-00 9.3. draft-flanagan-plaintext-09 to draft-iab-rfc-plaintext-00
Figures and Artwork, Character Encoding: included additional detail Figures and Artwork, Character Encoding: included additional detail
regarding how these items will be flagged within the XML. regarding how these items will be flagged within the XML.
9.3. -08 to -09 9.4. -08 to -09
Security Considerations: added text Security Considerations: added text
9.4. -07 to -08 9.5. -07 to -08
Change log: forgot to update the change log for the -06 to -07 Change log: forgot to update the change log for the -06 to -07
changes. changes.
9.5. -06 to -07 9.6. -06 to -07
Introduction: updated to state that this document does not require Introduction: updated to state that this document does not require
backwards compatibility. backwards compatibility.
9.6. -05 to -06 9.7. -05 to -06
Abstract: Changed "cut over" to "transition" Abstract: Changed "cut over" to "transition"
Elements from xml2rfc v3: emphasized that doc structure is guided by Elements from xml2rfc v3: emphasized that doc structure is guided by
the RFC Style Guide the RFC Style Guide
9.7. -04 to -05 9.8. -04 to -05
Abstract and Introduction: Revised for better readability; clarified Abstract and Introduction: Revised for better readability; clarified
the definition and implications of the term "plain-text" the definition and implications of the term "plain-text"
General Page Format Layout: Added explicit EOL detail and added some General Page Format Layout: Added explicit EOL detail and added some
clarification regarding pagination clarification regarding pagination
Elements from the xml2rfc v3 vocabulary: section added Elements from the xml2rfc v3 vocabulary: section added
9.8. -03 to -04 9.9. -03 to -04
Change Log for the Draft: forgot to complete the change log between Change Log for the Draft: forgot to complete the change log between
the various revisions of the draft the various revisions of the draft
9.9. -02 to -03 9.10. -02 to -03
Abstract: expanded Abstract: expanded
Introduction: adjusted language of assumptions Introduction: adjusted language of assumptions
Figures and Artwork: adjusted to indicate where to go in case Figures and Artwork: adjusted to indicate where to go in case
information for the images conflicts between different formats information for the images conflicts between different formats
General Page Layout: switched back to producing one basic paginated General Page Layout: switched back to producing one basic paginated
format, with an expectation of instructions and/or a script to create format, with an expectation of instructions and/or a script to create
local, unpaginated copies for individual use. local, unpaginated copies for individual use.
9.10. -01 to -02 9.11. -01 to -02
Introduction: added pointer to original page layout information Introduction: added pointer to original page layout information
Character encoding: clarified language around encoding and use of Character encoding: clarified language around encoding and use of
BOMs BOMs
General Page Format Layout: removed increased line width requirement; General Page Format Layout: removed increased line width requirement;
added sections on Line Width, Line Spacing, and Hyphenation (pulled added sections on Line Width, Line Spacing, and Hyphenation (pulled
from 2223-bis from 2223-bis
 End of changes. 17 change blocks. 
26 lines changed or deleted 31 lines changed or added

This html diff was produced by rfcdiff 1.42. The latest version is available from http://tools.ietf.org/tools/rfcdiff/