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

internet-drafts@ietf.org Wed, 30 May 2018 01:17 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-01.txt
Auto-Submitted: auto-generated
Precedence: bulk
Message-ID: <152764303716.27698.8121571643370464748@ietfa.amsl.com>
Date: Tue, 29 May 2018 18:17:17 -0700
Archived-At: <https://mailarchive.ietf.org/arch/msg/i-d-announce/e8sXCiJ0OfuKmGYPq-oePiakwF0>

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


        Title           : Documentation Conventions for Expressing YANG in XML
        Authors         : Qin Wu
                          Adrian Farrel
                          Benoît Claise
	Filename        : draft-wu-netmod-yang-xml-doc-conventions-01.txt
	Pages           : 10
	Date            : 2018-05-29

Abstract:
   Many documents that define YANG modules also include artwork examples
   presented in XML/JSON.

   IETF documentation has specific limits on line length and some
   artwork examples such as XML examples have to include line wraps that
   would not normally be allowed according to the XML representation
   rules of RFC7950 and RFC7952.The same applies to JSON.

   This document lays out documentation conventions that allow YANG
   examples to be presented in IETF documentation when XML/JSON encoded
   YANG data instance would otherwise exceed the maximum line length and
   provide consistent XML/JSON encoded YANG data node instance example
   within an Internet-Draft or RFC.  There are no implications in this
   document for YANG parsers: this document does not change the rules
   for presenting YANG models or for encoding YANG 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-01
https://datatracker.ietf.org/doc/html/draft-wu-netmod-yang-xml-doc-conventions-01

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


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