ITK icon indicating copy to clipboard operation
ITK copied to clipboard

WIP: DOC: Add a BibTeX file with the recommended ITK references

Open jhlegarreta opened this issue 2 years ago • 5 comments

Add a BibTeX file with the recommended ITK references.

PR Checklist

jhlegarreta avatar Jul 30 '23 23:07 jhlegarreta

Notes:

  • Having the BibTeX files may be useful to import the citations directly.
  • Not sure how best we should modify the README file to show the citations, e.g. whether using the BibTeX keys and a link to the document, whether using https://github.com/vkaravir/bib-publication-list as in https://insightsoftwareconsortium.org/citations, would work, etc.

jhlegarreta avatar Jul 30 '23 23:07 jhlegarreta

What about https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files ?

gdevenyi avatar Jul 31 '23 14:07 gdevenyi

What about https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files ?

Interesting @gdevenyi, thanks ! In that case a tool to convert the BibTeX files into CFF should be run prior to adding them, e.g. https://github.com/citation-file-format/citation-file-format/blob/main/README.md#tools-to-work-with-citationcff-files-wrench

I believe the primary input data should still be BibTeX format. If you wish, you could open an issue to do this: a GHA workflow could be set up to do this, and to write them to the same folders as the BibTeX files, and if something has changed, the action would automatically open a PR ?

Maybe it can be left as a separate/future PR, and to get the CFF files for the first time, we can run it manually, and add the files to this PR.

jhlegarreta avatar Jul 31 '23 23:07 jhlegarreta