Fix user-defined markup links targets (#29305) #29666
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This seeks to fix the bug reported on issue go-gitea#29196. Cause: ID's with custom characters (- , _ , etc.), were not linking correctly in the Markdown file when rendered in the browser because the ID in the respective destinies would be different than the one in anchor, while for IDs with only letters, the ID would be the same. Fix: It was suggested that to fix this bug, it should more or less like GitHub does it. While in gitea the anchors would be put in HTML like this: ``` <p dir="auto"><a href="#user-content-_toc152597800" rel="nofollow">Review</a></p> <p dir="auto"><a href="#user-content-_toc152597802" rel="nofollow">Staging</a></p> <p dir="auto"><a href="#user-content-_toc152597803" rel="nofollow">Development</a></p> <p dir="auto"><a href="#user-content-_toc152597828" rel="nofollow">Testing</a></p> <p dir="auto"><a href="#user-content-_toc152597829" rel="nofollow">Unit-tests</a></p> ``` In GitHub, the same anchor's href properties would be the same without "user-content-" trailing behind. So my code made sure to change those anchors, so it would not include "user-content-" and then add respective Event Listeners so it would scroll into the supposed places. Fixes: go-gitea#29196 --------- Co-authored-by: silverwind <[email protected]>
GiteaBot
added
the
lgtm/need 2
pull-request-size
bot
added
the
size/S
delvh
reviewed
Mar 8, 2024
| if (!href.startsWith('#user-content-')) continue; | ||
| const originalId = href.replace(/^#user-content-/, ''); | ||
| a.setAttribute('href', `#${encodeURIComponent(originalId)}`); | ||
| if (document.getElementsByName(originalId).length !== 1) { |
There was a problem hiding this comment.
Wait, getElementsByName?
Isn't that the wrong call?
Shouldn't it be getElementsByID?
There was a problem hiding this comment.
As far as I know, we use that method because we are considering the cases that we use <a name="link"><\a>. In this condition, we are making it so that those anchors that do not use this notation work as intended by having the event listener.
There was a problem hiding this comment.
It's correct. It targets specifically links with name. A likely better and more specific selector could be document.querySelectorAll('.markup a[name]') so we don't accidentially select other things, but lets not do this in a backport.
There was a problem hiding this comment.
Even better selector: a.closest('.markup').querySelectorAll('a[name]')
This will ensure it will only search for the target in the current markup document which is important because there can be multiple documents being rendered. I can follow up with this change targeting main branch later.
silverwind
approved these changes
Mar 8, 2024
GiteaBot
added
lgtm/need 1
GiteaBot
added
lgtm/done
silverwind
added
the
reviewed/wait-merge
GiteaBot
removed
the
reviewed/wait-merge
silverwind
added a commit
that referenced
this pull request
Mar 8, 2024
Followup #29305. As per discussion in #29666 (comment), make this selector only search in the current `.markup` document, as there can be multiples displayed at the same time. @DanielMatiasCarvalho maybe you can review.
GiteaBot
pushed a commit
to GiteaBot/gitea
that referenced
this pull request
Mar 8, 2024
Followup go-gitea#29305. As per discussion in go-gitea#29666 (comment), make this selector only search in the current `.markup` document, as there can be multiples displayed at the same time. @DanielMatiasCarvalho maybe you can review.
silverwind
added a commit
that referenced
this pull request
Mar 9, 2024
Backport #29679 by @silverwind Followup #29305. As per discussion in #29666 (comment), make this selector only search in the current `.markup` document, as there can be multiples displayed at the same time. @DanielMatiasCarvalho maybe you can review. Co-authored-by: silverwind <[email protected]>
DennisRasey
pushed a commit
to DennisRasey/forgejo
that referenced
this pull request
Mar 13, 2024
Backport #29679 by @silverwind Followup go-gitea/gitea#29305. As per discussion in go-gitea/gitea#29666 (comment), make this selector only search in the current `.markup` document, as there can be multiples displayed at the same time. @DanielMatiasCarvalho maybe you can review. Co-authored-by: silverwind <[email protected]> (cherry picked from commit 25b0c99a41e9024d439deaa55be7ba87f6cd557f)
DennisRasey
pushed a commit
to DennisRasey/forgejo
that referenced
this pull request
Mar 13, 2024
Followup go-gitea/gitea#29305. As per discussion in go-gitea/gitea#29666 (comment), make this selector only search in the current `.markup` document, as there can be multiples displayed at the same time. @DanielMatiasCarvalho maybe you can review. (cherry picked from commit baeb2511741aa70d24a48fd46db936b52be9d9dd)
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Backport #29305 by @DanielMatiasCarvalho
This seeks to fix the bug reported on issue #29196.
Cause:
ID's with custom characters (- , _ , etc.), were not linking correctly in the Markdown file when rendered in the browser because the ID in the respective destinies would be different than the one in anchor, while for IDs with only letters, the ID would be the same.
Fix:
It was suggested that to fix this bug, it should more or less like GitHub does it. While in gitea the anchors would be put in HTML like this:
In GitHub, the same anchor's href properties would be the same without "user-content-" trailing behind.
So my code made sure to change those anchors, so it would not include "user-content-" and then add respective Event Listeners so it would scroll into the supposed places.
Fixes: #29196