pkp-lib icon indicating copy to clipboard operation
pkp-lib copied to clipboard

Download reviews

Open MrRob100 opened this issue 10 months ago • 11 comments

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

PR: https://github.com/pkp/pkp-lib/pull/10226

Implementation:

Screenshot 2024-07-18 at 16 13 50

Examples of a downloaded reviews:

Screenshot 2024-07-18 at 16 34 40 Screenshot 2024-07-18 at 16 19 59 Screenshot 2024-07-19 at 11 21 22

MrRob100 avatar Apr 10 '24 13:04 MrRob100

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

MrRob100 avatar Apr 11 '24 13:04 MrRob100

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

LetyBA avatar Apr 11 '24 17:04 LetyBA

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

MrRob100 avatar Apr 11 '24 17:04 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 avatar Apr 11 '24 17:04 LetyBA

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

Devika008 avatar Apr 16 '24 13:04 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.

image

image

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

Devika008 avatar Apr 16 '24 14:04 Devika008

@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 avatar Apr 16 '24 14:04 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.

MrRob100 avatar Jul 09 '24 20:07 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 avatar Jul 09 '24 20:07 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!

@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?

MrRob100 avatar Jul 15 '24 14:07 MrRob100

@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.

asmecher avatar Jul 15 '24 23:07 asmecher