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

All HTML and PDF links must be hightlighted #1058

Closed
1 task done
ajeanmahoney opened this issue Dec 8, 2023 · 2 comments · Fixed by #1060
Closed
1 task done

All HTML and PDF links must be hightlighted #1058

ajeanmahoney opened this issue Dec 8, 2023 · 2 comments · Fixed by #1060
Assignees
Labels
bug Something isn't working rfc waiting An RFC-to-be is in the "Tools Issue" state and cannot be published until the issue is resolved

Comments

@ajeanmahoney
Copy link
Collaborator

Describe the issue

The effect of PR #963 on xml2rfc HTML output was discussed with the RFC Series Advisory Board (RSAB), which has determined the following:

The RSAB confirms that RFC7993 specifies a policy that requires highlighting of links “for example, through the use of color and/or text decoration”. ... Different handling for links that are used to link terms to a section or definition would require an update to RFC7993. Therefore all links in an RFC must be highlighted.

The details of the assessment can be found here: https://mailarchive.ietf.org/arch/msg/rsab/F9QOvdVX2amsX1bgR4DGVTzQat8/

Please roll back #963.

Code of Conduct

@ajeanmahoney ajeanmahoney added the bug Something isn't working label Dec 8, 2023
@ajeanmahoney ajeanmahoney changed the title All HTML links must be hightlighted All HTML and PDF links must be hightlighted Dec 8, 2023
@kesara kesara self-assigned this Dec 10, 2023
@kesara kesara added the rfc waiting An RFC-to-be is in the "Tools Issue" state and cannot be published until the issue is resolved label Dec 10, 2023
kesara added a commit to kesara/xml2rfc that referenced this issue Dec 11, 2023
@kesara
Copy link
Member

kesara commented Dec 11, 2023

Revert PR #1060 only reverts changes from PR #963.
But the figure captions still have the same issue with unhighlighted links (this has been the case for some time).
For example: https://www.rfc-editor.org/rfc/rfc9001.html#figure-1

@ajeanmahoney
Copy link
Collaborator Author

Just adding some notes here regarding the figure and table captions:
Since the first v3 RFC (RFC 8650), both the figure label (e.g., "Figure 1") and figure caption (e.g., "TLS Layers") link to the top of the figure, but these links are only noticeable when the reader hovers a mouse cursor over them. There is some documentation in Implementation notes for RFC7991 regarding the figure caption. Table labels and captions work the same way.

The accessibility spot check report mentions these double links (label and caption), and says the following:

If it is important to allow users to share the diagram using the fragment URL then use
only one link to encompass the caption text and ensure that the link targets the
<figure> container.

Note that users may achieve a similar outcome by using the permalink for the section
heading. If this feature is sufficient, the link mark-up can be removed from both text
elements in the caption.

Maybe the visibility of label and caption links should be a separate issue.

kesara added a commit that referenced this issue Dec 11, 2023
This reverts: "feat: Lighter styling on internal iref links (#963)"
See https://mailarchive.ietf.org/arch/msg/rsab/F9QOvdVX2amsX1bgR4DGVTzQat8/

This reverts commit dbdda51.

Fixes #1058
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working rfc waiting An RFC-to-be is in the "Tools Issue" state and cannot be published until the issue is resolved
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants
@kesara @ajeanmahoney and others