Sec 10.1 Hyperlink is broken
martinduke opened this issue · comments
In section 5.4, there is a hyperlink to Sec 10.1 of RFC 9000, that instead leads to Sec 10.1 of dnsoquic.
That's a tool issue. The markdown source says:
Per section 10.1 of the QUIC transport specification, the
effective value of the idle timeout is computed as the minimum of the values
advertised by the two endpoints.
The XML file that I generated has:
<t>Clients and servers implementing DoQ SHOULD negotiate use of the idle timeout.
Closing on idle timeout is done without any packet exchange, which minimizes
protocol overhead. Per section 10.1 of the QUIC transport specification, the
effective value of the idle timeout is computed as the minimum of the values
advertised by the two endpoints. Practical considerations on setting the idle
timeout are discussed in <xref target="resource-management-and-idle-timeout-values"/>.</t>
I have no idea who inserted the extraneous hyperlink. @saradickinson can you check the XML that you submitted?
This isn't in the generated text. Martin is probably just using the marked-up versions on the datatracker (the "htmlized" version), which turns those things in to links.
What you want to do is replace "section 10.1 of the QUIC transport specification" in the source with "{{Section 10.1 of RFC9000}}" and avoid confusing the tools.
Edit: This is not an isolated case. You do this in several places.
This is the same problem already flagged in issue #64. The fix is to use syntax like {{Section 3.5 of RFC9000}}, but that syntax is not supported in all versions of kramdown. I just tried on got this error message:
draft.xml(0): Error: IDREF attribute target references an unknown ID "Section_3.5_of_RFC9000", at None
So it is on the todo list, but I would rather do that just once, maybe after processing the current batch of edits.
At the same time, the root cause of Martin's surprise is an over-eager HTML conversion script. XML2RFC already provides annotations for setting cross references between sections. The script has no business scraping the text and trying to insert its own set of cross links.
Yes. The html annotations are never going to be as good as the real thing. We should not be showing htmlized text when we have HTML.
However, Christian, you did not submit XML for this draft, so the datatracker is doing what it can with a text file. Maybe the revision can be submitted as XML.
Updating your copy of kramdown-rfc2629 is easy and will fix a bunch of unrelated issues.
Noted the point about submitting XML.
Agreed - I've only submitted txt previously so we'll try to get the section links working and then submit XML.
Just submitted the xml for -06 and this looks fixed, so closing the issue.