Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hyperlink generation failure #30

Open
JayDaley opened this issue Nov 3, 2022 · 3 comments
Open

Hyperlink generation failure #30

JayDaley opened this issue Nov 3, 2022 · 3 comments
Labels
bug Something isn't working

Comments

@JayDaley
Copy link

JayDaley commented Nov 3, 2022

See section 3.2.3 of https://datatracker.ietf.org/doc/html/rfc5741 where there is a generated link for an unlinkable URL (as the URL contains an pseudocode parameter) but the linked text is only part of the usable URL (see where the </a> is placed).

The HTML is

  &quot;Information about the current status of this document, any
  errata, and how to provide feedback on it may be obtained at
  <a href="http://www.rfc-editor">http://www.rfc-editor</a>.org/info/rfc&lt;rfc-no&gt;.&quot;

which appears onscreen as

"Information about the current status of this document, any
errata, and how to provide feedback on it may be obtained at
http://www.rfc-editor.org/info/rfc<rfc-no>."

@JayDaley JayDaley added the bug Something isn't working label Nov 3, 2022
@rjsparks
Copy link
Member

rjsparks commented Nov 6, 2022

cc @larseggert

@larseggert
Copy link
Collaborator

https://sandbox-htmlize.ietf.org/doc/html/rfc5741#section-3-2-2 has the same issue, because that document has no proper HTML available. So it won't be fixed in the future either.

We could try and tweak the regexes, but given that there is no test suite I am afraid it will cause breakage elsewhere.

@GWHAYWOOD
Copy link

I understand that the following may be a regex issue, so I'm adding it to #30. I've tried and failed to read CONTRIBUTING.md - it's a blank page in my browser and it didn't come with a git checkout so I gave up. Please feel free to update/move/delete/admonish as required.

If there's no test suite, in my naïvety I imagine that it wouldn't be impossible for me to come up with something to test any changes to the regexes, even if all it did was compare the output from the new regexes with that from the old. A shell script employing wget and diff ought to do it. Observations?

8<--------------------------------------------------------------------------------------

RFC1112 has two appendices, Appendix I and Appendix II.

First error:

In the document, the first reference to one of these appendices is in
section 4 "Host Group Addresses" and is a reference to Appendix II.

In the HTML version at for example

https://datatracker.ietf.org/doc/html/rfc1112

there is an HTML link in the section 4 reference:

[quote]
Appendix II contains some background discussion of several issues
related to host group addresses.
[/quote]

The link is incorrectly formed, as should be obvious. The second 'I'
in the Roman numeral 'II' is wrongly placed outside the anchor tag and
the link refers to 'appendix-I' instead of 'appendix-II'.

Second and third errors:

There are no targets at the two appendices, thus clicking on the
existing links, whether correct or not, does nothing anyway...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

4 participants