Automation for putting a project on Zenodo and similar has been discussed before, but something we should think about is if/how we should provide facilities for obtaining bibtex and other bibliographical data for a project. It's not uncommon to see "if you use this project in research, please cite the following paper", and then there is some bibtex snippet.
Ideally, someone would cite both an underlying paper and a specific project version (on Zenodo).
Actually I just thought about citing Coq and I found this: https://zenodo.org/record/3744225#.X00yYy-w1_4 but I wonder how I create a reasonable citation entry from this
they have the bibtex export:
@software{the_coq_development_team_2020_3744225,
author = {The Coq Development Team},
title = {The Coq Proof Assistant, version 8.11.0},
month = jan,
year = 2020,
publisher = {Zenodo},
version = {8.11.0},
doi = {10.5281/zenodo.3744225},
url = {https://doi.org/10.5281/zenodo.3744225}
}
see https://zenodo.org/record/3744225/export/hx
unfortunately this is not at all the best entry, e.g., this will usually be listed with author "T. C. D. Team", and the title will be in lower case: "The coq proof assistant, version 8.11.0"
And I think the publisher is also not what I would expect. Also authors should be there. I think I will generate it from the opam data.
Authors are actually listed in the record as contributors.
Don't know if this is relevant (or still relevant) to this discussion, to get "The Coq Development Team", the following seems to work in bibtex:
author = {{The Coq Development Team}},
title = {The {C}oq Proof Assistant, version 8.11.0},
@Hugo Herbelin yes, with manual editing it works fine, but since the BibTeX is generated, we all have to edit it over and over if we copy it for a new Coq version
Thanks, I now understand the exact problem.
this looks like something we can templatize: https://github.com/Lysxia/coq-simple-io/blob/master/CITATION.cff
It also suggests we probably want to store ORCIDs for all authors in meta.yml
threw together a quick ORCID icon+link proposal based on the ORCID guidelines.
Thoughts? Worth going into the template?
Yes, this looks good.
I rely on Zenodo (https://zenodo.org/static/img/orcid.svg), but figure this is OK since they already host all those badges...
ah, here's a dilemma. If we want to generate the .cff
citation, they store author names like this:
authors:
- given-names: Karl
family-names: Palmskog
Should we consider using this name breakdown in our meta.yml
?
Yes, but is there a way to make it keep the backward-compatible option to provide the author names as today as well (when not generating the .cff
file)?
with some complicated template logic, it can work. If one assumes name
on one hand and given_names
+family_names
on the other hand are mutually exclusive.
again we are a bit hampered by mustache
Last updated: Dec 06 2023 at 15:01 UTC