[netmod] Summary for the busy : draft-wu-netmod-yang-xml-doc-conventions-00.txt
"Adrian Farrel" <adrian@olddog.co.uk> Mon, 29 January 2018 15:50 UTC
Return-Path: <adrian@olddog.co.uk>
X-Original-To: netmod@ietfa.amsl.com
Delivered-To: netmod@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id DBA5012EC86 for <netmod@ietfa.amsl.com>; Mon, 29 Jan 2018 07:50:10 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.619
X-Spam-Level:
X-Spam-Status: No, score=-2.619 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id mtd07izu66Hs for <netmod@ietfa.amsl.com>; Mon, 29 Jan 2018 07:50:08 -0800 (PST)
Received: from asmtp5.iomartmail.com (asmtp5.iomartmail.com [62.128.201.176]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 1B33F12EC75 for <netmod@ietf.org>; Mon, 29 Jan 2018 07:49:57 -0800 (PST)
Received: from asmtp5.iomartmail.com (localhost.localdomain [127.0.0.1]) by asmtp5.iomartmail.com (8.13.8/8.13.8) with ESMTP id w0TFng7E008387; Mon, 29 Jan 2018 15:49:42 GMT
Received: from 950129200 ([193.56.242.60]) (authenticated bits=0) by asmtp5.iomartmail.com (8.13.8/8.13.8) with ESMTP id w0TFneQI008353 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO); Mon, 29 Jan 2018 15:49:41 GMT
Reply-To: adrian@olddog.co.uk
From: Adrian Farrel <adrian@olddog.co.uk>
To: netmod@ietf.org
Date: Mon, 29 Jan 2018 15:49:39 -0000
Message-ID: <071701d39918$c6cc9f00$5465dd00$@olddog.co.uk>
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
X-Mailer: Microsoft Outlook 14.0
Thread-Index: AdOZGLxxp2paG1WDTQOcqbXGOjEobg==
Content-Language: en-gb
X-TM-AS-MML: disable
X-TM-AS-Product-Ver: IMSS-7.1.0.1679-8.2.0.1013-23628.000
X-TM-AS-Result: No--16.030-10.0-31-10
X-imss-scan-details: No--16.030-10.0-31-10
X-TMASE-MatchedRID: AQrYL7loigPEQS2ecfkpF6DH6drx3JPVGWAN/II9wcRaW2Ktn+I8/nk1 Tuqc6F4GADZ3LWMKU8KH85V8v/EpVd0Hi7N6dLT+EroQVzSW9XRu/Xr6CKXiN7v408/GP5HqE1t fv0R8u8HBBOpssnjSO/P3uahlKArx/jsbtWBGy0y7vYqkCS0dLxbjReJSRusbRfmFzyKgHb7YFR cQqylt5m6mUHbiBraMPDF4aOlLYwcEdG16FO0c4o9hRjNfZeOXmX+W7bzPOQGpqdpbu0w7OrcIM 0irdNICCCbEEgOySDMgnvrgPYqDApTR9ziZdqjAH5YQyOg71ZZ9LQinZ4QefNQdB5NUNSsioeQz lhj3almNo+PRbWqfRDsAVzN+Ov/sJ8b5jtoZc/yVuCtSkmQR2axOpk15LyhNlfBiLoXke1xpFPo VKGo4wQ==
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/WKRSRqDMBR_ZUqzuoLTs0uMmy4E>
Subject: [netmod] Summary for the busy : draft-wu-netmod-yang-xml-doc-conventions-00.txt
X-BeenThere: netmod@ietf.org
X-Mailman-Version: 2.1.22
Precedence: list
List-Id: NETMOD WG list <netmod.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/netmod>, <mailto:netmod-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/netmod/>
List-Post: <mailto:netmod@ietf.org>
List-Help: <mailto:netmod-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/netmod>, <mailto:netmod-request@ietf.org?subject=subscribe>
X-List-Received-Date: Mon, 29 Jan 2018 15:50:11 -0000
Hi, Just a summary for those of you who are busy... May YANG module documents include examples in XML. Sometimes there are line length problems caused by the 73 character limit. Different documents have adopted different ways around this as special cases. It would be useful to have a generic approach so that all documents have the same look and feel. It has also been suggested that this might ease auto-verification of examples, but that might be a challenge for other reasons. We have not included JSON in this document. JSON is somewhat more compact, but the same issue could arise, so we do plan to look at this in the future. Thoughts would be most welcome. Adrian > A new version of I-D, draft-wu-netmod-yang-xml-doc-conventions-00.txt > has been successfully submitted by Qin Wu and posted to the IETF repository. > > Name: draft-wu-netmod-yang-xml-doc-conventions > Revision: 00 > Title: Documentation Conventions for Expressing YANG in XML > Document date: 2018-01-26 > Group: Individual Submission > Pages: 9 > URL: https://www.ietf.org/internet-drafts/draft-wu-netmod-yang-xml- > doc-conventions-00.txt > Status: https://datatracker.ietf.org/doc/draft-wu-netmod-yang-xml-doc- > conventions/ > Htmlized: https://tools.ietf.org/html/draft-wu-netmod-yang-xml-doc- > conventions-00 > Htmlized: https://datatracker.ietf.org/doc/html/draft-wu-netmod-yang-xml- > doc-conventions-00 > > > Abstract: > Many documents that define YANG modules also include examples > presented in XML. > > IETF documentation has specific limits on line length and some XML > 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 YANG > examples to be presented in IETF documentation when leaf node > encoding would otherwise exceed the maximum line length. 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.
- [netmod] Summary for the busy : draft-wu-netmod-y… Adrian Farrel