quicwg / base-drafts

Internet-Drafts that make up the base QUIC specification
https://quicwg.org
1.63k stars 204 forks source link

Auth48: Combined internal references #4955

Closed MikeBishop closed 2 years ago

MikeBishop commented 2 years ago

https://github.com/cabo/kramdown-rfc2629 supports references to other documents of the form {{Sections X.Y and X.Z of BLAHBLAH}}, which renders as one might expect. In multiple locations, the draft makes multiple internal references (see {{foo}} and {{bar}}) which render as "see Section X.Y and Section X.Z".

The RFC Editor asks that these be changed to "Sections X.Y and X.Z", but I'm currently unaware of a way to do that within a document in kramdown.

@martinthomson, @cabo - suggestions appreciated.

cabo commented 2 years ago

You can use the format= attribute of <xref.

{{<terminology}} for <xref target="terminology" format="counter"/>
{{<<terminology}} for <xref target="terminology" format="title"/>

So your example becomes

Sections {{<foo}} and {{<bar}}

Enjoy!

MikeBishop commented 2 years ago

Thank you! That trick could be useful in a few other places as well.

MikeBishop commented 2 years ago

Closed in #4956.