Add exporter for Citation File Format (CFF) (yaml based)
Is your suggestion for improvement related to a problem? Please describe. JabRef should be able to export citations into the cff file format. There is already an implemented importer which maps bibtex fields. The existing YAML exporter can be easily adapted.
Additional context
https://citation-file-format.github.io/
An example python converter https://github.com/citation-file-format/cffconvert
Hi @Siedlerchr, I would like to work on this issue.
As a general advice for newcomers: check out Contributing for a start. Also, guidelines for setting up a local workspace is worth having a look at.
Feel free to ask here at GitHub, if you have any issue related questions. If you have questions about how to setup your workspace use JabRef's Gitter chat. Try to open a (draft) pull-request early on, so that people can see you are working on the issue and so that they can see the direction the pull request is heading towards. This way, you will likely receive valuable feedback.
Here are some hints_
TLDR: JabRef has the functionality to import CFF (https://github.com/JabRef/jabref/issues/7945), but no functionality for export. This should be implemented.
JabRef should be able to parse Citation File Format (CFF) and export into it.
Links:
- General CFF information: https://citation-file-format.github.io/
- Mapping BibTeX and CFF: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files#citing-something-other-than-software
- Python implementation of a converter: https://github.com/citation-file-format/cff-converter-python
- Description of the BibTeX format: https://docs.jabref.org/advanced/fields
Implementation hints:
The export can either be done by Java code directly or creating .layout files.
Export using .layout files:
See yaml.* in https://github.com/JabRef/jabref/tree/main/src/main/resources/resource/layout
Example: https://github.com/JabRef/jabref/blob/main/src/main/resources/resource/layout/yaml.layout
Documentation on .layout files: https://docs.jabref.org/collaborative-work/export/customexports
Acceptance criteria:
- At least
@articleand@inproceedingsneed to be supported.
Note: If you dislike the .layout format, one can work on replacing that part of JabRef by Java templating engines. See https://github.com/koppor/jabref/issues/392 for details.
Hi @Siedlerchr, I would like to work on this if this issue is still open?
There hasn't been activity here since a month, but Harika has had commits in other repositories, so I assume this one here was abandoned. Hence, I will assign @ShailikaS.
No activity since a while
Hello, could I be assigned this issue?
@garymejia Are you still working on this? Or can other work on this
I can work on this one !
@garymejia are you still on it?
Hey @ThiloteE, I started working on this issue a bit late. I'm okay with being unassigned this issue since I was still figuring out the formatting requirements for cff. Sorry for the holdup!
ok, then I will assign @JEANPRBT