diff --git a/docs/Sphinx-guides/source/featureDescriptions.md b/docs/Sphinx-guides/source/featureDescriptions.md index 6a1a703..96e6163 100644 --- a/docs/Sphinx-guides/source/featureDescriptions.md +++ b/docs/Sphinx-guides/source/featureDescriptions.md @@ -9,42 +9,49 @@ All template overrides are implemented in the Service class: `pprOjsPlugin/servi **Area:** Submission
**Title:** Hide the Homepage URL field
**User Story:** We do not need users' personal Homepage URLs. Removing this field will simplify the interface, reduce clutter, and enhance the user experience.
-**Toggle:** N/A +**Toggle:** N/A
**Implementation:** This was implemented by PKP directly. This was implemented with CSS, there is a copy of the CSS code at the end of our CSS file for reference: `pprOjsPlugin/css/iqss.css` **Issue Id:** Issue 08
**Area:** Submission
**Title:** Hide the field ORIC iD
**User Story:** We do not need users' ORIC iD. Removing this field will simplify the interface, reduce clutter, and enhance the user experience.
-**Toggle:** N/A +**Toggle:** N/A
**Implementation:** This was implemented by PKP directly. This was implemented with CSS, there is a copy of the CSS code at the end of our CSS file for reference: `pprOjsPlugin/css/iqss.css` +**Issue Id:** Issue 09
+**Area:** Submission
+**Title:** Hide Preferred Public Name
+**User Story:** We do not need users' Preferred Public Name. Removing this field will simplify the interface, reduce clutter, and enhance the user experience.
+**Toggle:** hidePreferredPublicNameEnabled
+**Implementation:** Implemented with template override: `pprOjsPlugin/templates/common/userDetails.tpl` + **Issue Id:** Issue 010
**Area:** Submission
**Title:** Remove the "Include this contributor in the browse list" Option
**User Story:** As a user, searching for contributors on this platform is unnecessary, as its primary function is peer review rather than journal publication. Including the "Include this contributor in the browse list" option could confuse authors when submitting their papers.
-**Toggle:** N/A +**Toggle:** N/A
**Implementation:** This was implemented by PKP directly. This was implemented with CSS, there is a copy of the CSS code at the end of our CSS file for reference: `pprOjsPlugin/css/iqss.css` **Issue Id:** Issue 013
**Area:** Workflow
**Title:** Hide the Copyediting Tab
**User Story:** As a user, I expect the system to offer peer-review functionality without the option to publish articles exclusively. The presence of a Copyediting tab could lead to confusion among users.
-**Toggle:** N/A - Custom IQSS CSS is always included to OJS. +**Toggle:** N/A - Custom IQSS CSS is always included to OJS.
**Implementation:** Implemented with custom CSS, added selector to hide the Copyediting tab: `pprOjsPlugin/css/iqss.css` **Issue Id:** Issue 019
**Area:** Registration
**Title:** Hide Checkboxes on the Registration Page
**User Story:** As an author registering on our platform, the registration page currently includes three checkboxes: A privacy statement, which is irrelevant as we don't have one; an option to receive notifications of new publications, even though we don't publish on our platform; registration is solely for peer review; and an option to be contacted for submission reviews, which we don't allow, as the author provides a list of potential reviewers. Considering these factors, including these checkboxes during registration is unnecessary and potentially confusing. Therefore, we should hide them to streamline registration and avoid user confusion.
-**Toggle:** N/A +**Toggle:** N/A
**Implementation:** This was implemented by PKP directly. This was implemented with CSS, there is a copy of the CSS code at the end of our CSS file for reference: `pprOjsPlugin/css/iqss.css` **Issue Id:** Issue 020
**Area:** Registration
**Title:** Registration Process with Eligibility Confirmation Checkbox
**User Story:** As an author registering for an account, I want to ensure that I have read and understood the program requirements to determine my eligibility before creating an account. Our registration page needs a clear indication for authors to confirm their review of eligibility requirements. To enhance user experience and ensure compliance with our platform's guidelines, we propose adding a checkbox prompting authors to acknowledge their review of eligibility criteria before proceeding with registration.
-**Toggle:** userCustomFieldsEnabled +**Toggle:** userCustomFieldsEnabled
**Implementation:** Implemented with custom CSS and the `userRegister` template override: `pprOjsPlugin/templates/frontend/pages/userRegister.tpl` **Issue Id:** Issue 022
@@ -53,7 +60,7 @@ All template overrides are implemented in the Service class: `pprOjsPlugin/servi **User Story:** As an author preparing to submit a research document, I want to double-check that I've included everything from the list on the "1. Start" tab in the submission process, ensuring the completeness and accuracy of my submission before finalizing it in the system. To enhance the submission process and ensure completeness and accuracy, we propose integrating the checklist from the "1. Start" tab into the confirmation page on the "4. Confirmation" tab. This integration will allow authors to double-check that they've included everything from the initial checklist before finalizing their submission in the system.
-**Toggle:** submissionConfirmationChecklistEnabled +**Toggle:** submissionConfirmationChecklistEnabled
**Implementation:** Implemented with template overrides: `pprOjsPlugin/templates/submission/form/step[1,4].tpl` **Issue Id:** Issue 023
@@ -62,35 +69,35 @@ To enhance the submission process and ensure completeness and accuracy, we propo **User Story:** As a Managing editor, I need to understand who the author is to check for eligibility. I need to know about their institutional position and academic department. This will also help with reporting metrics. To improve program metrics reporting, assigning associate editors, and checking eligibility, we propose implementing two separate fields: Institutional Position and Academic Department. These will be included across three key areas: the user account profile, the contributor profile, and the registration profile.
-**Toggle:** userCustomFieldsEnabled +**Toggle:** userCustomFieldsEnabled
**Implementation:** This was implemented with the `PPRUserCustomFieldsService` service: `pprOjsPlugin/services/PPRUserCustomFieldsService.inc.php` **Issue Id:** Issue 024
**Area:** Reviewer Process
**Title:** Single Option for Type of Review for Double-Blinded Review Process
**User Story:** As an Associate Editor, I require only one option for the type of review in our system, as our program strictly adheres to a double-blinded review process. The presence of multiple options poses a risk of accidentally disclosing the author's identity to the reviewer, which goes against our process guidelines. To ensure the integrity of our double-blinded review process, I propose simplifying the "Type of Review" options to include only "Anonymous Reviewer/Anonymous Author," removing the possibilities for "Anonymous Reviewer/Disclosed Author" and "Open." By streamlining the options, we can eliminate confusion and maintain the confidentiality crucial to our review process.
-**Toggle:** hideReviewMethodEnabled +**Toggle:** hideReviewMethodEnabled
**Implementation:** Implemented with template override: `pprOjsPlugin/templates/controllers/grid/users/reviewer/form/reviewerFormFooter.tpl` **Issue Id:** Issue 026
**Area:** Workflow
**Title:** Hide Publications Tab
**User Story:** As a user, I expect the system to offer peer-review functionality without the option to publish articles exclusively. The presence of a Publications tab could lead to confusion among users.
-**Toggle:** N/A +**Toggle:** N/A
**Implementation:** Not sure what this issue is. **Issue Id:** Issue 033
**Area:** Submission
**Title:** Hide the "Accept and Skip Review" Button
**User Story:** As a managing editor, I ensure all submissions undergo peer review before acceptance. Removing the "Accept and Skip Review" option mitigates the risk of accidentally bypassing this crucial step.
-**Toggle:** N/A - Custom IQSS CSS is always included to OJS. +**Toggle:** N/A - Custom IQSS CSS is always included to OJS.
**Implementation:** Implemented with custom CSS: `pprOjsPlugin/css/iqss.css` **Issue Id:** Issue 036
**Area:** Review Process
**Title:** Managing/Associate Editors Approval Process with Author's Reviewer List Visibility
**User Story:** As a managing editor, I require visibility of the Author's "recommended reviewers" list to ensure all necessary information is included in the submission before proceeding to the "Send for Review" stage.
-**Toggle:** displaySuggestedReviewersEnabled +**Toggle:** displaySuggestedReviewersEnabled
**Implementation:** Implemented with the `PPRWorkflowService` service: `pprOjsPlugin/services/PPRWorkflowService.inc.php` **Issue Id:** Issue 037
@@ -99,7 +106,7 @@ To improve program metrics reporting, assigning associate editors, and checking **User Story:** As an Author, I need the capability to direct the Reviewer's attention to specific areas of my paper, facilitating a focused review process. This information should be visible to the Associate Editor responsible for assigning reviewers and any reviewers evaluating my paper. To address this need, we propose implementing a dedicated field titled "If you'd like to direct the reviewer's attention to any particular area of the paper, please describe it here." This field will seamlessly integrate into the Reviewer's workflow under the "3. Download & Review" tab. Additionally, it will be prominently displayed on the "Activity --> Review" tab for Associate/Managing Editors and Authors, ensuring clear communication and enhancing the review process for all stakeholders.
-**Toggle:** submissionCommentsForReviewerEnabled +**Toggle:** submissionCommentsForReviewerEnabled
**Implementation:** This is implemented using the `PPRSubmissionCommentsForReviewerService` to add the new custom field, a template override needed to display the new form field, and the `PPRWorkflowService` to add the field to the workflow page. - PPRSubmissionCommentsForReviewerService service: `pprOjsPlugin/services/submission/PPRSubmissionCommentsForReviewerService.inc.php` - PPRWorkflowService service: `pprOjsPlugin/services/PPRWorkflowService.inc.php` @@ -108,15 +115,15 @@ To address this need, we propose implementing a dedicated field titled "If you'd **Area:** Reports
**Title:** Customized IQSS Report for Program Metrics Tracking
**User Story:** As a managing editor who runs the program, I need a report to show the process of different areas in the system to keep track of how the program is doing, which can be exported to Smartsheet for a dashboard. This feature entails the development of a customized report to track various metrics within the system, including the number of reviews completed, distinct authors, coauthors, published authors, published papers, submissions, review length, total papers (unique titles), reviewers' review time, and reviewers' response time.
-**Toggle:** N/A +**Toggle:** N/A
**Implementation:** This is implemented with the `pprReviewsReportPlugin` code. This report is available throw the OJS UI. **Issue Id:** Issue 050
**Area:** Review Process
**Title:** Author's Institution Visibility on the Review Tab
**User Story:** As a Managing Editor or Associate Editor, I need access to the author institution details on the review tab. This visibility will enable me to confirm that authors and assigned reviewers represent separate institutions.
-**Toggle:** displayContributorsEnabled -**Implementation:** The OJS author.affiliation field is being re-purpose as institution. This changes displays institution in the Contributors component. +**Toggle:** displayContributorsEnabled
+**Implementation:** The OJS author.affiliation field is being re-purpose as institution. These changes display the institution field in the Contributors component. - PPRWorkflowService service: `pprOjsPlugin/services/PPRWorkflowService.inc.php` - PPRAuthorGridHandler service: `pprOjsPlugin/services/PPRAuthorGridHandler.inc.php` - PPRAuthorGridCellProvider service: `pprOjsPlugin/services/PPRAuthorGridCellProvider.inc.php` @@ -125,7 +132,7 @@ To address this need, we propose implementing a dedicated field titled "If you'd **Area:** Review Process
**Title:** Author Coauthor Visibility on Review Tab
**User Story:** As a Managing Editor or Associate Editor, I need access to the coauthor institution details on the review tab. This visibility will enable me to confirm that authors and assigned reviewers represent separate institutions.
-**Toggle:** displayContributorsEnabled +**Toggle:** displayContributorsEnabled
**Implementation:** This issue is to add the contributors component to the workflow pages, submissions and reviews. - PPRWorkflowService service: `pprOjsPlugin/services/PPRWorkflowService.inc.php` @@ -133,23 +140,23 @@ To address this need, we propose implementing a dedicated field titled "If you'd **Area:** Publication Tab
**Title:** Hide Fields on the "Submission Details" Tab
**User Story:** As a user, it can be confusing to see certain fields since we operate differently from a typical journal; we solely conduct peer reviews. Therefore, on the "Submission Details (Old Name Publication)" tab, we need to hide the following sections: Galleys, Permissions & Disclosures, and Issue.
-**Toggle:** N/A - Custom IQSS CSS is always included to OJS. +**Toggle:** N/A - Custom IQSS CSS is always included to OJS.
**Implementation:** Implemented with CSS: `pprOjsPlugin/css/iqss.css` **Issue Id:** Issue 056
**Area:** Profile
**Title:** Hide the "Reviewing Interests" field on the User Profile
**User Story:** As a user, I don't want to be asked about my reviewing interests because the authors and associate editors decide who to contact for reviews. Our platform differs from a regular journal, so this feature is unnecessary.
-**Toggle:** userCustomFieldsEnabled (bundled with other changes) +**Toggle:** userCustomFieldsEnabled (bundled with other changes)
**Implementation:** Implemented with template override: `pprOjsPlugin/templates/controllers/grid/users/reviewer/form/createReviewerForm.tpl` -"Reviewing Interests" is in other views, but only implemented in the create reviewer form: +"Reviewing Interests" is in other views, but only implemented in the create reviewer form. **Issue Id:** Issue 057
**Area:** Review Process
**Title:** Automated Past Due Notifications for Associate Editors
**User Story:** As an Associate Editor, I must be notified promptly when a reviewer fails to submit their review or respond to a review request on time. Since I may only sometimes be actively using the system, receiving automated email notifications about overdue reviews or responses is essential to stay informed and take appropriate action. These notifications enable me to follow up with reviewers, mitigate delays, and ensure the timely completion of the review process.
-**Toggle:** reviewReminderEditorTaskEnabled +**Toggle:** reviewReminderEditorTaskEnabled
**Implementation:** This is implemented using the `PPRReviewDueDateEditorNotification` scheduled task: `pprOjsPlugin/tasks/PPRReviewDueDateEditorNotification.inc.php` The schedule for the task is defined: `pprOjsPlugin/scheduledTasks.xml` @@ -158,7 +165,7 @@ The schedule for the task is defined: `pprOjsPlugin/scheduledTasks.xml` **Area:** Review Process
**Title:** Automated Reviewer Due Notification
**User Story:** As a reviewer, I appreciate receiving timely reminders about upcoming review deadlines. These reminders help me stay organized and ensure that I can allocate sufficient time to complete my reviews before they are due. This feature introduces automated notifications to remind reviewers about upcoming review due dates. Reviewers will receive these notifications, the timing of which can be updated in days via the plugin.
-**Toggle:** reviewReminderReviewerTaskEnabled +**Toggle:** reviewReminderReviewerTaskEnabled
**Implementation:** This is implemented using the `PPRReviewReminder` scheduled task: `pprOjsPlugin/tasks/PPRReviewReminder.inc.php` The schedule for the task is defined: `pprOjsPlugin/scheduledTasks.xml` @@ -167,35 +174,35 @@ The schedule for the task is defined: `pprOjsPlugin/scheduledTasks.xml` **Area:** Review Process
**Title:** Closed Review Stage
**User Story:** As a user, I must distinguish between completed and ongoing reviews to streamline organization and enhance workflow efficiency. Regardless of completion status, all reviews are housed within the "My Queue" section, which confuses identifying finalized tasks. Implementing a "Closed Submission" button is necessary to address this issue. Upon activation by the Managing Editor within their workflow, this feature will seamlessly relocate completed reviews to the dedicated "Archives" section.
-**Toggle:** submissionCloseEnabled +**Toggle:** submissionCloseEnabled
**Implementation:** This is implemented using the `PPRSubmissionActionsService` service: `pprOjsPlugin/services/submission/PPRSubmissionActionsService.inc.php` **Issue Id:** Issue 061
**Area:** Review Process
**Title:** Adding a Confirmation Popup for Missing Attachments in Reviewer's Process
**User Story:** As an Associate Editor, I want to receive a reminder to ensure I have added the necessary review attachment before sending the paper to the Author. This feature adds a popup box when an Associate Editor clicks the "Request Revision" button to send a paper to the Author without a review attachment. If an attachment hasn't been selected under the "Select review files to share with the author(s)" section, the popup will display a message asking if the user would like to proceed without an attachment. The popup will offer two options: "Yes" to send the email without an attachment or "Add Attachment" to exit the popup and select a file. This enhancement ensures that Associate Editors are reminded to include the necessary attachments before sending the review to the Author, preventing missed reviews in emails or dashboards.
-**Toggle:** submissionRequestRevisionsFileValidationEnabled +**Toggle:** submissionRequestRevisionsFileValidationEnabled
**Implementation:** Implemented with custom Javascript and the `sendReviewsForm` template override: `pprOjsPlugin/templates/controllers/modals/editorDecision/form/sendReviewsForm.tpl` **Issue Id:** Issue 062
**Area:** Notifications
**Title:** Vacation Status Label Under "Edit Profile"
**User Story:** As a Manager Editor, it's essential for me to be aware of Associate Editors' availability to avoid assigning reviews when they are on vacation. With the introduction of the vacation status indicator, I can quickly identify when an AE is unavailable for assignments. This feature can be enables on the "Edit Profile" page.
-**Toggle:** userOnLeaveEnabled +**Toggle:** userOnLeaveEnabled
**Implementation:** Implemented with the `PPROnLeaveCustomFieldsService` service: `pprOjsPlugin/services/PPROnLeaveCustomFieldsService.inc.php` **Issue Id:** Issue 063
**Area:** Submission
**Title:** Author's Popup Reminder to Attach Research Document
**User Story:** As an author, I want to receive a reminder to attach my research document when submitting my paper. If I proceed without attaching a document, I'd like to be prompted with a popup reminder. This enhancement ensures that attaching a research document is mandatory and doesn't allow the author to advance in the submission process without uploading the required file.
-**Toggle:** submissionUploadFileValidationEnabled +**Toggle:** submissionUploadFileValidationEnabled
**Implementation:** Implemented with custom Javascript and the `step2` template override: `pprOjsPlugin/templates/submission/form/step2.tpl` **Issue Id:** Issue 064
**Area:** List of Contributors
**Title:** Contributor's List shows the Author's Name first
**User Story:** As a Managing Editor or Associate Editor, I need clarity on who submitted a paper within the contributor's list. With the implementation of this feature, the author's name will always appear at the top of the contributor's list, regardless of the submission order.
-**Toggle:** displayContributorsEnabled +**Toggle:** displayContributorsEnabled
**Implementation:** This issue is to add the contributors component to the workflow pages, submissions and reviews. - PPRWorkflowService service: `pprOjsPlugin/services/PPRWorkflowService.inc.php` @@ -203,89 +210,161 @@ The schedule for the task is defined: `pprOjsPlugin/scheduledTasks.xml` **Area:** Review Process
**Title:** Associate Editor's Reminder Email
**User Story:** As the Managing Editor, I would like the email notification to state the Associate Editors' name. Please add this variable in the backend.
-**Toggle:** firstNameEmailEnabled +**Toggle:** firstNameEmailEnabled
**Implementation:** All the author/reviewer/editor names are now managed by a single service, the PPRFirstNameEmailService: `pprOjsPlugin/services/email/PPRFirstNameEmailService.inc.php` **Issue Id:** Issue 066
**Area:** Review Process
**Title:** Hide the "None/Free Form Review" Option
**User Story:** As an Associate Editor, when assigning a reviewer and opting for 'Create New Reviewer' within the 'Review Form' section, the current default option is 'None/Free Form Review,' which may leave the Reviewer without specific guidelines. We want to remove the 'None/Free Form Review' option to enhance clarity and consistency in the review process. Instead, 'Paper' will be the default, followed by 'Pre-Analysis' as the second option. This adjustment ensures that Reviewers receive clear instructions by default, improving the efficiency and quality of their evaluations.
-**Toggle:** hideReviewFormDefaultEnabled +**Toggle:** hideReviewFormDefaultEnabled
**Implementation:** Implemented with template override: `pprOjsPlugin/templates/controllers/grid/users/reviewer/form/createReviewerForm.tpl` **Issue Id:** Issue 067
**Area:** Review Process
**Title:** Mandatory for a Reviewer to Upload a File
**User Story:** As a Reviewer completing a review, I want to receive a notification if I forget to attach a review document in the "Reviewer Files" section under step "3. Download & Review." There's no alert system to remind me to upload a file, nor do I receive any notification upon submitting the review without an attachment. Implementing a popup notification would ensure that I am prompted to upload a file before finalizing my review, thus enhancing the review process and preventing oversight.
-**Toggle:** reviewUploadFileValidationEnabled +**Toggle:** reviewUploadFileValidationEnabled
**Implementation:** Implemented with custom Javascript and the `step3` template override: `pprOjsPlugin/templates/reviewer/review/step3.tpl` **Issue Id:** Issue 068
**Area:** Review Process
**Title:** Eliminated the Registration Email
**User Story:** As an Associate Editor, I want to streamline adding a Reviewer by ensuring that the system does not automatically send a registration email containing a username and password when adding a Reviewer through the Add Reviewer functionality in a submission. This will prevent confusion for the Reviewer, who might mistake the initial registration email as spam. Instead, only send the Scientific Request email, clearly stating the purpose of the request, thus improving the user experience.
-**Toggle:** reviewerRegistrationEmailDisabled +**Toggle:** reviewerRegistrationEmailDisabled
**Implementation:** This is implemented using the `PPRDisableEmailService` service: `pprOjsPlugin/services/email/PPRDisableEmailService.inc.php` **Issue Id:** Issue 070
**Area:** Review Process
**Title:** Add BCC Managing Editor to the "Thank Reviewer" Email
**User Story:** As a managing editor, I need to receive a notification that alerts me when the "Thank Reviewer" email is sent out. This will enhance the efficiency of the reviewers' payment process. This notification will prompt me to initiate the payment process without the need for manual checking.
-**Toggle:** reviewAddEditorToBccEnabled +**Toggle:** reviewAddEditorToBccEnabled
**Implementation:** This is implemented using the `PPRReviewAddEditorEmailService` service: `pprOjsPlugin/services/email/PPRReviewAddEditorEmailService.inc.php` **Issue Id:** Issue 071
**Area:** Review Process
**Title:** Reviewer Missed Review Reminder
**User Story:** As a Reviewer who has yet to accept a review and whose response is overdue, I find receiving a reminder email for a missed Review Due Date problematic. It assumes I have already accepted the review, causing confusion and frustration. Instead, I prefer to receive a gentle reminder prompting me to accept or decline the review request and only receive reminders if the review is overdue. This would ensure a smoother and clearer communication process, improving the overall experience for both Reviewers and Editors.
-**Toggle:** reviewReminderReviewerTaskEnabled +**Toggle:** reviewReminderReviewerTaskEnabled
**Implementation:** This is implemented using the `PPRReviewReminder` scheduled task: `pprOjsPlugin/tasks/PPRReviewReminder.inc.php` **Issue Id:** Issue 072
**Area:** Review Process
**Title:** Remove the BCC Option to Reviewer
**User Story:** As an Associate Editor, I should not be able to BCC a Reviewer on the same email sent to an Author, as this would violate confidentiality. When clicking the 'Send Review to Author' button, there is an option to 'Send to Reviewers' by selecting a checkbox to include the Reviewer, which would BCC them. However, since we maintain double-blinded reviews where the Author and Reviewer identities are kept confidential, this feature should be disabled to ensure compliance with our protocol.
-**Toggle:** hideSendToReviewersEnabled +**Toggle:** hideSendToReviewersEnabled
**Implementation:** Implemented with custom Javascript and the `sendReviewsForm` template override: `pprOjsPlugin/templates/controllers/modals/editorDecision/form/sendReviewsForm.tpl` **Issue Id:** Issue 074
**Area:** Submission
**Title:** Capture the type of research document
**User Story:** As an associate editor, I must know the type of research document the author has uploaded to select the appropriate reviewer instructions to send to reviewers. I suggest displaying the research document type on the 'Select Reviewer' form above the 'Select Reviewer Instructions' dropdown to fulfill this requirement. I propose making the research document type editable within the plugin interface. This allows for seamless adjustment if the document type changes or requires reclassification. The document could be a Paper, Pre-Analysis Plan, Grant Proposal, Book Proposal, or categorized as Other. Secondly, I recommend integrating these document types into IQSS Reporting to enhance reporting capabilities. This can be achieved by repurposing the existing "Document Type" field and renaming it as "Research Document Type."
-**Toggle:** submissionResearchTypeEnabled +**Toggle:** submissionResearchTypeEnabled
**Implementation:** This is implemented using the `PPRSubmissionResearchTypeService` service: `pprOjsPlugin/services/submission/PPRSubmissionResearchTypeService.inc.php` **Issue Id:** Issue 076
**Area:** Emails
**Title:** Response for Review Reminder for Overdue Reviewers
**User Story:** As an Associate/Managing Editor, I need the system to enable me to send both Response and Review reminders to overdue reviewers. It's important to ensure that the reminder is based on whether the reviewer has accepted the review. We require the capability to send either a Response or Review reminder if the reviewer exceeds the deadline. Clicking the "Send Reminder" button next to the reviewer's name only sends the Review reminder, even if the reviewer hasn't yet accepted the review. This enhancement will ensure that reviewers are reminded promptly based on their status, improving the efficiency of the review process.
-**Toggle:** reviewReminderEmailOverrideEnabled +**Toggle:** reviewReminderEmailOverrideEnabled
**Implementation:** This is implemented using the `PPRReviewReminderEmailService` service: `pprOjsPlugin/services/email/PPRReviewReminderEmailService.inc.php` **Issue Id:** Issue 078
**Area:** Submission
**Title:** Disable 'Submission Acknowledgement' Email to the Coauthor
**User Story:** As a coauthor who lacks an account in our system and may not be eligible for submission, we don't want them to receive confirmation emails when the author submits a paper. We request that the email 'SUBMISSION_ACK_NOT_USER' be discontinued for coauthors without system accounts to prevent unnecessary notifications. Restricting this notification to the author ensures clarity in the submission process and prevents unnecessary emails for coauthors not directly involved in the submission workflow.
-**Toggle:** submissionConfirmationContributorsEmailDisabled +**Toggle:** submissionConfirmationContributorsEmailDisabled
**Implementation:** This is implemented using the `PPRDisableEmailService` service: `pprOjsPlugin/services/email/PPRDisableEmailService.inc.php` **Issue Id:** Issue 079
**Area:** Emails
**Title:** Ready for Review Email Only Sent to Author
**User Story:** As an author utilizing the system, I expect to receive the review email exclusively. This prevents confusion for coauthors who do not have access to the platform. The email key 'EDITOR_DECISION_REVISIONS' should be exclusively sent to the submitting author. This implementation aims to improve user experience by preventing coauthors, not registered users, from receiving emails.
-**Toggle:** emailContributorsEnabled +**Toggle:** emailContributorsEnabled
**Implementation:** This is implemented using the `PPREmailContributorsService` service: `pprOjsPlugin/services/email/PPREmailContributorsService.inc.php` **Issue Id:** Issue 081
**Area:** Emails
**Title:** Coauthor Email Exclusion List
-**User Story:** "As a coauthor, I often receive emails that are not relevant to me because I am not currently a registered user in the system. To address this issue and improve user experience, I propose implementing a feature that excludes non-registered coauthors from receiving emails. This modification aims to improve user experience by preventing coauthors who are not registered users from receiving emails, thereby streamlining communication channels. This adjustment ensures that emails are directed only to the author unless specified otherwise, enhancing the efficiency and relevance of communication within the system.
-**Toggle:** emailContributorsEnabled +**User Story:** As a coauthor, I often receive emails that are not relevant to me because I am not currently a registered user in the system. To address this issue and improve user experience, I propose implementing a feature that excludes non-registered coauthors from receiving emails. This modification aims to improve user experience by preventing coauthors who are not registered users from receiving emails, thereby streamlining communication channels. This adjustment ensures that emails are directed only to the author unless specified otherwise, enhancing the efficiency and relevance of communication within the system.
+**Toggle:** emailContributorsEnabled
**Implementation:** This has been bundled and implemented using the `PPREmailContributorsService` service: `pprOjsPlugin/services/email/PPREmailContributorsService.inc.php` +**Issue Id:** Issue 083
+**Area:** Emails
+**Title:** Authors Choice to CC Coauthors on Submission Emails
+**User Story:** As an Author, I want the ability to choose when to add my coauthors to particular emails in the system. This way, I can efficiently manage communication and ensure that relevant collaborators are informed throughout the submission process.
+**Toggle:** emailContributorsEnabled
+**Implementation:** The implementation adds a new custom field using the `PPRSubmissionEmailContributorsService`, and executes the logic in the `PPREmailContributorsService`. +- PPRSubmissionEmailContributorsService service: `pprOjsPlugin/services/submission/PPRSubmissionEmailContributorsService.inc.php` +- PPREmailContributorsService service: `pprOjsPlugin/services/email/PPREmailContributorsService.inc.php` + +**Issue Id:** Issue 084
+**Area:** Profile
+**Title:** Hide the "Bio Statement" field on the User Profile
+**User Story:** As a peer pre-review process, we don't need to capture anyone's bio statement. Our system doesn't require readers to search for articles based on an author's bio.
+**Toggle:** hideUserBioEnabled
+**Implementation:** Implemented with template override: `pprOjsPlugin/templates/user/publicProfileForm.tpl` +**Issue Id:** Issue 085
+**Area:** Review Process
+**Title:** Hide Decision Dropdown within the Associate Editors Workflow
+**User Story:** As an Associate Editor, I require a streamlined workflow that eliminates unnecessary decision-making and ensures consistency in the review process. Within my workflow, the option "revisions will undergo a new round of peer reviews" should be hidden, and the default should be "Revisions will not be subject to a new round of peer reviews."
+**Toggle:** hideReviewRoundSelectionEnabled
+**Implementation:** Implemented with custom Javascript and the `sendReviewsForm` template override: `pprOjsPlugin/templates/controllers/modals/editorDecision/form/sendReviewsForm.tpl` +**Issue Id:** Issue 089
+**Area:** Reports
+**Title:** Customized IQSS Report for Program Metrics Tracking
+**User Story:** As a managing editor, I need to efficiently track where my reviews are in the system. To streamline this process, I propose implementing an automated weekly pull of the IQSS Peer Pre-Review Report every Monday. This report will provide comprehensive insights into the status of reviews within the system. Additionally, the email functionality will allow notifications to be sent to multiple email addresses, enhancing communication with relevant stakeholders.
+**Toggle:** submissionsReviewsReportEnabled
+**Implementation:** This is implemented using the `PPREditorReportTask` scheduled task: `pprReviewsReportPlugin/tasks/PPREditorReportTask.inc.php` +The schedule for the task is defined: `pprReviewsReportPlugin/scheduledTasks.xml` +**Issue Id:** Issue 090
+**Area:** Submission
+**Title:** Review Template Pre-selected Based on Research Document Type
+**User Story:** As an Associate Editor, I would like the review template guidelines for papers or pre-analysis plans to be automatically preselected when the Author chooses this document type for their submission. This automation would streamline the review process by ensuring that the appropriate directions appear for the reviewers without the Associate Editor manually selecting the template, ultimately saving time.
+**Toggle:** submissionResearchTypeEnabled
+**Implementation:** This is implemented using the `PPRSubmissionResearchTypeService` service: `pprOjsPlugin/services/submission/PPRSubmissionResearchTypeService.inc.php` +**Issue Id:** Issue 092
+**Area:** Review Process
+**Title:** "Unassigning Reviewer" and "Cancel Reviewer"
+**User Story:** When an Associate Editor needs to cancel a reviewer, they encounter two distinct stages, each requiring different email wording. Suppose a response from the reviewer is overdue, and they have yet to accept the review. In that case, the Associate Editor must choose 'Unassigning Reviewer' and dispatch a specific email with tailored wording. Conversely, suppose the reviewer has already accepted the review, and the review itself is overdue. In that case, the Associate Editor should opt for 'Cancel Reviewer' and trigger a different email template designed for that scenario. Presently, the system relies on a single template titled REVIEW_CANCEL for both functions, which doesn't adequately address the nuanced communication needs. Therefore, it's imperative to introduce an additional template to ensure precise and context-specific messaging for each cancellation stage.
+**Toggle:** reviewerGridServiceEnabled
+**Implementation:** This is bundled with the implementation for the `PPRReviewerGridService` service: `pprOjsPlugin/services/reviewer/PPRReviewerGridService.inc.php` +- PPRReviewerGridHandler handler: `pprOjsPlugin/services/reviewer/PPRReviewerGridHandler.inc.php` +- PPRUnassignReviewerForm form: `pprOjsPlugin/services/reviewer/PPRUnassignReviewerForm.inc.php` + +**Issue Id:** Issue 093
+**Area:** Emails
+**Title:** Disable Sending of Decline Email to Coauthors
+**User Story:** As a managing/associate editor, I need the ability to prevent the sending of decline emails 'EDITOR_DECISION_INITIAL_DECLINE' and 'EDITOR_DECISION_DECLINE' to coauthors listed as contributors when using the "Decline" button in the system. We need to turn off the sending of the email templates 'EDITOR_DECISION_INITIAL_DECLINE' and 'EDITOR_DECISION_DECLINE' to coauthors who are listed as contributors when the "Decline" button is clicked in the system. These emails are sent to coauthors, causing unnecessary communication and confusion. Disabling this feature will ensure that only the submitting author receives the decline notification.
+**Toggle:** emailContributorsEnabled
+**Implementation:** This has been bundled and implemented using the `PPREmailContributorsService` service: `pprOjsPlugin/services/email/PPREmailContributorsService.inc.php` + +**Issue Id:** Issue 095
+**Area:** Submission
+**Title:** Remove the option "Publish" and "Create New Version" Button
+**User Story:** As managing/associate editors, we must remove the 'Publish' and 'Create New Version' buttons. As our workflow does not involve publishing content, these options are unnecessary and pose a risk of accidental actions. By eliminating these buttons, we ensure that only appropriate actions are available to users, enhancing the integrity of our system and preventing unintended outcomes. + +Remove the option "Publish" and "Create New Version" Buttons from the Submission Details Page. See image.
+**Toggle:** N/A
+**Implementation:** Implemented with custom CSS: `pprOjsPlugin/css/iqss.css` + +**Issue Id:** Issue 096
+**Area:** Profile
+**Title:** Hide Privacy Statements
+**User Story:** As per our legal team's guidelines, we are not permitted to include a privacy statement within our system.
+**Toggle:** N/A
+**Implementation:** Implemented by updating the OJS locale for the privacy statement with a space " " to make it disappear. + +**Issue Id:** Issue 098
+**Area:** Survey
+**Title:** Survey for Authors Post Submission on System
+**User Story:** As managing editors, I seek to gather feedback from Reviewers on their process to enhance our review workflow. We've created a survey within the review form, but its placement could be more optimal, and we need a systematic way to capture and export the data for analysis. To address this, we propose integrating a survey directly into the Reviewers' "4. Completion" screen, ensuring consistent visibility and accessibility. We aim to streamline the process by eliminating the need for Reviewers to select a specific form, ensuring that the survey always appears upon completion of their review. Additionally, we request that the survey results be automatically emailed to PeerPreReview@iq.harvard.edu each time a form is submitted, preferably in Excel format, facilitating efficient data collection and analysis.
+**Toggle:** authorSubmissionSurveyHtml - We use the actual survey HTML to know if enabled
+**Implementation:** Implemented using the PPRAuthorSubmissionSurveyService service: `pprOjsPlugin/services/submission/PPRAuthorSubmissionSurveyService.inc.php` diff --git a/pprOjsPlugin/css/iqss.css b/pprOjsPlugin/css/iqss.css index 8ab0d45..bca7895 100644 --- a/pprOjsPlugin/css/iqss.css +++ b/pprOjsPlugin/css/iqss.css @@ -38,6 +38,8 @@ div.pkpPublication .pkpTabs__buttons #issue-button { /** PUBLICATION HIDE ACTION BUTTONS + + ISSUE 095 */ div.pkpPublication__header div.pkpHeader__actions{ display: none; diff --git a/pprOjsPlugin/services/email/PPREmailContributorsService.inc.php b/pprOjsPlugin/services/email/PPREmailContributorsService.inc.php index 3485a15..17e0db3 100644 --- a/pprOjsPlugin/services/email/PPREmailContributorsService.inc.php +++ b/pprOjsPlugin/services/email/PPREmailContributorsService.inc.php @@ -3,7 +3,9 @@ /** * Service to manage the emails sent to contributors from different actions in OJS. * - * Issue 079, Issue 081 + * emailContributors custom submission field is managed in PPRSubmissionEmailContributorsService + * + * Issue 079, Issue 081, Issue 083, Issue 093 */ class PPREmailContributorsService { diff --git a/pprOjsPlugin/services/reviewer/PPRReviewerGridHandler.inc.php b/pprOjsPlugin/services/reviewer/PPRReviewerGridHandler.inc.php index e1a0e80..82cbf7c 100644 --- a/pprOjsPlugin/services/reviewer/PPRReviewerGridHandler.inc.php +++ b/pprOjsPlugin/services/reviewer/PPRReviewerGridHandler.inc.php @@ -7,6 +7,8 @@ /** * Custom ReviewerGridHandler to control the form used when unassigning reviewers * and the text for the "considered" column in the reviewers list panel. + * + * Issue 092 */ class PPRReviewerGridHandler extends ReviewerGridHandler { diff --git a/pprOjsPlugin/services/reviewer/PPRReviewerGridService.inc.php b/pprOjsPlugin/services/reviewer/PPRReviewerGridService.inc.php index 45ed0a8..4bbfc07 100644 --- a/pprOjsPlugin/services/reviewer/PPRReviewerGridService.inc.php +++ b/pprOjsPlugin/services/reviewer/PPRReviewerGridService.inc.php @@ -5,6 +5,8 @@ * * In order to achieve the new requirements, we need to override the ReviewerGridHandler * to have control of the UnassignReviewerForm + * + * Issue 092 */ class PPRReviewerGridService { diff --git a/pprOjsPlugin/services/reviewer/PPRUnassignReviewerForm.inc.php b/pprOjsPlugin/services/reviewer/PPRUnassignReviewerForm.inc.php index 38db573..f73358d 100644 --- a/pprOjsPlugin/services/reviewer/PPRUnassignReviewerForm.inc.php +++ b/pprOjsPlugin/services/reviewer/PPRUnassignReviewerForm.inc.php @@ -13,6 +13,8 @@ * - Always cancel the review assignment when unassign reviewer is executed. * * This form is used in the ReviewerGridHandler + * + * Issue 092 */ class PPRUnassignReviewerForm extends ReviewerNotifyActionForm { diff --git a/pprOjsPlugin/services/submission/PPRAuthorSubmissionSurveyService.inc.php b/pprOjsPlugin/services/submission/PPRAuthorSubmissionSurveyService.inc.php index 93c5dc1..4cde601 100644 --- a/pprOjsPlugin/services/submission/PPRAuthorSubmissionSurveyService.inc.php +++ b/pprOjsPlugin/services/submission/PPRAuthorSubmissionSurveyService.inc.php @@ -4,6 +4,8 @@ * Service to show a submission completed survey to an author only once. * This survey is shown in the complete page in the author submission workflow. * See SubmissionHandler->step + * + * Issue 098 */ class PPRAuthorSubmissionSurveyService { diff --git a/pprOjsPlugin/services/submission/PPRSubmissionEmailContributorsService.inc.php b/pprOjsPlugin/services/submission/PPRSubmissionEmailContributorsService.inc.php index d91f0a0..88570f8 100644 --- a/pprOjsPlugin/services/submission/PPRSubmissionEmailContributorsService.inc.php +++ b/pprOjsPlugin/services/submission/PPRSubmissionEmailContributorsService.inc.php @@ -2,7 +2,8 @@ /** * Service to add the submission emailContributors custom field to the create submission > metadata form - * + * + * Issue 083 */ class PPRSubmissionEmailContributorsService { const EMAIL_CONTRIBUTORS_FIELD = 'emailContributors'; diff --git a/pprOjsPlugin/services/submission/PPRSubmissionResearchTypeService.inc.php b/pprOjsPlugin/services/submission/PPRSubmissionResearchTypeService.inc.php index 2c6df72..ca43bea 100644 --- a/pprOjsPlugin/services/submission/PPRSubmissionResearchTypeService.inc.php +++ b/pprOjsPlugin/services/submission/PPRSubmissionResearchTypeService.inc.php @@ -5,7 +5,7 @@ * * This services adds the custom field to the add reviewer form * - * Issue 074 + * Issue 074, Issue 090 */ class PPRSubmissionResearchTypeService { const RESEARCH_TYPE_FIELD = 'researchType'; diff --git a/pprOjsPlugin/templates/common/userDetails.tpl b/pprOjsPlugin/templates/common/userDetails.tpl index a0de221..f3d8e45 100644 --- a/pprOjsPlugin/templates/common/userDetails.tpl +++ b/pprOjsPlugin/templates/common/userDetails.tpl @@ -36,6 +36,7 @@ {/fbvFormSection} + {if !$pprPluginSettings->hidePreferredPublicNameEnabled()} {fbvFormSection for="preferredPublicName" description="user.preferredPublicName.description"} {fbvElement type="text" label="user.preferredPublicName" multilingual="true" name="preferredPublicName" id="preferredPublicName" value=$preferredPublicName size=$fbvStyles.size.LARGE} diff --git a/pprOjsPlugin/templates/controllers/modals/editorDecision/form/sendReviewsForm.tpl b/pprOjsPlugin/templates/controllers/modals/editorDecision/form/sendReviewsForm.tpl index 2d026a1..29ecc27 100644 --- a/pprOjsPlugin/templates/controllers/modals/editorDecision/form/sendReviewsForm.tpl +++ b/pprOjsPlugin/templates/controllers/modals/editorDecision/form/sendReviewsForm.tpl @@ -5,6 +5,7 @@ {if $pprPluginSettings->hideReviewRoundSelectionEnabled() && $decision === constant('SUBMISSION_EDITOR_DECISION_PENDING_REVISIONS')} {/if} diff --git a/pprOjsPlugin/templates/user/publicProfileForm.tpl b/pprOjsPlugin/templates/user/publicProfileForm.tpl index 1ca0a42..f9e54ce 100644 --- a/pprOjsPlugin/templates/user/publicProfileForm.tpl +++ b/pprOjsPlugin/templates/user/publicProfileForm.tpl @@ -59,6 +59,7 @@ {/fbvFormSection} + {if !$pprPluginSettings->hideUserBioEnabled()} {fbvFormSection} {fbvElement type="textarea" label="user.biography" multilingual="true" name="biography" id="biography" rich=true value=$biography} diff --git a/pprReviewsReportPlugin/tasks/PPREditorReportTask.inc.php b/pprReviewsReportPlugin/tasks/PPREditorReportTask.inc.php index a2fe3f1..1a11a61 100644 --- a/pprReviewsReportPlugin/tasks/PPREditorReportTask.inc.php +++ b/pprReviewsReportPlugin/tasks/PPREditorReportTask.inc.php @@ -7,6 +7,8 @@ /** * Task to send the submissions/review report to a list of recipients configured in the plugin settings + * + * Issue 089 */ class PPREditorReportTask extends ScheduledTask {