Support/adopt.
A couple of comments:
1) Section 4.2 suggests using groupings to presumably avoid folding. I
don't really support this as a strategy, since I think that groupings
are overused and I think that they obfuscate the true structure of a
YANG module, that can only be recovered by recompiling the module with
the groupings expanded, or looking at the tree output. Really, I think
that an ideal solution would be to somehow have RFCs support longer
lines for files like YANG - e.g. if I could choose any value without
regard for backwards compatibility I would probably choose 120
characters instead.
2) The proposed solution always left indents the wrapped line. Often for
artwork (e.g. a YANG tree diagram), where whitespace is not significant,
and the wrapping is relatively minor, then right indenting the wrapped
line can make the results look more visually readable.
E.g. I think that this is slightly easier to read:
module: ietf-flexible-encapsulation
augment /if:interfaces/if:interface/if-cmn:encapsulation\
/if-cmn:encaps-type:
+--:(flexible)
+--rw flexible
+--rw match
| +--rw (match-type)
| +--:(default)
| | +--rw default? empty
| +--:(untagged)
| | +--rw untagged? empty
| +--:(dot1q-priority-tagged)
| | +--rw dot1q-priority-tagged
| | +--rw tag-type? dot1q-types:dot1q-\
tag-type
| +--:(dot1q-vlan-tagged)
| +--rw dot1q-vlan-tagged
rather than:
module: ietf-flexible-encapsulation
augment /if:interfaces/if:interface/if-cmn:encapsulation\
/if-cmn:encaps-type:
+--:(flexible)
+--rw flexible
+--rw match
| +--rw (match-type)
| +--:(default)
| | +--rw default? empty
| +--:(untagged)
| | +--rw untagged? empty
| +--:(dot1q-priority-tagged)
| | +--rw dot1q-priority-tagged
| | +--rw tag-type? dot1q-types:dot1q-\
tag-type
| +--:(dot1q-vlan-tagged)
| +--rw dot1q-vlan-tagged
Thanks,
Rob
On 23/06/2018 02:37, Qin Wu wrote:
Dear WG,
As you may recall I presented yang-xml-doc-conventions in London. There was
strong support for trying to solve the problem and mixed views on the solution,
other than that we should do it fast. In the meanwhile, Kent submitted
artwork-folding as an alternative solution.
The authors of the two drafts decided to combine efforts. After several
internal iterations on both drafts, the drafts were becoming more alike than
different(both support auto wrapping or auto folding). The artwork-folding
draft was selected as a preferred offering basis (i.e.,
draft-kwatsen-netmod-artwork-folding-04) to the working group to consider for
adoption.
The primary feature differences remained are:
- all folded lines continue of column 0 without two character indentation,
i.e., whether auto indentation should be supported.
- handle two special case on backslash and space at the end of broken line
in yang-xml-doc-conventions.
- propose to use <WRAPPED TEXT BEGIN><WRAPPED TEXT END> to extract artwork
from I-Ds.
Thanks,
Qin, Kent, Benoit and Adrian
-----邮件原件-----
发件人: [email protected] [mailto:[email protected]]
发送时间: 2018年6月23日 9:33
收件人: Benoit Claise; Qin Wu; Kent Watsen; Adrian Farrel; Benoît Claise
主题: New Version Notification for draft-kwatsen-netmod-artwork-folding-04.txt
A new version of I-D, draft-kwatsen-netmod-artwork-folding-04.txt
has been successfully submitted by Qin Wu and posted to the IETF repository.
Name: draft-kwatsen-netmod-artwork-folding
Revision: 04
Title: Handling Long Lines in Artwork in Drafts
Document date: 2018-06-22
Group: Individual Submission
Pages: 9
URL:
https://www.ietf.org/internet-drafts/draft-kwatsen-netmod-artwork-folding-04.txt
Status:
https://datatracker.ietf.org/doc/draft-kwatsen-netmod-artwork-folding/
Htmlized:
https://tools.ietf.org/html/draft-kwatsen-netmod-artwork-folding-04
Htmlized:
https://datatracker.ietf.org/doc/html/draft-kwatsen-netmod-artwork-folding
Diff:
https://www.ietf.org/rfcdiff?url2=draft-kwatsen-netmod-artwork-folding-04
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, producing consistent results regardless the
artwork content. Using a per-artwork header, the strategy is both
self-documenting and enables automated reconstitution of the original
artwork.
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
[email protected]
https://www.ietf.org/mailman/listinfo/netmod
_______________________________________________
netmod mailing list
[email protected]
https://www.ietf.org/mailman/listinfo/netmod
