Describe the problem you would like to solve
SportRxiv, a preprint server using OPS, would like to be part of the Episciences overlay journals platform. As part of their workflow, the platform uses JATS metadata format to extract and transfer metadata. Currently, only Dublin Core is available as part of the OAI Metadata Format Plugins in OPS. However, this format may not be provide basic metadata only.
Describe the solution you’d like
To improve the richness of metadata required by Episciences, JATS Metadata Format would be more suitable than DC, and should be added as part of the OAI Metadata Format Plugins.
Who is asking for this feature?
Technical Support
Additional information
None
Hi @uOttawa_Library,
Can you clarify whether the Episciences platform requires the JATS XML to contain the preprint’s fulltext, or just its metadata?
OPS might be able to generate a JATS document containing the metadata of the submission, but the body text would require a production process. We’re just adding those tools to OJS but expect it’ll be too labour-intensive to get much uptake for preprints.
Regards,
Alec Smecher
Public Knowledge Project Team
Hi Alec,
Thank you for the reply! They will need the metadata, not the fulltext. They consider the DC Format a bit poor, so they prefer to have the JATS format.
They can still use DC, but they need to complement with richer metadata via the REST API.
They’re also wondering whether it is possible to access all versions of a preprint via OAI-PMH? Or is the latest published version the only one accessible?
Thank you,
Yohann
uOttawa Library
Hi @uOttawa_Library,
We have two plugins we’ve used to accomplish what you’re asking for, but with OJS:
- JATS Template: Generates a JATS document based on submission metadata
- OAI JATS: Exposes that JATS document via the OAI-PMH interface
Both are written for OJS, but converting them to support preprints as well wouldn’t be a huge development task. It’s not something we’d likely prioritize, but I’d be willing to review a PR if you have the capacity.
(Warning: we’re doing a lot of heavy work on the JATS Template plugin at the moment for 3.6, where we’ll be adding the capacity to generate the body text as well.)
In OJS/OMP/OPS 3.5 and prior, the OAI-PMH interface only gives access to the latest version; starting with 3.6 (due for release in Q4, we hope) it will serve each version separately (see #12950), linking them as relations.
Regards,
Alec Smecher
Public Knowledge Project Team
Sounds good, Alec. We’re expecting to upgrade to OPS3.5 early next year. So, upgrading to 3.6 might a long shot from now. Having the two plugins (especially OAI JATS) added in OPS would be a big help for SportRxiv. Now, what is the common practice to go forward. Do we have to create a PR?
Thanks,
Yohann
uOttawa Library
Hi @uOttawa_Library,
Yes, a PR to each of the plugin repositories would be the best way forward, thanks! It sounds like 3.5.0 will be the best target (once you’ve upgraded to it), so you should open the pull requests against the stable-3_5_0 branch. (In case you haven’t done this before – you’ll be asked which branch when creating it.) Happy to talk about process here on the forum when you’re ready to try.
Regards,
Alec Smecher
Public Knowledge Project Team
Hi Alec,
As a beginner in the process, just wondering if those placeholders are the correct ones to create a Pull Request for each of the repositories: oaiJats and jatsTemplate
Thank you,
Yohann
Hi Yohann,
Yes, that’s correct. I see that these are flagged “Can’t automatically merge”, though, which suggests that you’re sending a pull request created against the main branch in against stable-3_5_0, or something similar. Since you want to send in a pull request against stable-3_5_0, as you’ve selected in the dropdown in the screenshot, you’ll also have to make sure you create your pull request starting from that same branch.
We’re happy to guide new contributors through the process; you won’t break anything by sending in a pull request that’s not formatted correctly. (If you’re using AI to write the code, be aware of our AI contribution policy.)
Thanks,
Alec Smecher
Public Knowledge Project Team
Hi Alec,
I see. So, the value from the drop down menu in both base and compare should be both: stable-3_5_0. But when I do so, I get this message:
Thank you,
Yohann
Hi @uOttawa_Library,
It depends on how you’ve done it… Let me describe my workflow (nothing too unusual):
- Fork the repository to your own Github account (from the Github page for that repository)
- Clone it on your local (development) machine, e.g.:
git clone git@github.com:myAccount/oaiJats (where myAccount is your github account)
- Create a new branch on your local machine for the work you want to propose, e.g.:
git checkout -b my_branch_name stable-3_5_0 (where my_branch_name is the name of the new branch you want to create, and stable-3_5_0 is where you want to start it from)
- Modify the code; commit it; and push it up to your Github fork
Now you should see it when you pull down the “branches” dropdown in your Github fork, and you should be able to open a pull request from there. You’ll be submitting it from your my_branch_name fork to PKP’s stable-3_5_0 branch.
Hope that makes sense!
Thanks,
Alec Smecher
Public Knowledge Project Team