pkp-lib
pkp-lib copied to clipboard
pkp
Redesign submission lists to improve submission tracking and discovery
Summary
Describe the problem you would like to solve
Editors spend a lot of time using the submissions list to manage submissions and other editorial assignments. To do their work more quickly, they want the lists to show more information, provide more tools to find submissions, take actions more quickly, and distinguish between different assignments.
Describe the solution you'd like Redesign the submission lists to accomodate more information and support a UI framework that can grow over time to include more features.
Who is asking for this feature? This is a longstanding community priority. See further details below.
Motivating Issues
- Tracking submissions in the review stage #4172, #7488
- Distinguishing between editor, author and reviewer assignments #4975
- Requests for more filters #5263, #7489 that have made the filter list large and unwieldy
- Allow common editorial actions to be taken directly from the submissions list #7490, #7491
- Separate declined and published submissions #7494
- Unable to use submissions lists on small screens
Proposal
@Devika008 has created the following mockups and conducted extensive user research and testing. The final details may continue to evolve, but the broad proposal should be considered final.
- A new submissions dashboard for editors with more details and additional views to help editors track submissions.
- A summary panel that can be opened with more details and actions for each submission.
Further mockups are available in the different issues below
Issues
This is a major undertaking scheduled for the 3.5 milestone. As such a large feature, we have broken it down into smaller issues. These have been further split into critical and optional issues.
Critical Issues
These issues must be completed in the 3.5 milestone in order to migrate from the old submissions list to the new submissions list.
- #8879
- #8880
- #8881
- #8882
- #8883
- #8884
- #8885
- #8886
- #8887
- #4975
Optional Issues (in order of priority)
These issues are optional, but many are high value. We hope at least some of them can be completed for 3.5. These are ranked in order of priority, based on user research to determine what would be most useful. The top issues should be worked on first.
- #8888
- #8889
- #8890
- #8891
- #8892
- #8893
- #8894
- #8895
- #8896
- #8897
- #8899
Original Proposal
The mockups above and in the linked issues were compiled after extensive user research. They are an evolution of an original proposal from 2021.
Original Proposal
The video below introduces proposed mockups that bring together feature requests and proposals from several other issues into a single, coherent design. However, they are just proposals. No decisions have yet been made about the precise design of the new submissions lists or how it will operate.
Video walkthrough of proposals
List View
The following mockup shows a proposal for a list-based view of submissions. The list-based view is easy to adapt to small screens, but it is harder to fit lots of information on the screen and even harder for a plugin to add its own information.
Table View
The following mockup shows a proposal for a table-based view of submissions. The table view allows plugins to easily add/remove columns. However, extra work would need to be done to ensure it worked on small screens.
The columns shown here are suggestions. Which columns are shown will depend on how important they are. It may even be possible to let users configure which columns they see.
Mobile View
The following mockup shows a simplified view for mobile phones. The dropdown toggle would expand more complete details for each submission.
Groups instead of separate lists
Instead of having separate tabs for different submission lists (My Queue, All Active, Archived), the new submission list will only have a single list. The user can view one of the following groups at a time:
| Group | Description |
|---|---|
| Assigned to me | Same as "My Queue" |
| All Active | No change |
| Unassigned | No change |
| Scheduled for Publication | Any submissions with the scheduled for publication status. In OJS this is a submission scheduled for publication in an issue that is not yet published. |
| Published | Published submissions |
| Declined | Declined submisssions |
| Incomplete | Incomplete submissions. Incomplete submissions should only show in this group and not appear in any other groups. |
Filter Groups
The number of filters has gotten pretty large. The new list should organise these filters into dropdowns so they are easier to find and use.
A filter group can be expanded to show the filters in it.
Review Assignments
The new lists can show more details about the review stage. See more detailed mockups at #4172.
Quick Actions and Details
In the List View, each submission will expand to show further actions and information.
In the Table View, more of the information and actions are shown in each row. However, additional information and actions is available through the Edit button.
This is an additional comment that came up in a working group at the Helsinki Sprint:
Incomplete submissions currently show to the Editor within the All Active list. This causes unnecessary ‘noise’ within the submission list, where the editor is presented with article data that has not actually been submitted to the journal. This adds unnecessary content to the submission list and makes it harder for the Editor to find their tasks.
Describe the solution you'd like Remove the Incomplete submissions from the default All Active list so that an editor does not see them each time they enter the list.
The Incomplete submissions should still be available via the ‘Incomplete’ filter option, should an editor need to access them.
Hello I made PR for this issue: OJS pkp/ojs#3808
you can see screenshots in pkp lib pkp/pkp-lib#8722
ui-library pkp/ui-library#265
thank you
Wow, @forgive38, this is a lot of work! The screenshots look great. At the moment, we are finalizing our plans for the submission list for 3.5. Our designer, @Devika008, has adapted the proposal above and is testing out a couple of different mockups with users. We plan to work on this a lot in 3.5, but there are still some changes to come to exactly how it will work. If you would email me directly (my email is natew at the domain name name publicknowledgeproject.org), I can talk to you more about our plans and we can discuss how to make the best use of your work here.
PRs pkp-lib: https://github.com/pkp/pkp-lib/pull/9198 ui-library: https://github.com/pkp/ui-library/pull/277 OJS: https://github.com/pkp/ojs/pull/3991
Edit OMP: https://github.com/pkp/omp/pull/1440 OPS: https://github.com/pkp/ops/pull/554
This adds basic support for the new submission lists UI and API endpoints. As this disrupts tests, it's available through switching on the enable_new_submission_listing flag in the config.
It appears that the modification of ui-library in components\Table\ causes failure of jobs panel rendering. @jardakotesovec, do you have time to look at this? I'm not much familiar with Vue 3 syntax.
To reproduce:
- Go to the Administration -> Jobs and click on the view jobs
- See that the content (header) of the jobs panel isn't rendered
- Run
php lib/pkp/tools/jobs.php testand refresh the page - See that newly created jobs are also not shown.
Hi all! I've taken a quick first look (https://github.com/pkp/pkp-lib/pull/9198#pullrequestreview-1563443965); this won't break OMP and OPS if merged as a WIP, right? If not, please go ahead as you see fit :+1:
Very much looking forward to seeing this all come together!
Hello,
After a lot of user and data backed research, I have refined the above designs further to meet accessibility guidelines as well as staying consistent with the overall design system. Here are the revised designs.
A. A new submissions dashboard for editors with more details and additional views to help editors track submissions.
B. A summary panel that can be opened with more details and actions for each submission.
- For Desk-Review Stage
- For Review Stage
- For copyediting Stage
- For Production Stage
- For a submission thats scheduled for publishing
