Handling Long Lines in Artwork in Internet-Drafts and RFCs
draft-kwatsen-netmod-artwork-folding-08

Document Type Active Internet-Draft (candidate for netmod WG)
Last updated 2018-10-18 (latest revision 2018-10-16)
Replaces draft-wu-netmod-yang-xml-doc-conventions
Stream IETF
Intended RFC status (None)
Formats plain text xml pdf html bibtex
Stream WG state Call For Adoption By WG Issued
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                                          Juniper Networks
Intended status: Best Current Practice                             Q. Wu
Expires: April 19, 2019                              Huawei Technologies
                                                               A. Farrel
                                                        Juniper Networks
                                                               B. Claise
                                                     Cisco Systems, Inc.
                                                        October 16, 2018

       Handling Long Lines in Artwork in Internet-Drafts and RFCs
                draft-kwatsen-netmod-artwork-folding-08

Abstract

   This document introduces a simple and yet time-proven strategy for
   handling long lines in artwork in drafts using a backslash ('\')
   character where line-folding has occurred.  The strategy works on any
   text based artwork, but is primarily intended for sample text and
   formatted examples and code, rather than for graphical artwork.  The
   approach produces consistent results regardless of the content and
   uses a per-artwork header.  The strategy is both self-documenting and
   enables automated reconstitution of the original artwork.

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 April 19, 2019.

Copyright Notice

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

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

   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  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Requirements Language . . . . . . . . . . . . . . . . . . . .   3
   3.  Goals . . . . . . . . . . . . . . . . . . . . . . . . . . . .   3
     3.1.  Automated Folding of Long Lines in Artwork  . . . . . . .   3
     3.2.  Automated Reconstitution of Original Artwork  . . . . . .   4
   4.  Limitations . . . . . . . . . . . . . . . . . . . . . . . . .   4
     4.1.  Not Recommended for Graphical Artwork . . . . . . . . . .   4
     4.2.  Doesn't Work as Well as Format-Specific Options . . . . .   4
   5.  Folded Structure  . . . . . . . . . . . . . . . . . . . . . .   5
     5.1.  Header  . . . . . . . . . . . . . . . . . . . . . . . . .   5
     5.2.  Body  . . . . . . . . . . . . . . . . . . . . . . . . . .   5
   6.  Algorithm . . . . . . . . . . . . . . . . . . . . . . . . . .   6
     6.1.  Automated Folding . . . . . . . . . . . . . . . . . . . .   6
       6.1.1.  Manual Folding  . . . . . . . . . . . . . . . . . . .   7
     6.2.  Automated Unfolding . . . . . . . . . . . . . . . . . . .   7
   7.  Considerations for xml2rfc v3 . . . . . . . . . . . . . . . .   8
   8.  Examples  . . . . . . . . . . . . . . . . . . . . . . . . . .   8
     8.1.  Simple Example Showing Boundary Conditions  . . . . . . .   8
     8.2.  Example Showing Multiple Wraps of a Single Line . . . . .   9
     8.3.  Example With Native Backslash . . . . . . . . . . . . . .   9
     8.4.  Example With Native Whitespace  . . . . . . . . . . . . .   9
     8.5.  Example of Manual Wrapping  . . . . . . . . . . . . . . .   9
   9.  Security Considerations . . . . . . . . . . . . . . . . . . .  10
   10. IANA Considerations . . . . . . . . . . . . . . . . . . . . .  10
   11. References  . . . . . . . . . . . . . . . . . . . . . . . . .  10
     11.1.  Normative References . . . . . . . . . . . . . . . . . .  10
     11.2.  Informative References . . . . . . . . . . . . . . . . .  10
   Appendix A.  POSIX Shell Script . . . . . . . . . . . . . . . . .  12
   Acknowledgements  . . . . . . . . . . . . . . . . . . . . . . . .  16
Show full document text