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

[INFRA] Update CITATION.cff with all BIDS paper references #1660

Open
sappelhoff opened this issue Nov 21, 2023 · 7 comments · May be fixed by #1743
Open

[INFRA] Update CITATION.cff with all BIDS paper references #1660

sappelhoff opened this issue Nov 21, 2023 · 7 comments · May be fixed by #1743

Comments

@sappelhoff
Copy link
Member

Within this file:

cff-version: 1.2.0

we should add a section "References", as described here: https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md#references

And in that section, we should add the data for all the papers that we list here: https://bids-specification.readthedocs.io/en/latest/introduction.html#citing-bids

@Remi-Gau
Copy link
Collaborator

I'd be in favor of of maybe not doing because we'll have to keep updating the citation.cff file AND the "how to cite" with every new BEP paper.
Would rather have a single place for that information.

@Remi-Gau
Copy link
Collaborator

or we could have the citation.file be the place where we store that info and use a macro to update the src/introduction.md

@sappelhoff
Copy link
Member Author

or we could have the citation.file be the place where we store that info and use a macro to update the src/introduction.md

I would be in favor of this solution, as it'd make the "how to cite" part machine readable and standardized.

@Remi-Gau
Copy link
Collaborator

or we could have the citation.file be the place where we store that info and use a macro to update the src/introduction.md

I would be in favor of this solution, as it'd make the "how to cite" part machine readable and standardized.

ok so time to add some more macros...

@Remi-Gau Remi-Gau linked a pull request Mar 21, 2024 that will close this issue
@Remi-Gau
Copy link
Collaborator

Hum... Wondering if we should not put those references in a bib file and rely on mkdocs plugins.

@sappelhoff
Copy link
Member Author

Both seem to have their benefits and drawbacks.

  • CITATION.cff
    • + it's part of the standardized file and may even populate zenodo metadata for the PDF spec release
    • - it'd need a custom macro to put it into the spec text
  • bib file
    • + can rely on mkdocs plugins, no macro needed (??)
    • - need to add an additional file to the repo, and citation metadata is split over files

@Remi-Gau
Copy link
Collaborator

other + for bib file:

  • allows standardization of ALL references in the spec (not many so far but makes it easy to scale up)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In Progress
Development

Successfully merging a pull request may close this issue.

2 participants