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
63 stars 35 forks source link

Updated format for subseries references #1100

Closed ajeanmahoney closed 4 months ago

ajeanmahoney commented 4 months ago

Description

Please add introductory text to the subseries reference that captures the "name" of the subseries: "Internet Standard NN", "Best Current Practice NN", or "For Your Information NN", and provide a link to the subseries info page. Add the text "At the time of writing, this [STD|BCP|FYI] comprises the following:" as a lead-in to the list of RFCs within the subseries.

For the RFCs listed within the subseries, please provide each RFC's DOI and info URL as is currently done for individual RFC references.

An example of a single-RFC subseries reference in this requested format:

   [STD72]    Internet Standard 72,
              <https://www.rfc-editor.org/info/std/std72>.
              At the time of writing, this STD comprises the following:

              Gellens, R. and J. Klensin, "Message Submission for Mail",
              STD 72, RFC 6409, DOI 10.17487/RFC6409, November 2011,
              <https://www.rfc-editor.org/info/rfc6409>.

An example of a multiple-RFC subseries reference in this requested format:

   [STD69]    Internet Standard 69, 
              <https://www.rfc-editor.org/info/std69>.
              At the time of writing, this STD comprises the following:

              Hollenbeck, S., "Extensible Provisioning Protocol (EPP)",
              STD 69, RFC 5730, DOI 10.17487/RFC5730, August 2009,
              <https://www.rfc-editor.org/info/rfc5730>.

              Hollenbeck, S., "Extensible Provisioning Protocol (EPP)
              Domain Name Mapping", STD 69, RFC 5731, 
              DOI 10.17487/RFC5731, August 2009,
              <https://www.rfc-editor.org/info/rfc5731>.

              Hollenbeck, S., "Extensible Provisioning Protocol (EPP)
              Host Mapping", STD 69, RFC 5732, DOI 10.17487/RFC5732, 
              August 2009, 
              <https://www.rfc-editor.org/info/rfc5732>.

              Hollenbeck, S., "Extensible Provisioning Protocol (EPP)
              Contact Mapping", STD 69, RFC 5733, 
              DOI 10.17487/RFC5733, August 2009, 
              <https://www.rfc-editor.org/info/rfc5733>.

              Hollenbeck, S., "Extensible Provisioning Protocol (EPP)
              Transport over TCP", STD 69, RFC 5734, 
              DOI 10.17487/RFC5734, August 2009, 
              <https://www.rfc-editor.org/info/rfc5734>.

Requested intro for a BCP:

   [BCP14]    Best Current Practice 14, 
              <https://www.rfc-editor.org/info/bcp14>.
              At the time of writing, this BCP comprises the following:
              ....

Requested intro for an FYI:

   [FYI28]    For Your Information 28, 
              <https://www.rfc-editor.org/info/fyi28>.
              At the time of writing, this FYI comprises the following:
              ....

Code of Conduct

ajeanmahoney commented 4 months ago

@cabo because he started the ball rolling with #1067

ajeanmahoney commented 4 months ago

A note on the FYI subseries -- this subseries was concluded with RFC 6360 and is not expected to be revived.

ajeanmahoney commented 4 months ago

The RPC believes this feature request is fully specified and can move forward. The FYI subseries is included so that all subseries will be treated consistently by the tools.

kesara commented 4 months ago

The target attribute for referencegroup is optional. What is the expected output when target is not present?

kesara commented 4 months ago

See examples for new presentations at https://github.com/ietf-tools/xml2rfc/pull/1102#issue-2133697366

ajeanmahoney commented 4 months ago

The target attribute for referencegroup is optional. What is the expected output when target is not present?

For RFC references, xml2rfc currently provides a URL in the output if the target attribute is empty. Can the same be done here? (Although I hope that authors use xi:includes for subseries references to reduce errors).

kesara commented 4 months ago

@ajeanmahoney, https://github.com/ietf-tools/xml2rfc/pull/1102/commits/205c09c84fb4f204d727ae64c56dab70d61fe768 adds this feature.

Examples: Format Example
XML draft-foobar-00.xml
Text draft-foobar-00.txt
HTML draft-foobar-00.html
PDF draft-foobar-00.pdf