bids-specification icon indicating copy to clipboard operation
bids-specification copied to clipboard

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

Open sappelhoff opened this issue 1 year ago • 7 comments

Within this file: https://github.com/bids-standard/bids-specification/blob/f7d12988107ff056e049cb6e54458ca57775e190/CITATION.cff#L3

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

sappelhoff avatar Nov 21 '23 15:11 sappelhoff

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 avatar Mar 20 '24 22:03 Remi-Gau

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

Remi-Gau avatar Mar 20 '24 22:03 Remi-Gau

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.

sappelhoff avatar Mar 21 '24 14:03 sappelhoff

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 avatar Mar 21 '24 14:03 Remi-Gau

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

  • See https://github.com/bids-standard/bids-specification/issues/403#issuecomment-692546853

Remi-Gau avatar Mar 21 '24 23:03 Remi-Gau

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

sappelhoff avatar Mar 22 '24 09:03 sappelhoff

other + for bib file:

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

Remi-Gau avatar Mar 22 '24 12:03 Remi-Gau