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

Bibliography link anchors inconsistent #3760

Closed
thofma opened this issue May 18, 2024 · 7 comments · Fixed by #4115
Closed

Bibliography link anchors inconsistent #3760

thofma opened this issue May 18, 2024 · 7 comments · Fixed by #4115
Labels
documentation Improvements or additions to documentation

Comments

@thofma
Copy link
Collaborator

thofma commented May 18, 2024

Looking at https://docs.oscar-system.org/dev/references/, it seems that for the link of an item the anchor (the thing I can click on) is either the title (maybe for books and things in proceedings?) or the journal information (for articles?).

It looks rather odd.

@thofma thofma added the bug Something isn't working label May 18, 2024
@lgoettgens
Copy link
Member

This is not considered a bug by DocumenterCitations.jl but a feature (see e.g. JuliaDocs/DocumenterCitations.jl#63) as this allows for multiple anchors for a single bib entry

@lgoettgens lgoettgens removed the bug Something isn't working label May 18, 2024
@thofma
Copy link
Collaborator Author

thofma commented May 19, 2024

OK. Is this something we can fix with the style?

PS: I still consider this a bug with how our bibliography looks like. Unless you are saying that we do this on purpose and don't want to change it.

@fingolfin
Copy link
Member

I don't understand how the linked DocumenterCitations.jl issue justifies this: all the bib items I looked at had a DOI but not an URL field. While that issue is about putting url and doi links on different text:

... should be able to automatically link both a URL and a DOI ...

So I would still suggest we try to appeal this to them.

But if they refuse this, we should monkey-patch or otherwise hack it, or fork DocumenterCitations. The current behavior is bad.

@lgoettgens
Copy link
Member

I reported this upstream in JuliaDocs/DocumenterCitations.jl#73 and provided a draft PR for this as well. Let's wait for the DocumenterCitations' maintainer's comments there before we roll something too complicated ourselves.

@goerz
Copy link

goerz commented Sep 17, 2024

The current behavior is definitely a conscious design decision, see JuliaDocs/DocumenterCitations.jl#73 (comment). If you only want to have one link (you are careful to only have a DOI or a URL in all entries), then I agree it makes sense to consistently have this link from the title.

I'm open to PRs to DocumenterCitations that add options in the relevant functions so that it would be easy to change the behavior with a custom style.

@lgoettgens lgoettgens added the documentation Improvements or additions to documentation label Sep 19, 2024
@goerz
Copy link

goerz commented Sep 19, 2024

I just tagged DocumenterCitations 1.3.4 with the fixes from JuliaDocs/DocumenterCitations.jl#74

@lgoettgens
Copy link
Member

Thanks a lot for getting this in this quickly!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants