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

handle message output in Zenodo and bibtex backends #385

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

alexlancaster
Copy link

I notice that the message key in CITATION.cff isn't being translated to anything on the Zenodo side.

The equivalent on Zenodo appears to be an additional_description with the type of notes, which formats it in a box to tell the consumer how to use the citation, e.g. https://zenodo.org/records/10648000

This PR implements this translation, turning:

- message: If you use this software, please cite it using these metadata.

into:

"additional_descriptions": {
    "description": "If you use this software, please cite it using these metadata.",
    "type": {
      "id": "notes"
    }
  },

This would again, be another step towards needing to maintain this message in two places.

@alexlancaster alexlancaster changed the title handle message as an additional_descriptions handle message as an additional_descriptions in Zenodo backend Feb 15, 2024
* translates `message` to `note` in bibtex backend
@alexlancaster
Copy link
Author

added support for bibtex output as per discussion on #158 .

@alexlancaster alexlancaster changed the title handle message as an additional_descriptions in Zenodo backend handle message as an additional_descriptions in Zenodo and bibtex backends Feb 15, 2024
@alexlancaster alexlancaster changed the title handle message as an additional_descriptions in Zenodo and bibtex backends handle message output in Zenodo and bibtex backends Feb 15, 2024
@alexlancaster
Copy link
Author

To summarize:

  • Zenodo: message -> additional_descriptions
  • BibTeX: message -> note

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.

1 participant