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

The information below is for an old version of the document
Document Type Active Internet-Draft (netmod WG)
Last updated 2019-03-10 (latest revision 2018-11-05)
Replaces draft-kwatsen-netmod-artwork-folding
Stream IETF
Intended RFC status (None)
Formats pdf htmlized bibtex
Reviews
Stream WG state WG Document
Document shepherd No shepherd assigned
IESG IESG state I-D Exists
Consensus Boilerplate Unknown
Telechat date
Responsible AD (None)
Send notices to (None)
NETMOD Working Group                                           K. Watsen
Internet-Draft                                           Watsen Networks
Intended status: Best Current Practice                             Q. Wu
Expires: September 11, 2019                          Huawei Technologies
                                                               A. Farrel
                                                      Old Dog Consulting
                                                               B. Claise
                                                     Cisco Systems, Inc.
                                                          March 10, 2019

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

Abstract

   This document introduces a simple and yet time-proven strategy for
   handling long lines in inclusions in drafts using a backslash ('\')
   character where line-folding has occurred.  The strategy works on any
   text-based content, but is primarily intended for a structured
   sequence of lines, such as would be referenced by the <sourcecode>
   element defined in Section 2.48 of RFC 7991, rather than for two-
   dimensional imagery, such as would be referenced by the <artwork>
   element defined in Section 2.5 of RFC 7991.  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 September 11, 2019.

Watsen, et al.         Expires September 11, 2019               [Page 1]
Internet-Draft      Handling Long Lines in Inclusions         March 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
   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 . . . . . . . . . . . . . . . . . . . . . . . . .   4
     5.1.  Not Recommended for Graphical Artwork . . . . . . . . . .   5
     5.2.  Doesn't Work as Well as Format-Specific Options . . . . .   5
   6.  Folded Structure  . . . . . . . . . . . . . . . . . . . . . .   5
     6.1.  Header  . . . . . . . . . . . . . . . . . . . . . . . . .   6
     6.2.  Body  . . . . . . . . . . . . . . . . . . . . . . . . . .   6
   7.  Algorithm . . . . . . . . . . . . . . . . . . . . . . . . . .   6
     7.1.  Automated Folding . . . . . . . . . . . . . . . . . . . .   6
       7.1.1.  Manual Folding  . . . . . . . . . . . . . . . . . . .   7
     7.2.  Automated Unfolding . . . . . . . . . . . . . . . . . . .   8
   8.  Examples  . . . . . . . . . . . . . . . . . . . . . . . . . .   8
     8.1.  Simple Example Showing Boundary Conditions  . . . . . . .   9
     8.2.  Example Showing Multiple Wraps of a Single Line . . . . .   9
     8.3.  Example With Native Backslash . . . . . . . . . . . . . .  10
     8.4.  Example With Native Whitespace  . . . . . . . . . . . . .  10
     8.5.  Example of Manual Wrapping  . . . . . . . . . . . . . . .  10
   9.  Security Considerations . . . . . . . . . . . . . . . . . . .  13
   10. IANA Considerations . . . . . . . . . . . . . . . . . . . . .  13
   11. References  . . . . . . . . . . . . . . . . . . . . . . . . .  13
     11.1.  Normative References . . . . . . . . . . . . . . . . . .  13
     11.2.  Informative References . . . . . . . . . . . . . . . . .  13
Show full document text