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

Any valid BibTeX entry should be able to auto-link both a URL and a DOI #63

Closed
goerz opened this issue Nov 4, 2023 · 0 comments · Fixed by #65
Closed

Any valid BibTeX entry should be able to auto-link both a URL and a DOI #63

goerz opened this issue Nov 4, 2023 · 0 comments · Fixed by #65
Labels
bug Something isn't working

Comments

@goerz
Copy link
Member

goerz commented Nov 4, 2023

In DocumenterCitations 1.2, a @book entry could have both a URL and a DOI. The former would be automatically linked from the title, and the latter from the publisher information.

The 1.3 release changed how the auto-links work. From NEWS.md:

There were some subtle changes in how DOI and URL fields are linked in the rendered documentation, which may require adjustments. In particular, in version 1.3.0, non-@article entries that do not have both a title and a booktitle can only have a DOI or a URL, but not both. This most likely occurs for @book entries. For @book entries that have both a DOI and a URL, the URL should be placed in the note field (using \url/\href, as appropriate).

Unfortunately, this means the .bib files that worked fine with version 1.2 had to be modified for version 1.3; arguably a violation of semantic versioning. Thus, the behavior in 1.3 should be considered a bug.

To restore non-breaking compatibility with version 1.2, any entry that defines all the required fields for its specific type should be able to automatically link both a URL and a DOI. For the @book type, both title and publisher/year are required, so it would be safe to link the URL (or DOI, if no URL) from the title and the DOI (if no URL) from the publisher and year information.

Personally, I have some minor aesthetic problems with linking from the publisher, and I would generally prefer to link the URL from the note field for a book that has both a URL and a DOI. However, purely for backwards compatibility, automatic linking should still work, as it worked in version 1.2.

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

Successfully merging a pull request may close this issue.

1 participant