Turn reference URLs into hyperlinks #2234
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
added 7 commits
May 13, 2024 15:35
Move the common functionality of the Reference and PublishedReference classes into a common abstract base class.
This field should hold the URL of the cited work, if any. In most cases, this should be easy to determine by searching for a regular expression. However, if that pattern is changed in the future, we may not want the new rules to apply retroactively. Therefore, for published projects, store the URL in a model field, and perform a one-time migration to compute this field for existing published projects.
Like the url field of PublishedReference, this should contain the URL of the cited work, if any. Unlike published references, this can be automatically derived from the description, since the results can be checked in the project preview before publishing.
When a project is published, the URL field of each reference should be copied from the active Reference object to the new PublishedReference object.
If a reference has a URL, this should be transformed into a clickable link. This is done using either the saved url field (PublishedReference) or the automatically-derived url property (Reference).
If a reference has a URL, this should be transformed into a clickable link; this is done automatically by the BaseReference html_description property.
|
looks great, thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
References in the References section should include a link, if a URL is provided. Fixes issue #658.
I changed my mind many times about how this should be implemented. At first, I thought that we should separately provide "description" and "URL" fields for authors to edit.
But now I think, actually, the URL is part of the formal reference, and should be displayed as text for transparency's sake. So I think it's better for the URL to be extracted automatically from the description.
On the other hand, I don't want to have ad-hoc parsing rules applied at runtime to published content. (It's possible those rules might change in the future, which I think is okay for active but not for published projects.) So I ended up with this approach:
descriptionandurlseparately via Django admin, but it will only appear as a link if theurlappears verbatim within thedescription.