hassanakbar4 / tractive-test

0 stars 0 forks source link

Need better hangText crossreference format #347

Open hassanakbar4 opened 6 years ago

hassanakbar4 commented 6 years ago

component_vocabulary type_enhancement | by tte@cs.fau.de


In RFC terminology section, terms are usually defined via a hangText, eg:

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: ->"ACP domain certificate" 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 2021-10-20 18:26:24 +0500_
hassanakbar4 commented 6 years ago

@{"email"=>"julian.reschke@gmx.de", "name"=>nil, "username"=>nil} commented


I agree that the formatter should handle that better.

In my formatter, it seems to work right, see file:///C:/projects/xml2rfc/v3test.html#n-referring-to-list-items.

hassanakbar4 commented 6 years ago

@{"email"=>"julian.reschke@gmx.de", "name"=>nil, "username"=>nil} uploaded file xref-tests.xml (23.6 KiB)

test case

hassanakbar4 commented 6 years ago

@{"email"=>"julian.reschke@gmx.de", "name"=>nil, "username"=>nil} uploaded file xref-tests.txt (14.9 KiB)

TXT produced by xml2rfc

hassanakbar4 commented 6 years ago

@{"email"=>"julian.reschke@gmx.de", "name"=>nil, "username"=>nil} uploaded file xref-tests.html (44.7 KiB)

sample HTML output from rfc2629.xslt

hassanakbar4 commented 4 years ago

@{"email"=>"rjsparks@nostrum.com", "name"=>nil, "username"=>nil} _changed status from new to under_review_

hassanakbar4 commented 4 years ago

@{"email"=>"rjsparks@nostrum.com", "name"=>nil, "username"=>nil} commented


This is OBE for v2, but there may still be an analogous enhancement to be made in v3.