draft-iab-rfc-plaintext-02.txt   draft-iab-rfc-plaintext-03.txt 
Internet Architecture Board H. Flanagan Internet Architecture Board H. Flanagan
Internet-Draft RFC Editor Internet-Draft RFC Editor
Intended status: Informational February 10, 2016 Intended status: Informational May 16, 2016
Expires: August 13, 2016 Expires: November 17, 2016
Requirements for Plain-Text RFCs Requirements for Plain-Text RFCs
draft-iab-rfc-plaintext-02 draft-iab-rfc-plaintext-03
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 August 13, 2016. This Internet-Draft will expire on November 17, 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 30 skipping to change at page 2, line 30
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
2. Character Encoding . . . . . . . . . . . . . . . . . . . . . 4 2. Character Encoding . . . . . . . . . . . . . . . . . . . . . 4
3. Figures and Artwork . . . . . . . . . . . . . . . . . . . . . 4 3. Figures and Artwork . . . . . . . . . . . . . . . . . . . . . 4
4. General Page Format Layout . . . . . . . . . . . . . . . . . 5 4. General Page Format Layout . . . . . . . . . . . . . . . . . 5
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 . . . . . . . . . . . . . . . . . . . . . . . 5
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-01 to -02 . . . . . . . . . . . . 6 9.1. draft-iab-rfc-plaintext-02 to -03 . . . . . . . . . . . . 6
9.2. draft-iab-rfc-plantext-00 to -01 . . . . . . . . . . . . 6 9.2. draft-iab-rfc-plantext-01 to -02 . . . . . . . . . . . . 6
9.3. draft-flanagan-plaintext-09 to draft-iab-rfc-plaintext-00 7 9.3. draft-iab-rfc-plaintext-00 to -01 . . . . . . . . . . . . 6
9.4. -08 to -09 . . . . . . . . . . . . . . . . . . . . . . . 7 9.4. draft-flanagan-plaintext-09 to draft-iab-rfc-plaintext-00 7
9.5. -07 to -08 . . . . . . . . . . . . . . . . . . . . . . . 7 9.5. -08 to -09 . . . . . . . . . . . . . . . . . . . . . . . 7
9.6. -06 to -07 . . . . . . . . . . . . . . . . . . . . . . . 7 9.6. -07 to -08 . . . . . . . . . . . . . . . . . . . . . . . 7
9.7. -05 to -06 . . . . . . . . . . . . . . . . . . . . . . . 7 9.7. -06 to -07 . . . . . . . . . . . . . . . . . . . . . . . 7
9.8. -04 to -05 . . . . . . . . . . . . . . . . . . . . . . . 7 9.8. -05 to -06 . . . . . . . . . . . . . . . . . . . . . . . 7
9.9. -03 to -04 . . . . . . . . . . . . . . . . . . . . . . . 7 9.9. -04 to -05 . . . . . . . . . . . . . . . . . . . . . . . 7
9.10. -02 to -03 . . . . . . . . . . . . . . . . . . . . . . . 8 9.10. -03 to -04 . . . . . . . . . . . . . . . . . . . . . . . 7
9.11. -01 to -02 . . . . . . . . . . . . . . . . . . . . . . . 8 9.11. -02 to -03 . . . . . . . . . . . . . . . . . . . . . . . 7
9.12. -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 3, line 29 skipping to change at page 3, line 29
that consists only of a sequence of code points from a given that consists only of a sequence of code points from a given
standard, with no other formatting or structural information. Plain standard, with no other formatting or structural information. Plain
text interchange is commonly used between computer systems that do text interchange is commonly used between computer systems that do
not share higher-level protocols." [UNICODE-GLOSSARY] In other not share higher-level protocols." [UNICODE-GLOSSARY] In other
words, plain-text files cannot include embedded character formatting words, plain-text files cannot include embedded character formatting
or style information. The actual character encoding, however, is not or style information. The actual character encoding, however, is not
limited to any particular sequence of code points. limited to any particular sequence of code points.
A plain-text output for RFCs will continue to be required for the A plain-text output for RFCs will continue to be required for the
foreseeable future. The process of converting XML2RFC version 2 foreseeable future. The process of converting XML2RFC version 2
(xml2rfc v2) into text documents is well understood (xml2rfc v2) into text documents is well understood [RFC7749]. We
[I-D.iab-xml2rfcv2]. We plan to rely on the practice to date to plan to rely on the practice to date to inform the requirements for
inform the requirements for converting XML2RFC version 3 (xml2rfc v3) converting XML2RFC version 3 (xml2rfc v3) to text [I-D.iab-xml2rfc].
to text [I-D.iab-xml2rfc]. This document calls out those This document calls out those requirements that are changed from v2
requirements that are changed from v2 or otherwise deserve special or otherwise deserve special attention, such as the requirements
attention, such as the requirements around character encoding may be around character encoding may be used, changes in the page layout,
used, changes in the page layout, changes in handling figures, changes in handling figures, artwork, and pagination. For more
artwork, and pagination. For more details on general style, see "The details on general style, see "The RFC Style Guide." [RFC7322]
RFC Style Guide." [RFC7322]
The following assumptions drive the changes in the plain-text output The following assumptions drive the changes in the plain-text output
for RFCs: for RFCs:
o The existing tools used by the RFC Editor and many members of the o The existing tools used by the RFC Editor and many members of the
author community to create the text file are complicated to change author community to create the text file are complicated to change
and support; manual manipulation is often required for the final and support; manual manipulation is often required for the final
output. In particular, handling page breaks and associated widows output. In particular, handling page breaks and associated widows
and orphans for paginated output is tricky [WIDOWS]. and orphans for paginated output is tricky [WIDOWS].
skipping to change at page 4, line 15 skipping to change at page 4, line 12
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.
2. Character Encoding 2. Character Encoding
skipping to change at page 4, line 42 skipping to change at page 4, line 39
equivalent will be rendered within the plain-text as per the guidance equivalent will be rendered within the plain-text as per the guidance
in "The Use of Non-ASCII Characters in RFCs" [I-D.iab-rfc-nonascii]. in "The Use of Non-ASCII Characters in RFCs" [I-D.iab-rfc-nonascii].
Please view the PDF version of that draft. Please view the PDF version of that draft.
The plain-text file will include a byte order mark (BOM) to provide The plain-text file will include a byte order mark (BOM) to provide
text reader software with in-band information about the character text reader software with in-band information about the character
encoding scheme used. encoding scheme used.
3. Figures and Artwork 3. Figures and Artwork
Artwork is defined as anything marked by the XML >artwork< element Artwork, such as network diagrams or performance graphs, must be
(see Section 2.5 of "The 'XML2RFC' version 3 Vocabulary" tagged by the XML <artwork> element (see Section 2.5 of "The
[I-D.iab-xml2rfc]. Only the 'type=ascii-art' will be rendered within 'XML2RFC' version 3 Vocabulary" [I-D.iab-xml2rfc]. Where this
the plain-text format. This marks figures drawn with ASCII artwork is comprised of an ASCII art diagram, it must be tagged as
characters. 'type=ascii-art'. The plain-text format will only include ASCII art.
If the canonical format includes figures or artwork other than ASCII- If the canonical format includes figures or artwork other than ASCII-
art, then the plain-text output must include a pointer to the art, then the plain-text output must include a pointer to the
relevant figure in the HTML version of the RFC to allow readers to relevant figure in the HTML version of the RFC to allow readers to
see the relevant artwork. see the relevant artwork.
Authors who wish to include ASCII-art for the plain-text file and SVG Authors who wish to include ASCII-art for the plain-text file and SVG
art for the other outputs may do so, but they should be aware of the art for the other outputs may do so, but they should be aware of the
potential for confusion to individuals reading the RFC with two potential for confusion to individuals reading the RFC with two
unique diagrams describing the same content. If there is conflicting unique diagrams describing the same content. If there is conflicting
information between the publication formats, please review the XML information between the publication formats, please review the XML
skipping to change at page 6, line 15 skipping to change at page 6, line 10
4.5. Hyphenation 4.5. Hyphenation
Hyphenated words (e.g., "Internet-Draft"), should not be split across Hyphenated words (e.g., "Internet-Draft"), should not be split across
successive lines. successive lines.
5. Elements from the xml2rfc v3 vocabulary 5. Elements from the xml2rfc v3 vocabulary
The plain-text formatter uses the relevant tags from the xml2rfcv3 The plain-text formatter uses the relevant tags from the xml2rfcv3
source file to build a document conforming to the layout and source file to build a document conforming to the layout and
structure described by the full RFC Style Guide (including the structure described by the full RFC Style Guide (including the
updates in the web portion of the Style Guide). [STYLEWEB] In updates in the web portion of the Style Guide). [STYLEWEB]
particular, the formatter will use the "submissionType",
"seriesInfo", "author", "address", "title", "reference",
"referencegroup", and "references" to build the front and back matter
of the document.
6. Acknowledgements 6. Acknowledgements
This draft owes a great deal of thanks to the efforts of the RFC This draft owes a great deal of thanks to the efforts of the RFC
Format Design Team: Nevil Brownlee, Tony Hansen, Joe Hildebrand, Paul Format Design Team: Nevil Brownlee, Tony Hansen, Joe Hildebrand, Paul
Hoffman, Ted Lemon, Julian Reschke, Adam Roach, Alice Russo, Robert Hoffman, Ted Lemon, Julian Reschke, Adam Roach, Alice Russo, Robert
Sparks, and David Thaler. Sparks, and David Thaler.
7. IANA Considerations 7. IANA Considerations
skipping to change at page 6, line 42 skipping to change at page 6, line 33
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-01 to -02 9.1. draft-iab-rfc-plaintext-02 to -03
Figures and Artwork: clarified the state specifically around ASCII
art
Elements from the xml2rfc v3: removed confusing sentence that called
out particular elements for creation of front/back matter
9.2. draft-iab-rfc-plantext-01 to -02
nits fixed nits fixed
9.2. draft-iab-rfc-plantext-00 to -01 9.3. draft-iab-rfc-plaintext-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.3. draft-flanagan-plaintext-09 to draft-iab-rfc-plaintext-00 9.4. 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.4. -08 to -09 9.5. -08 to -09
Security Considerations: added text Security Considerations: added text
9.5. -07 to -08 9.6. -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.6. -06 to -07 9.7. -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.7. -05 to -06 9.8. -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.8. -04 to -05 9.9. -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.9. -03 to -04 9.10. -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.10. -02 to -03 9.11. -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.11. -01 to -02 9.12. -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
10. References 10. References
10.1. Normative References 10.1. Normative References
[I-D.iab-rfc-nonascii] [I-D.iab-rfc-nonascii]
Flanagan, H., "The Use of Non-ASCII Characters in RFCs", Flanagan, H., "The Use of Non-ASCII Characters in RFCs",
draft-iab-rfc-nonascii-00 (work in progress), January draft-iab-rfc-nonascii-02 (work in progress), April 2016.
2016.
[I-D.iab-xml2rfc] [I-D.iab-xml2rfc]
Hoffman, P., "The "xml2rfc" version 3 Vocabulary", draft- Hoffman, P., "The "xml2rfc" version 3 Vocabulary", draft-
iab-xml2rfc-02 (work in progress), January 2016. iab-xml2rfc-03 (work in progress), February 2016.
[I-D.iab-xml2rfcv2]
Reschke, J., "The 'XML2RFC' version 2 Vocabulary", draft-
iab-xml2rfcv2-02 (work in progress), September 2015.
[RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO [RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO
10646", STD 63, RFC 3629, DOI 10.17487/RFC3629, November 10646", STD 63, RFC 3629, DOI 10.17487/RFC3629, November
2003, <http://www.rfc-editor.org/info/rfc3629>. 2003, <http://www.rfc-editor.org/info/rfc3629>.
[RFC5741] Daigle, L., Ed., Kolkman, O., Ed., and IAB, "RFC Streams, [RFC5741] Daigle, L., Ed., Kolkman, O., Ed., and IAB, "RFC Streams,
Headers, and Boilerplates", RFC 5741, Headers, and Boilerplates", RFC 5741,
DOI 10.17487/RFC5741, December 2009, DOI 10.17487/RFC5741, December 2009,
<http://www.rfc-editor.org/info/rfc5741>. <http://www.rfc-editor.org/info/rfc5741>.
[RFC6949] Flanagan, H. and N. Brownlee, "RFC Series Format [RFC6949] Flanagan, H. and N. Brownlee, "RFC Series Format
Requirements and Future Development", RFC 6949, Requirements and Future Development", RFC 6949,
DOI 10.17487/RFC6949, May 2013, DOI 10.17487/RFC6949, May 2013,
<http://www.rfc-editor.org/info/rfc6949>. <http://www.rfc-editor.org/info/rfc6949>.
[RFC7322] Flanagan, H. and S. Ginoza, "RFC Style Guide", RFC 7322, [RFC7322] Flanagan, H. and S. Ginoza, "RFC Style Guide", RFC 7322,
DOI 10.17487/RFC7322, September 2014, DOI 10.17487/RFC7322, September 2014,
<http://www.rfc-editor.org/info/rfc7322>. <http://www.rfc-editor.org/info/rfc7322>.
[RFC7749] Reschke, J., "The "xml2rfc" Version 2 Vocabulary",
RFC 7749, DOI 10.17487/RFC7749, February 2016,
<http://www.rfc-editor.org/info/rfc7749>.
10.2. Informative References 10.2. Informative References
[INS2AUTH] [INS2AUTH]
RFC Editor, "Instructions to Request for Comments (RFC) RFC Editor, "Instructions to Request for Comments (RFC)
Authors", August 2004, <http://www.rfc-editor.org/rfc- Authors", August 2004, <http://www.rfc-editor.org/rfc-
editor/instructions2authors.txt>. editor/instructions2authors.txt>.
[STYLEWEB] [STYLEWEB]
RFC Editor, "Web Portion of the Style Guide", May 2015, RFC Editor, "Web Portion of the Style Guide", May 2015,
<http://www.rfc-editor.org/styleguide/part2/>. <http://www.rfc-editor.org/styleguide/part2/>.
 End of changes. 25 change blocks. 
56 lines changed or deleted 58 lines changed or added

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