Requirements for Plain Text RFCs
draft-flanagan-plaintext-01

The information below is for an old version of the document
Document Type Active Internet-Draft (individual)
Last updated 2014-07-03
Replaced by rfc7994, draft-iab-rfc-plaintext
Stream (None)
Intended RFC status (None)
Formats pdf htmlized bibtex
Stream Stream state (No stream defined)
Consensus Boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
Network Working Group                                        H. Flanagan
Internet-Draft                                                RFC Editor
Intended status: Informational                              July 3, 2014
Expires: January 4, 2015

                    Requirements for Plain Text RFCs
                      draft-flanagan-plaintext-01

Abstract

   This draft documents the change in requirements and layout for the
   plain-text RFC publication format.

Editorial Note (To be removed by the RFC Editor)

   Discussion of this draft takes place on the rfc-interest mailing list
   (rfc-interest@rfc-editor.org), which has its home page at
   https://www.rfc-editor.org/mailman/listinfo/rfc-interest.

Status of This Memo

   This Internet-Draft is submitted in full conformance with the
   provisions of BCP 78 and BCP 79.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF).  Note that other groups may also distribute
   working documents as Internet-Drafts.  The list of current Internet-
   Drafts is at http://datatracker.ietf.org/drafts/current/.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

   This Internet-Draft will expire on January 4, 2015.

Copyright Notice

   Copyright (c) 2014 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents
   (http://trustee.ietf.org/license-info) in effect on the date of
   publication of this document.  Please review these documents
   carefully, as they describe your rights and restrictions with respect
   to this document.  Code Components extracted from this document must

Flanagan                 Expires January 4, 2015                [Page 1]
Internet-Draft              Abbreviated Title                  July 2014

   include Simplified BSD License text as described in Section 4.e of
   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Character Encoding  . . . . . . . . . . . . . . . . . . . . .   3
   3.  Figures and Artwork . . . . . . . . . . . . . . . . . . . . .   3
   4.  Page Layout . . . . . . . . . . . . . . . . . . . . . . . . .   3
     4.1.  Headers and Footers . . . . . . . . . . . . . . . . . . .   4
     4.2.  Table of Contents . . . . . . . . . . . . . . . . . . . .   4
   5.  Acknowledgements  . . . . . . . . . . . . . . . . . . . . . .   4
   6.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   4
   7.  Security Considerations . . . . . . . . . . . . . . . . . . .   4
   8.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   4
     8.1.  Normative References  . . . . . . . . . . . . . . . . . .   4
     8.2.  Informative References  . . . . . . . . . . . . . . . . .   5
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .   5

1.  Introduction

   In 2013, after a great deal of community discussion, the decision was
   made to shift from the plain text, ASCII-only canonical format to XML
   [XML-ANNOUNCE].  The high-level requirements for the format of RFCs
   were defined in RFC Series Format Requirements and Future Development
   [RFC6949].  Several different publication formats will be rendered
   from that canonical XML, including HTML, PDF, TXT, and EPUB.

   The Unicode Consortium defines 'plain text' as "Computer-encoded text
   that consists only of a sequence of code points from a given
   standard, with no other formatting or structural information.  Plain
   text interchange is commonly used between computer systems that do
   not share higher-level protocols." [unicode-glossary]

   While a plain text output for RFCs will continue to be required for
   the foreseeable future, the details of what that means for RFCs in
   terms of which character encoding may be used, what the page layout
   will look like, how to handle figures and artwork, and pagination are
   documented in this draft.

   The following assumptions drive the changes in the plain text output
   for RFCs:

   o  The existing tools to create the text file are extremely
      sensitive; manual manipulation is required in the final output.
      In particular, handling page breaks for text is tricky.

Flanagan                 Expires January 4, 2015                [Page 2]
Internet-Draft              Abbreviated Title                  July 2014

   o  Additional publication formats--for example: PDF, HTML-- will be
      available that will offer features such as markup, pretty
      printing, etc.

   o  There is an extensive tool chain in existence among the community
Show full document text