xml2rfc icon indicating copy to clipboard operation
xml2rfc copied to clipboard

Need better hangText crossreference format

Open ietf-svn-bot opened this issue 5 years ago • 14 comments

type_enhancement | by [email protected]


In RFC terminology section, terms are usually defined via a hangText, eg:
<t hangText="ACP (ANI/AN) Domain Certificate:" anchor="domcert-def">

Often it is required for one terms explanation to have an xref to another term. But there is no good XREF option to do this because there seems to be no way to refer to the actual hanging text. Instead, the reference will have to show something else, like the section number or so, which is all useless.

The best option i found is like this:
<xref target="domcert-def" format="title">->"ACP domain certificate"</xref>
Because i can not let the xref generate the referred text, the xref has to repeat that whole text, and i also need to write the typical way you show a reference to another term (->).

But this format still creates a redundant () at the end, and IESG reviewers did not like that. 

Maybe i am overlooking something, but i spent a already way too much time just to get to this point of understanding.

example from draft-ietf-anima-autonomic-control-plane-16

This is against xml2rfc.tools.ietf.org. That web page only says v2, so i am just assuming it is 2.5.x.

Issue migrated from trac:347 at 2022-02-05 12:44:30 +0000

ietf-svn-bot avatar Aug 02 '18 15:08 ietf-svn-bot