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

xml anchor elements not used (anymore?) #1156

Closed
1 task done
reschke opened this issue Sep 9, 2024 · 2 comments
Closed
1 task done

xml anchor elements not used (anymore?) #1156

reschke opened this issue Sep 9, 2024 · 2 comments
Labels
bug Something isn't working

Comments

@reschke
Copy link
Contributor

reschke commented Sep 9, 2024

Describe the issue

It appears that xml2rfc now throws away anchor information from the source document and always uses the "slugifiedName".

Example from rfc9110.xml:

    <section anchor="range.requests" numbered="true" removeInRFC="false" toc="include" pn="section-14">
      <name slugifiedName="name-range-requests">Range Requests</name>

So "range.request" should appear in the HTML.

However (rfc9110.html):

 <h2 id="name-range-requests">
<a href="#section-14" class="section-number selfRef">14. </a><a href="#name-range-requests" class="section-name selfRef">Range Requests</a>
      </h2>

I believe in the past it used both (one for "id=" one for "href=").

In any case, this is a serious problem as it breaks existing anchors in content.

Code of Conduct

@reschke reschke added the bug Something isn't working label Sep 9, 2024
@reschke reschke changed the title xml anchor elements not used anymore xml anchor elements not used (anymore?) Sep 9, 2024
@reschke
Copy link
Contributor Author

reschke commented Sep 9, 2024

Sorry for the noise; apparently the "proper" anchor is on the enclosing element.

It's still bad that the "self link" chooses the wrong anchor, though.

@reschke reschke closed this as completed Sep 9, 2024
@royfielding
Copy link

royfielding commented Sep 9, 2024

It is not appropriate for the tools to override the anchor names chosen by the authors. We deliberately chose those names and expect them to appear in all section and ToC references. It is still a bug even if the old references work, since we do not want two or three alias names for every section ref. We only want the ones that are authored in the XML.

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

2 participants