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

Bump DocumenterCitations to v1.0.0 #2598

Closed
wants to merge 3 commits into from
Closed

Bump DocumenterCitations to v1.0.0 #2598

wants to merge 3 commits into from

Conversation

lgoettgens
Copy link
Member

WIP

DocumenterCitations (the package that we use for references in the documentation) has received a major update including some breaking changes and a lot of new fancy stuff.
I will first try to get it to work exactly like it does currently with the old version and then try to nice things up.

@lgoettgens
Copy link
Member Author

lgoettgens commented Jul 27, 2023

Notable changes:

  1. It now computes the reference strings (e.g. [AL94]) itself, instead of using the identifiers from the oscar-bibliography.bib.
  2. The hyperlink to the DOI or URL has moved from the title to the journal info. This has been made to mimic the APS Journals.
  3. There are neat commands for including a citation in a sentence, see https://juliadocs.org/DocumenterCitations.jl/stable/gallery/#alphabetic_style

Points 1. and 2. can be changed by using a custom style instead of the :alpha style shipped with DocumenterCitations.
After the discussion has been settled here, I could adapt this in a similar fashion to the other repos.

A preview should be available here: https://docs.oscar-system.org/previews/PR2598/
In particular https://docs.oscar-system.org/previews/PR2598/references/

@fingolfin
Copy link
Member

Lots of issues with this new version

  • it failed to include some references, such as
    • BDEPS04
    • BES-E-D21
    • DF20
    • DLRS10
    • DHS98
    • ... I stopped writing down, but there are many more missing
  • it doesn't handle multiple papers with the same author list and same year of appearance, such as BJR10 (which occurs twice)
  • only the first three authors seems to matter, so e.g. BHMPW20 has become BHM20 (and many similar cases)
  • BKR20 is also gone
  • OMdCS00 has become CS00 but the last name of Ignacio is "Ojeda Martínez de Castilla" and clearly does not start with C, it starts with O (similar story for C-MLS20 and C-MLS21)
  • it doesn't like Umlauts much, maybe? see [Gr\03] B. Grünbaum. Convex polytopes.
  • the new placement of links fails for the Atlas, i.e. WWT (formerly WWTSPNNLBA -- perhaps this is an instance where a custom name like [Atlas] would be more suitable?)

All in all, let's stay away from alpha mode, I am not sure they can fix the above issues.

Also, clearly we must figure out why it drops items.

On the upside, I do like the new styling.

(BTW I am somewhat grumpy that they did not migrate the existing repository, or turn a fork into the the new "main" repo (GitHub will do that when asked) but instead created a new repo from scratch, thus loosing all the old issues and making it harder to discover that a move occurred unless one surfs to the old repo and reads the README sigh)

@benlorenz
Copy link
Member

it failed to include some references, such as ...

There is the following entry in the NEWS file:

Only cited references are included in the main bibliography by default, as opposed to all references defined in the underlying .bib file.

So we might need this (see here):

```@bibliography
*
```

@lgoettgens
Copy link
Member Author

lgoettgens commented Jul 28, 2023

  • it failed to include some references, such as

    • BDEPS04
    • BES-E-D21
    • DF20
    • DLRS10
    • DHS98
    • ... I stopped writing down, but there are many more missing

Those are references that are not cited anywhere. Similarly to biblatex defaults, they are thus removed from the bibliography. But if they should be included, this can be added as a one-liner.

  • it doesn't handle multiple papers with the same author list and same year of appearance, such as BJR10 (which occurs twice)

Known. See JuliaDocs/DocumenterCitations.jl#26

  • only the first three authors seems to matter, so e.g. BHMPW20 has become BHM20 (and many similar cases)

Noticed and subject to change, see JuliaDocs/DocumenterCitations.jl#27

  • OMdCS00 has become CS00 but the last name of Ignacio is "Ojeda Martínez de Castilla" and clearly does not start with C, it starts with O (similar story for C-MLS20 and C-MLS21)
  • it doesn't like Umlauts much, maybe? see [Gr\03] B. Grünbaum. Convex polytopes.
  • the new placement of links fails for the Atlas, i.e. WWT (formerly WWTSPNNLBA -- perhaps this is an instance where a custom name like [Atlas] would be more suitable?)

All in all, let's stay away from alpha mode, I am not sure they can fix the above issues.

I would suggest to use the custom style teased in the docs (see https://juliadocs.org/DocumenterCitations.jl/stable/gallery/#Custom-style:-Citation-key-labels), that takes the labels from the oscar-bibliography.bib file as before. Then the few things above do not matter for us.

Also, clearly we must figure out why it drops items.

See above. If we want them, I can easily add them again.

On the upside, I do like the new styling.

(BTW I am somewhat grumpy that they did not migrate the existing repository, or turn a fork into the the new "main" repo (GitHub will do that when asked) but instead created a new repo from scratch, thus loosing all the old issues and making it harder to discover that a move occurred unless one surfs to the old repo and reads the README sigh)

Yeah... I only noticed when I setup a new module and forgot the compat entry for DocumenterCitations and got weird syntax errors.

@lgoettgens
Copy link
Member Author

lgoettgens commented Jul 28, 2023

This gets continued in #2605, as this PR is somehow broken for me.

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

Successfully merging this pull request may close these issues.

3 participants