Handling Long Lines in Inclusions in Internet-Drafts and RFCs
draft-ietf-netmod-artwork-folding-02

The information below is for an old version of the document
Document Type Active Internet-Draft (netmod WG)
Last updated 2019-05-12 (latest revision 2019-04-06)
Replaces draft-kwatsen-netmod-artwork-folding
Stream IETF
Intended RFC status (None)
Formats pdf htmlized bibtex
Reviews
Stream WG state In WG Last Call
Document shepherd Lou Berger
IESG IESG state I-D Exists
Consensus Boilerplate Unknown
Telechat date
Responsible AD (None)
Send notices to Lou Berger <lberger@labn.net>
NETMOD Working Group                                           K. Watsen
Internet-Draft                                           Watsen Networks
Intended status: Best Current Practice                         A. Farrel
Expires: October 8, 2019                              Old Dog Consulting
                                                                   Q. Wu
                                                     Huawei Technologies
                                                           April 6, 2019

     Handling Long Lines in Inclusions in Internet-Drafts and RFCs
                  draft-ietf-netmod-artwork-folding-02

Abstract

   This document defines a simple and yet time-proven strategy for
   handling long lines in inclusions in internet drafts and RFCs using a
   backslash ('\') character to indicate where line-folding has
   occurred.  The strategy works on any text-based content, but is
   primarily intended for a structured sequence of lines rather than for
   two-dimensional imagery.  The approach produces consistent results,
   regardless of the content, that is both self-documenting and enables
   automated reconstitution of the original content.

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 https://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 October 8, 2019.

Copyright Notice

   Copyright (c) 2019 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
   (https://trustee.ietf.org/license-info) in effect on the date of

Watsen, et al.           Expires October 8, 2019                [Page 1]
Internet-Draft      Handling Long Lines in Inclusions         April 2019

   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
   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  . . . . . . . . . . . . . . . . . . . . . . . .   3
   2.  Applicability Statement . . . . . . . . . . . . . . . . . . .   3
   3.  Requirements Language . . . . . . . . . . . . . . . . . . . .   4
   4.  Goals . . . . . . . . . . . . . . . . . . . . . . . . . . . .   4
     4.1.  Automated Folding of Long Lines in Text Content . . . . .   4
     4.2.  Automated Reconstitution of the Original Text Content . .   4
   5.  Limitations . . . . . . . . . . . . . . . . . . . . . . . . .   5
     5.1.  Not Recommended for Graphical Artwork . . . . . . . . . .   5
     5.2.  Doesn't Work as Well as Format-Specific Options . . . . .   5
   6.  Two Folding Strategies  . . . . . . . . . . . . . . . . . . .   5
     6.1.  Comparison  . . . . . . . . . . . . . . . . . . . . . . .   6
     6.2.  Recommendation  . . . . . . . . . . . . . . . . . . . . .   6
   7.  The Single Backslash Strategy ('\') . . . . . . . . . . . . .   6
     7.1.  Folded Structure  . . . . . . . . . . . . . . . . . . . .   6
       7.1.1.  Header  . . . . . . . . . . . . . . . . . . . . . . .   6
       7.1.2.  Body  . . . . . . . . . . . . . . . . . . . . . . . .   7
     7.2.  Algorithm . . . . . . . . . . . . . . . . . . . . . . . .   7
       7.2.1.  Folding . . . . . . . . . . . . . . . . . . . . . . .   7
       7.2.2.  Unfolding . . . . . . . . . . . . . . . . . . . . . .   8
   8.  The Double Backslash Strategy ('\\')  . . . . . . . . . . . .   9
     8.1.  Folded Structure  . . . . . . . . . . . . . . . . . . . .   9
       8.1.1.  Header  . . . . . . . . . . . . . . . . . . . . . . .   9
       8.1.2.  Body  . . . . . . . . . . . . . . . . . . . . . . . .   9
     8.2.  Algorithm . . . . . . . . . . . . . . . . . . . . . . . .  10
       8.2.1.  Folding . . . . . . . . . . . . . . . . . . . . . . .  10
       8.2.2.  Unfolding . . . . . . . . . . . . . . . . . . . . . .  11
   9.  Examples  . . . . . . . . . . . . . . . . . . . . . . . . . .  12
     9.1.  Example Showing Boundary Conditions . . . . . . . . . . .  12
       9.1.1.  Using '\' . . . . . . . . . . . . . . . . . . . . . .  12
       9.1.2.  Using '\\'  . . . . . . . . . . . . . . . . . . . . .  12
     9.2.  Example Showing Multiple Wraps of a Single Line . . . . .  13
Show full document text