Skip to content

Added Hayagriva YAML export#10451

Merged
Siedlerchr merged 5 commits into
JabRef:mainfrom
JawadTUE:fix-for-issue-10382
Oct 19, 2023
Merged

Added Hayagriva YAML export#10451
Siedlerchr merged 5 commits into
JabRef:mainfrom
JawadTUE:fix-for-issue-10382

Conversation

@JawadTUE

@JawadTUE JawadTUE commented Oct 6, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor

Fixes #10382

I added Hayagrive YAML export based on their documentation.

The following fields are not included, because I did not find a relevant field for them in Jabref: parent, affiliated, issue, volume-total, page-total, time-range, runtime, serial-number, language, archive, archive-location.

HayagrivaType.java contains the mapping from Jabref type to Hayagriva Entry Type.

I confirmed that the exported .yaml file works with the typst system by using hayagriva literature.yml reference as stated in their documentation.

screenshot

Mandatory checks

  • Change in CHANGELOG.md described in a way that is understandable for the average user (if applicable)
  • Tests created for changes (if applicable)
  • Manually tested changed features in running JabRef (always required)
  • Screenshots added in PR description (for UI changes)
  • Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
  • Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

@Siedlerchr

Siedlerchr commented Oct 6, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

I think this looks already good. However, I think it's not necessary to have the own author formatter as they say they can be specified either in square brackets or in verbose mode with multiple authors under each other:

jabref/src/main/resources/resource/layout/yaml.layout

Lines 3 to 6 in 3f53201

\begin{author}
author:
- literal: "\author"
\end{author}

could be reused here as well? (except the "literal")

Edit// Parent could refer to the crossref (e.g. inbook -> book) field in JabRef, but I don't know if or how this can be used in layouts. I would leave this out.

@Siedlerchr

Siedlerchr commented Oct 6, 2023

Copy link
Copy Markdown
Member

Can you also please add a test for this? See the YamlExporterTest as an example

@Siedlerchr Siedlerchr added the status: changes-required Pull requests that are not yet complete label Oct 12, 2023
@Siedlerchr

Siedlerchr commented Oct 16, 2023

Copy link
Copy Markdown
Member

@JawadTUE How is the status here? Codewise it looked already good. Just unit tests missing

@JawadTUE

JawadTUE commented Oct 16, 2023

Copy link
Copy Markdown
Contributor Author

I will finish this by tomorrow.

@JawadTUE

JawadTUE commented Oct 16, 2023

Copy link
Copy Markdown
Contributor Author

I added the unit tests. These are basically the same as the tests in YamlExporterTest.java, with one extra test exportsCorrectMultipleAuthors to test that multiple authors are correctly exported.

@JawadTUE JawadTUE marked this pull request as ready for review October 16, 2023 18:51
@Siedlerchr Siedlerchr added status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers and removed status: changes-required Pull requests that are not yet complete labels Oct 18, 2023
@Siedlerchr Siedlerchr added this pull request to the merge queue Oct 19, 2023
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to no response for status checks Oct 19, 2023
@Siedlerchr Siedlerchr added this pull request to the merge queue Oct 19, 2023
Merged via the queue into JabRef:main with commit b6d8f82 Oct 19, 2023
@JawadTUE JawadTUE deleted the fix-for-issue-10382 branch October 28, 2023 09:41
@JawadTUE JawadTUE mentioned this pull request Oct 28, 2023
Closed
2 tasks
@JawadTUE JawadTUE mentioned this pull request Nov 12, 2023
Merged
6 tasks
@YDX-2147483647 YDX-2147483647 mentioned this pull request Jan 27, 2026
Open
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Siedlerchr Siedlerchr Siedlerchr approved these changes

Assignees

No one assigned

Labels

component: export-or-save status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Typst-flavored (Hayagriva) YAML export

3 participants

@JawadTUE @Siedlerchr @ThiloteE