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.

Sign up for GitHub

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

Jump to bottom

Do not use "eprint" as a type #22

Closed
goerz opened this issue Jul 29, 2023 · 0 comments · Fixed by #23
Closed

Do not use "eprint" as a type #22

goerz opened this issue Jul 29, 2023 · 0 comments · Fixed by #23

Comments

@goerz
Copy link
Contributor

goerz commented Jul 29, 2023

In

BibInternal.jl/src/bibtex.jl

Line 83 in 3c39efa

"eprint" ∈ keys(fields) && (fields["_type"] = "eprint")

any bibtex entry that has an "eprint" field gets converted to an "eprint" type. I'm not sure why: "eprint" is not a valid bibtex style.

It should be pretty common to have a published article (@article class) that also is available as a preprint. The original type should always be preserved. Otherwise, it is not possible to format the full citation correctly.

For publications that are only available as a preprint, it's perfectly fine to use the @article class (with the arXiv ID as the "journal"), or there's @unpublished/@misc if people prefer that. There is no need to use eprint as a type.

Could you get rid of the "eprint" type? The current behavior is a blocker for JuliaDocs/DocumenterCitations.jl#20 (comment), so until this is fixed, I'll probably have to monkeypatch BibInternal.make_bibtex_entry.

The solution might be as easy as just removing that line, but I don't know to what extent this may affect your test suite.
goerz added a commit to goerz-forks/BibInternal.jl that referenced this issue Jul 29, 2023
@goerz
Do not use "eprint" as a type
6a0dad5 
Closes Humans-of-Julia#22
This was referenced Jul 29, 2023
Merged
Merged
Azzaare pushed a commit that referenced this issue Oct 17, 2023
@goerz
Do not use "eprint" as a type (#23)
c9c8efe 
Closes #22
goerz added a commit to JuliaDocs/DocumenterCitations.jl that referenced this issue Oct 25, 2023
@goerz
Remove workarounds for bugs fixed in BibInternal 0.3.5
73cc7ca 
The release of `BibInternal v0.3.5` solved issue
Humans-of-Julia/BibInternal.jl#22 related to
preprints. Our monkey-patch of `BibInternal.make_bibtex_entry` to work
around this is no longer necessary.

The release also solved issue
Humans-of-Julia/BibInternal.jl#21, so the
description of the workaround in the documentation can be removed.

Note that `BibInternal` is only an implicit dependency (via
`Bibliography.jl`). The lowest compat-bound for `Bibliography.jl`,
that is, `v0.2.15`, is compatible with `BibInternal v0.3.5`. So that
version should be installed automatically. Someone would have to go out
of their way to pin an older version of `BibInternal` in their
environment. Dealing with any resulting bugs in that case is on them.
@goerz goerz mentioned this issue Oct 25, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Do not use "eprint" as a type goerz-forks/BibInternal.jl
1 participant
@goerz