Download reviews

[MrRob100]

The ability to download reviews in PDF format with the options 'Export author-friendly version of the form, displaying only sections marked as visible to the author' or 'Export editor version of the form, displaying all sections of the review form'. These options will be available from the 'Read review' modal

PRs: https://github.com/pkp/ojs/pull/4512 https://github.com/pkp/pkp-lib/pull/10226 https://github.com/pkp/ui-library/pull/410 https://github.com/pkp/omp/pull/1757

Implementation:

Examples of a downloaded reviews:

[MrRob100]

@Devika008 I would like to revisit this and get your ideas about the design of this please :)

[LetyBA]

I find this incredibly helpful, it is in process of development as a plugin?

[MrRob100]

@LetyBA No, it's in process of development for OJS 3.5 :)

[LetyBA]

We use 3.3.15 but maybe could work hehe or maybe if possible the developers could consider a friendly plugin for older versions... Thank you!

[Devika008]

@MrRob100 on it! Sharing the designs with you in some :D

[Devika008]

My Proposal

One common concern users frequently voice about OJS is its heavy reliance on clicks and modals, leading to a frustratingly lengthy process just to perform a single action. To address this issue, I've streamlined the interface by significantly reducing the number of modals and clicks required to make decisions. Instead, I've condensed the options into a convenient dropdown menu with Text Only Buttons. This not only enhances user experience but also demonstrates the platform's adaptability, as evidenced by the inclusion of alternative formats beyond just PDF, ensuring future scalability and flexibility.

I'm interested in hearing your thoughts on this proposal.

PS: Please mind the proportions as I have used actual button sizes and dropdown on a screenshot so that Its easier to pick dimensions when coding it

[MrRob100]

@Devika008 Thanks, this crossed our minds. Great to have your input. Although I've just realised this will use the new side modal style right? In any case, this will make the dev a lot simpler too as we won't have a nested modal @jardakotesovec

[MrRob100]

@asmecher About the downloading of reviews in XML format, I want to confirm whether this will be XML in JATS XML format or a more freeform structure. Can you provide a use case for downloading them in XML to give me an idea how to structure this XML for a review.

[asmecher]

@MrRob100, that's right, it should be JATS XML. The JATS4R recommendations for peer review provides best practices on this; see: https://jats4r.niso.org/peer-review-materials/ Let me know if you've got any specific questions about this and I'm happy to work through it here!

[MrRob100]

@MrRob100, that's right, it should be JATS XML. The JATS4R recommendations for peer review provides best practices on this; see: https://jats4r.niso.org/peer-review-materials/ Let me know if you've got any specific questions about this and I'm happy to work through it here!

@asmecher Thanks, I have ran into some issues creating a structure for this XML. The minimum requirements for an article (https://jats4r.niso.org/peer-review-materials/#example-2-minimal-requirements-for-an-article) show that a DOI and publication date need to be provided, but articles at this stage of review don't have those data yet. Are we able to structure the data in a different way for the XML download?

[asmecher]

@MrRob100, I would suggest getting as close as you can to the JATS4R recommendations, but omitting any data that is not available. These are recommendations, and not subject e.g. to validation errors, but good guidelines for us to shoot for.

[MrRob100]

We use 3.3.15 but maybe could work hehe or maybe if possible the developers could consider a friendly plugin for older versions... Thank you!

@LetyBA Apologies for taking a while but this feature is now in an open source plugin that supports OJS 3.3 and 3.4 https://github.com/ubiquitypress/ojs-plugin-download-reviews

[ewhanson]

Hey @MrRob100, aside from a minor style/formatting issue with pkp-lib, it looks good to me! Once that change has been made, could you rebase it against the main branches again as well a squash down each PR to a single commit? Then assuming no merge conflicts, I should be able to merge it. Thanks!

[ewhanson]

Thanks, @MrRob100. All merged! 🎉