search

cabo / kramdown-rfc

An XML2RFC (RFC799x) backend for Thomas Leitner's kramdown markdown parser
MIT License
195 stars 83 forks source link

Does anchor vs. displayreference matter? #154

Closed MikeBishop closed 2 years ago

MikeBishop commented 2 years ago

While the output this tool generates uses the mnemonic name as the anchor name, the RFC Editor appears to prefer using "RFCXXXX" as the anchor and including a <displayreference> tag in the <back> section. I'm not sure whether there's actually a functional difference between the two, except perhaps allowing the reference to be made either way throughout the document.

cabo commented 2 years ago

The RFC editor uses <xi:include, which cannot update the anchor for an imported bibxml. This means they are relying on <displayreference. kramdown-rfc does not need this, but could of course generate it in order to miminize changes during RFC editing. There also seems to be a limitation to the section reference heuristics in xml2rfc that makes keeping the RFCXXXX anchor desirable. (There are other issues with those reference heuristics.)