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
64 stars 38 forks source link

Generation of URL in an RFC reference when target attribute of <reference> not set #640

Open ietf-svn-bot opened 3 years ago

ietf-svn-bot commented 3 years ago

type_defect | by mahoney@nostrum.com

When a reference for an RFC is created from the contents of a element, for instance (note the lack of target attribute in the element, but this XML is valid): 

<reference anchor="TLS13">
   <front>
      <title>The Transport Layer Security (TLS) Protocol Version 1.3</title>
      <author fullname="E. Rescorla" initials="E." surname="Rescorla">
         <organization/>
      </author>
      <date month="August" year="2018"/>
      <abstract>
         <t>(...abstract stuff...)</t>
      </abstract>
   </front>
   <seriesInfo name="RFC" value="8446"/>
   <seriesInfo name="DOI" value="10.17487/RFC8446"/>
</reference>

A URL of the following format is created in the output:

https://www.rfc-editor.org/rfc/rfc8446

[TLS13]    Rescorla, E., "The Transport Layer Security (TLS) Protocol
           Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018,
           <https://www.rfc-editor.org/rfc/rfc8446>.

The URL works, but lands on the RFC itself, not its information page.

This URL is different from the one generated from an , which has the following format (the URL is constructed with "info" rather than "rfc") and which lands the reader on the information page of the RFC:

https://www.rfc-editor.org/info/rfc8446

Workaround: Include the correct URL in the target attribute of the element.

Issue migrated from trac:640 at 2022-02-08 07:15:25 +0000

ietf-svn-bot commented 3 years ago

@arusso@amsl.com commented

FYI, in general, rather than the above example (which is the output of markdown->xml) or the manual correction, the preferred way to automatically create this reference is:

<displayreference target="RFC8446" to="TLS13"/>
ietf-svn-bot commented 3 years ago

@lars@eggert.org commented

IMO the "RFC itself" is a much better landing page than the info page. The RFC has all the same information as the info page, plus contains the actual RFC.

ietf-svn-bot commented 3 years ago

@rjsparks@nostrum.com _changed status from new to under_review_