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

[Idea] Change author metadata schema to CITATION.cff spec #6

Open
burgerga opened this issue Nov 14, 2024 · 2 comments
Open

[Idea] Change author metadata schema to CITATION.cff spec #6

burgerga opened this issue Nov 14, 2024 · 2 comments

Comments

@burgerga
Copy link

If the author metadata schema is slightly changed, support for https://citation-file-format.github.io/ would become easy, and can be generated with a simple script.

So instead of

authors:
  - name: Egon Willighagen
    orcid: 0000-0001-7542-0286

We would need

authors:
  - given-names: Egon
    family-names: Willighagen
    orcid: 0000-0001-7542-0286

According to the CITATION.cff spec, names can be split over 4 fields:

  1. Values for family-names specify family names, including combinations of given and patronymic forms, such as Guðmundsdóttir or bin Osman; double names with or without hyphen, such as Leutheusser-Schnarrenberger or Sánchez Vicario. It can potentially also specify names that include prepositions or (nobiliary) particles, especially if they occur in between family names such as in Spanish- or Portuguese-origin names, such as Fernández de Córdoba.
  2. Values for given-names specify given and any other names.
  3. Values for name-particle specify nobiliary particles and prepositions, such as in Ludwig van Beethoven or Rafael van der Vaart.
  4. Values for name-suffix specify suffixes such as Jr. or III (as in Frank Edwin Wright III).

I would leave orcid and affiliation as is, and convert that to spec in script.

Although CITATION.cff is for software and datasets, you can set preferred-citation to the article type, see https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md#credit-redirection

@inutano
Copy link
Contributor

inutano commented Nov 16, 2024

Sounds good to me. Any concerns? Backward compatibility? @egonw @pjotrp

@egonw
Copy link
Collaborator

egonw commented Nov 16, 2024

Sounds good to me too. We have to make sure we update all the code that depends on it (obviously).

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

No branches or pull requests

3 participants