Hi Med, > On Sep 11, 2024, at 1:08 AM, mohamed.boucad...@orange.com wrote: > > Hi Kent, > > Yes, I was referring to both large tree diagrams and trees with long lines. > > Having tree diagrams that span several pages is not convenient for readers > and does not serve the purpose of having tree/subtrees in the narrative part. > Splitting into small diagrams would help here. Some of the small diagrams can > be manually tweaked to better fit the size constraints. We used that approach > in many RFCs, e.g., rfc9182.
[mj] Except, that a large part of the tree diagram for this particular model comes from imports, as Kent explained. It is difficult to split/edit tree diagram horizontally and vertically that is being imported. And I am not for manually tweaking tree diagram, as they inevitably error prone. I have submitted a tooling request to include tree diagrams in a box that can be scrolled, although that will work for HTML versions of the draft only. Cheers. > > Cheers, > Med > > De : Kent Watsen <kent+i...@watsen.net> > Envoyé : mardi 10 septembre 2024 20:09 > À : BOUCADAIR Mohamed INNOV/NET <mohamed.boucad...@orange.com> > Cc : Joe Clarke (jclarke) <jclarke=40cisco....@dmarc.ietf.org>; > draft-ietf-netmod-syslog-mo...@ietf.org; netmod@ietf.org > Objet : Re: [netmod] Paul Wouters' Discuss on > draft-ietf-netmod-syslog-model-32: (with DISCUSS and COMMENT) > > > Hi Med, > > The issue here isn’t how *long* the examples are, but how *wide* they are. > > The syslog model itself is relatively small, but the tree diagrams blow up > (in both length and width) just by using the TCP/TLS-client-server draft’s > groupings. There really isn’t a way for the syslog model to be broken into > smaller pieces to get around this. > > Regarding "The tree as displayed in the draft does not actually adhere with > this part in 8407bis”, I got curious and looked. Assuming the groupings are > NOT expanded (which the rfc8407bis text below allows), I’m unsure what issue > triggers. Can you say? > > Separately, I noticed that the document does not seem to use the `rfcfold` > utility (RFC 8792), which may be a different issue that could be fixed. > > Kent // as author > > > > On Sep 10, 2024, at 11:37 AM, mohamed.boucad...@orange.com > <mailto:mohamed.boucad...@orange.com> wrote: > > Re-, > > The tree as displayed in the draft does not actually adhere with this part in > 8407bis: > > YANG tree diagrams provide a concise representation of a YANG module > and SHOULD be included to help readers understand YANG module > structure. If the complete tree diagram for a module becomes long > (more than 2 pages, typically), the diagram SHOULD be split into > several smaller diagrams (a.k.a subtrees). For the reader's > convenience, a subtree should fit within a page. If the complete > tree diagram is too long (more than 5 pages, typically) even with > groupings unexpanded (Section 2.2 of [RFC8340]), the authors SHOULD > NOT include it in the document. A stable pointer to retrieve the > full tree MAY be included. > > On the tooling side, we do have the following in the 8407bis: > > The tooling may evolve in the future to provide better rendering > of too long trees. This tooling may offer (but not limited to), > unfold trees, control of expanded views, ease navigation among > various levels of a tree, support of hyperlinks, etc. When such a > tooling is available, too long trees can be displayed in the HTML > version of documents that include such trees. > > I know that Italo tried to have a discussion in 121 with Carsten for md(?), > but I don’t know if that discussion actually happened. Italo can clarify this. > > Cheers, > Med > > De : Kent Watsen <kent+i...@watsen.net <mailto:kent+i...@watsen.net>> > Envoyé : mardi 10 septembre 2024 17:07 > À : Joe Clarke (jclarke) <jclarke=40cisco....@dmarc.ietf.org > <mailto:jclarke=40cisco....@dmarc.ietf.org>> > Cc : draft-ietf-netmod-syslog-mo...@ietf.org > <mailto:draft-ietf-netmod-syslog-mo...@ietf.org>; netmod@ietf.org > <mailto:netmod@ietf.org> > Objet : [netmod] Re: Paul Wouters' Discuss on > draft-ietf-netmod-syslog-model-32: (with DISCUSS and COMMENT) > > [removing the IESG] > > > Hi Joe, authors, and NETMOD. > > On Sep 10, 2024, at 10:04 AM, Joe Clarke (jclarke) > <jclarke=40cisco....@dmarc.ietf.org > <mailto:jclarke=40cisco....@dmarc.ietf.org>> wrote: > > Thanks for the comments and feedback, Paul. I’ve opened GitHub > issuehttps://github.com/netmod-wg/syslog-model/issues/14 > <https://github.com/netmod-wg/syslog-model/issues/14> so Mahesh and I can > track the necessary changes on our end. See below for some initial responses. > > The layout is completely broken / wrapped, making the document fairly > unreadable. Can this be fixed somehow ? > > > > [JMC] Éric had the same comment, and I thought we’d be good just expanding > the full tree. However, it seems this is causing readability and confusion > problems. > > I ran into a similar “wrapping tree diagrams is ugly" comment in the suite of > client-server drafts. Not expanding the groupings in the tree diagrams > helps, but still may not be enough - you just need to try and see how it > looks. That said, there is still one thing that can be done to improve the > appearance of *folded” tree diagrams, which is epitomized by the following > RFC Editor comment put into the documents: > > <t>Tree-diagrams in this draft may use the '\' line-folding mode > defined in RFC 8792. > However, nicer-to-the-eye is when the '\\' line-folding > mode is used. The AD suggested > suggested putting a request here for the RFC Editor to help > convert "ugly" '\' folded > examples to use the '\\' folding mode. "Help convert" may > be interpreted as, identify > what looks ugly and ask the authors to make the adjustment.</t> > > PS: there is a desire to have Datatracker *unfold* folded artwork/sourcecode > for document output formats that can support horizontal scrolling. > Specifically, for an HTML-rendered document, the ideal is for examples to be > unfolded and placed into a textbox that causes a browser to create a textbox > with horizontal scrolling. I’m unsure if there is an open-ticket for this > work to get done. > > Kent // as contributor > > > > ____________________________________________________________________________________________________________ > Ce message et ses pieces jointes peuvent contenir des informations > confidentielles ou privilegiees et ne doivent donc > pas etre diffuses, exploites ou copies sans autorisation. Si vous avez recu > ce message par erreur, veuillez le signaler > a l'expediteur et le detruire ainsi que les pieces jointes. Les messages > electroniques etant susceptibles d'alteration, > Orange decline toute responsabilite si ce message a ete altere, deforme ou > falsifie. Merci. > > This message and its attachments may contain confidential or privileged > information that may be protected by law; > they should not be distributed, used or copied without authorisation. > If you have received this email in error, please notify the sender and delete > this message and its attachments. > As emails may be altered, Orange is not liable for messages that have been > modified, changed or falsified. > Thank you. > > ____________________________________________________________________________________________________________ > Ce message et ses pieces jointes peuvent contenir des informations > confidentielles ou privilegiees et ne doivent donc > pas etre diffuses, exploites ou copies sans autorisation. Si vous avez recu > ce message par erreur, veuillez le signaler > a l'expediteur et le detruire ainsi que les pieces jointes. Les messages > electroniques etant susceptibles d'alteration, > Orange decline toute responsabilite si ce message a ete altere, deforme ou > falsifie. Merci. > > This message and its attachments may contain confidential or privileged > information that may be protected by law; > they should not be distributed, used or copied without authorisation. > If you have received this email in error, please notify the sender and delete > this message and its attachments. > As emails may be altered, Orange is not liable for messages that have been > modified, changed or falsified. > Thank you. Mahesh Jethanandani mjethanand...@gmail.com
_______________________________________________ netmod mailing list -- netmod@ietf.org To unsubscribe send an email to netmod-le...@ietf.org
