Re: [netmod] Status update on <draft-wu-netmod-yang-xml-doc-conventions-01>

[Qin Wu <[e-mail]>]

Good point, we will fix terminologies issues in the next update. 
Thanks, Juergen.

-Qin
-----邮件原件-----
发件人: Juergen Schoenwaelder [mailto:[e-mail]] 
发送时间: 2018年5月30日 13:34
收件人: Qin Wu
抄送: [e-mail]
主题: Re: [netmod] Status update on <draft-wu-netmod-yang-xml-doc-conventions-01>

I think the title of the document is misleading. The convention for expressing YANG in XML is called YIN, defined in RFC 7950. There are other phrases that I find misleading, for example, Automatic Generation of Valid XML From Examples. For me, the example is the XML (or JSON) and what you call an example is the encoding of an XML in the RFC format and what you define is an RFC format qencoding and a decoding function. Perhaps it helps to properly define the terminology you use and then to go through the document to make sure terms are used consistently.

/js

On Wed, May 30, 2018 at 01:39:42AM +0000, Qin Wu wrote:
> Hi, WG:
> We have made an update Documentation Conventions for Expressing YANG in XML I-D based on last meeting discussion.
> The changes include:
> 1. Add JSON support.
> 2. Add objectives section
> 3. Consolidate Mandatory Boilerplate for both leaf node and metadata annotation.
> 4. Move complex case to Appendix.
> 5. Better Align abstract and introduction section with objectives sections.
> The diff is:
> https://www.ietf.org/rfcdiff?url2=draft-wu-netmod-yang-xml-doc-convent
> ions-01 We believe the v-(01) address all the comments in last meeting 
> and can serve a good basis to move to the next step.
> Thanks. Further Comments and suggestions are welcome.
> 
> -Qin
> -----邮件原件-----
> 发件人: [e-mail] [mailto:[e-mail]]
> 发送时间: 2018年5月30日 9:17
> 收件人: Benoit Claise; Qin Wu; Adrian Farrel; Benoît Claise
> 主题: New Version Notification for 
> draft-wu-netmod-yang-xml-doc-conventions-01.txt
> 
> 
> A new version of I-D, draft-wu-netmod-yang-xml-doc-conventions-01.txt
> has been successfully submitted by Qin Wu and posted to the IETF repository.
> 
> Name:		draft-wu-netmod-yang-xml-doc-conventions
> Revision:	01
> Title:		Documentation Conventions for Expressing YANG in XML
> Document date:	2018-05-29
> Group:		Individual Submission
> Pages:		10
> URL:            https://www.ietf.org/internet-drafts/draft-wu-netmod-yang-xml-doc-conventions-01.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-01
> Htmlized:       https://datatracker.ietf.org/doc/html/draft-wu-netmod-yang-xml-doc-conventions
> Diff:           https://www.ietf.org/rfcdiff?url2=draft-wu-netmod-yang-xml-doc-conventions-01
> 
> 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.
> 
>                                                                                   
> 
> 
> 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.
> 
> The IETF Secretariat
> 
> _______________________________________________
> netmod mailing list
> [e-mail]
> https://www.ietf.org/mailman/listinfo/netmod

-- 
Juergen Schoenwaelder           Jacobs University Bremen gGmbH
Phone: [phone]         Campus Ring 1 | 28759 Bremen | Germany
Fax:   [phone]         <https://www.jacobs-university.de/>