I-D Action: draft-wu-netmod-yang-xml-doc-conventions-03.txt

internet-drafts@ietf.org Wed, 06 June 2018 04:18 UTC

MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 8bit
From: internet-drafts@ietf.org
To: i-d-announce@ietf.org
Subject: I-D Action: draft-wu-netmod-yang-xml-doc-conventions-03.txt
Auto-Submitted: auto-generated
Precedence: bulk
Message-ID: <152825869245.19399.3520983854928064750@ietfa.amsl.com>
Date: Tue, 05 Jun 2018 21:18:12 -0700
Archived-At: <https://mailarchive.ietf.org/arch/msg/i-d-announce/nTTuCp7cZsNAO-LKHYsEuEHSe20>

A New Internet-Draft is available from the on-line Internet-Drafts directories.


        Title           : Documentation Conventions for lines wrapping and indentation in authored work
        Authors         : Qin Wu
                          Adrian Farrel
                          Benoît Claise
	Filename        : draft-wu-netmod-yang-xml-doc-conventions-03.txt
	Pages           : 13
	Date            : 2018-06-05

Abstract:
   Many documents that define YANG modules or YANG fragments also
   include protocol message instance data examples.

   IETF documentation has specific limits on line length (73 characters)
   and some YANG fragment example or protocol message instance data
   examples such as XML encoded YANG data node instance examples have to
   include line wraps that would not normally be allowed according to
   the XML representation rules of RFC7950 and RFC7952.

   This document lays out documentation conventions that allow authored
   work to be presented in IETF documentation when authored work such as
   YANG fragment or protocol message instance data example would
   otherwise exceed the maximum line length and provide consistent
   representation of authored work within an Internet-Draft or RFC.
   There are no implications in this document for YANG tools: this
   document does not change the rules for presenting authored work in
   data files or in the wire.


The IETF datatracker status page for this draft is:
https://datatracker.ietf.org/doc/draft-wu-netmod-yang-xml-doc-conventions/

There are also htmlized versions available at:
https://tools.ietf.org/html/draft-wu-netmod-yang-xml-doc-conventions-03
https://datatracker.ietf.org/doc/html/draft-wu-netmod-yang-xml-doc-conventions-03

A diff from the previous version is available at:
https://www.ietf.org/rfcdiff?url2=draft-wu-netmod-yang-xml-doc-conventions-03


Please note that it may take a couple of minutes from the time of submission
until the htmlized version and diff are available at tools.ietf.org.

Internet-Drafts are also available by anonymous FTP at:
ftp://ftp.ietf.org/internet-drafts/

I-D Action: draft-wu-netmod-yang-xml-doc-conventi… internet-drafts