search

ietf-tools / xml2rfc

Generate RFCs and IETF drafts from document source in XML according to the IETF xml2rfc v2 and v3 vocabularies
https://ietf-tools.github.io/xml2rfc/
BSD 3-Clause "New" or "Revised" License
71 stars 39 forks source link

Missing bcp # in txt rendering #743

Open becarpenter opened 2 years ago

becarpenter commented 2 years ago

This kramdown:  cat: bcp  seriesNo: "39" becomes  <seriesInfo name="bcp" value="39"/> in XML. In the html rendering, this displays as bcp: 39 in the document header, but it is not rendered in txt or any other format. (It should really be upper case BCP, but I assume that's user error.) The current example is draft-carpenter-rfced-iab-charter-06

becarpenter commented 2 years ago

P.S. I checked, and cat: BCP is not allowed, but the rendering should be BCP: 39 as in published RFCs. If I patch the XML as <seriesInfo name="BCP" value="39"/> the HTML renders correctly. So that'll be a separate kramdown issue.

kesara commented 2 years ago

Series information in the title page header only gets populated when xml2rfc is producing an RFC. (This is identified by number attribute in rfc element.)

Showing series information in the header in HTML output might be a bug in xml2rfc.

becarpenter commented 2 years ago

I think the correct approach is like Updates: and Obsoletes:, i.e. BCP: 39 (if approved)

cabo commented 2 years ago 
   name (for Internet-Drafts).  Another <seriesInfo> element determines
   the "maturity level" (defined in [RFC2026]), using values of "std"
   for "Standards Track", "bcp" for "BCP", "info" for "Informational",
   "exp" for "Experimental", and "historic" for "Historic".  The "name"
   attributes of those multiple <seriesInfo> elements interact as

xml2rfc is following RFC7991 when generating the seriesInfo from the seriesno <rfc attribute. If we want a different display, this is a rendering issue.

becarpenter commented 2 years ago

OK, thanks for the clarification.