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

References should usually be hyperlinks #658

Closed
bemoody opened this issue Aug 6, 2019 · 0 comments
Closed

References should usually be hyperlinks #658

bemoody opened this issue Aug 6, 2019 · 0 comments

Comments

@bemoody
Copy link
Collaborator

bemoody commented Aug 6, 2019

Citations shown in project pages should contain a link to the resource in question, if it's available online.

Either the entire text or just the title of the work should be a link.

Obviously it's up to the author and/or editor to supply an appropriate stable URL (though a DOI would be preferable and could be auto-detected.)

tompollard added a commit that referenced this issue May 13, 2024
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:
- For active projects, the URL is extracted by a regular expression
whenever it's needed.
- When a project is published, the automatically-extracted URL is saved
as a model field.
- For published projects, it's possible to edit the `description` and
`url` separately via Django admin, but it will only appear as a link if
the `url` appears verbatim within the `description`.
@bemoody bemoody closed this as completed Jul 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant