===== xml2rfc examples ===== When considering "Is there a better way to do this?" ==== Summary ==== - xref to a section in another RFC and the authors want to include the section title - xref with format="title" doesn't work as expected - inside when providing more information than fullname - blank line between
and
==== Details ==== ==== 1) xref to a section in another RFC and the authors want to include the section title ==== It requires 2 xrefs to get the desired output (using sectionFormat="bare" for the first one). Note: As discussed with Henrik Nov. 2019. Example A (from rfc8658.notprepped.xml) XML: described in Section IANA Considerations of TEXT output: described in Section 2 (IANA Considerations) of [RFC3575] HTML output:

defined in Section 2 (IANA Considerations) of [RFC3575]

-------------- Example B (from rfc8731.notprepped.xml) XML: defined in Section ECDH Message Numbers of TEXT output: defined in Section 7.1 (ECDH Message Numbers) of [RFC5656] HTML output:

defined in Section 7.1 (ECDH Message Numbers) of [RFC5656]

==== 2) xref with format="title" doesn't work as expected ==== bc it includes square brackets around the title in the text file Example from rfc8955.xml (draft-ietf-idr-rfc5575bis-27) in AUTH48 This document obsoletes "" PDF and HTML are OK, but the text output is not correct Text output: This document obsoletes "["Dissemination of Flow Specification Rules"]" [RFC5575] Also: If we manually add quotes for the title to be quoted (as in the example above), the text rendering automatically puts quotes in - resulting in errored output (2 sets of quotes). Without the added quotes, we get the following: This document obsoletes ["Dissemination of Flow Specification Rules"] [RFC5575] ==== 3) use inside when providing more information than fullname ==== It's possible to include more info when is outside (e.g., a contributor listed in the style of an address block), but when the is in , it's not possible. So we end up putting the data about the individual outside the element. a) name + org\\ XML: '', Cisco Systems, Inc.''\\ (file: draft-ietf-lisp-gpe-19.xml - in the queue)\\ Original (in a list): '' o Fabio Maino, Cisco Systems, Inc.'' b) name + email\\ XML: '' <ari.keranen@ericsson.com>''\\ (file: rfc8790.notprepped.xml)\\ Original (in a registration template): ''Author: Ari Keranen ari.keranen@ericsson.com'' c) name + email + org\\ XML: '' <jianfu@cisco.com> of Cisco Systems''\\ (file: rfc8698.notprepped.xml)\\ Original (in a paragraph in "Contributors"): '' Jiantao Fu of Cisco Systems'' Thinking aloud: ability to put the data in the contact element and have a decent rendering when in . (Currently, if we put additional data in the contact element when it's in , the additional data doesn't appear in the output at all.) ==== 4) get a
with a blank line between
and
==== Mail sent 2020-10-15 with details. workaround: using
(per reply from Henrik) suggestion from Jean for dl's newline attribute: newline="false|break|space" file: published as rfc8940.xml (draft-ietf-emu-eap-session-id-07)