From dae0ec7632150865074e5007c03abba2316e8cf5 Mon Sep 17 00:00:00 2001 From: Aday Bujeda Date: Tue, 9 Jul 2024 17:49:40 +0100 Subject: [PATCH] Added documentation for implemented features and related implementations --- .../source/featureDescriptions.md | 517 ++++++++++++++++++ docs/Sphinx-guides/source/index.md | 3 +- docs/Sphinx-guides/source/userGuide/index.md | 3 +- .../Sphinx-guides/source/userGuide/surveys.md | 13 + pprOjsPlugin/css/iqss.css | 15 +- .../PPRAuthorGridCellProvider.inc.php | 2 + .../services/PPRAuthorGridHandler.inc.php | 2 + .../PPROnLeaveCustomFieldsService.inc.php | 2 + .../PPRUserCustomFieldsService.inc.php | 2 + .../services/PPRWorkflowService.inc.php | 5 + .../email/PPRDisableEmailService.inc.php | 2 + .../email/PPREmailContributorsService.inc.php | 4 + .../email/PPRFirstNameEmailService.inc.php | 2 + .../PPRReviewAddEditorEmailService.inc.php | 2 + .../PPRReviewReminderEmailService.inc.php | 2 + .../reviewer/PPRReviewAcceptedService.inc.php | 2 + .../PPRReviewAttachmentsService.inc.php | 8 + .../PPRReviewSubmittedService.inc.php | 2 + .../reviewer/PPRReviewerGridHandler.inc.php | 2 + .../reviewer/PPRReviewerGridService.inc.php | 2 + .../reviewer/PPRUnassignReviewerForm.inc.php | 2 + .../PPRAuthorSubmissionSurveyService.inc.php | 2 + .../PPRSubmissionActionsService.inc.php | 2 + ...bmissionCommentsForReviewerService.inc.php | 2 + ...SubmissionEmailContributorsService.inc.php | 3 +- .../PPRSubmissionResearchTypeService.inc.php | 2 + ...PPRReviewDueDateEditorNotification.inc.php | 2 + pprOjsPlugin/tasks/PPRReviewReminder.inc.php | 2 + .../PPRReviewSentAuthorNotification.inc.php | 2 + ...SubmissionClosedAuthorNotification.inc.php | 2 + pprOjsPlugin/templates/common/userDetails.tpl | 1 + .../reviewer/form/createReviewerForm.tpl | 1 + .../reviewer/form/reviewerFormFooter.tpl | 3 +- .../editorDecision/form/sendReviewsForm.tpl | 3 + .../wizard/fileUpload/fileUploadWizard.tpl | 1 + .../templates/frontend/pages/userRegister.tpl | 2 + .../reviewer/review/reviewCompleted.tpl | 1 + .../templates/reviewer/review/step3.tpl | 1 + .../templates/submission/form/step1.tpl | 1 + .../templates/submission/form/step2.tpl | 2 +- .../templates/submission/form/step4.tpl | 2 +- .../templates/user/publicProfileForm.tpl | 1 + .../PPRReviewsReportPlugin.inc.php | 2 + .../tasks/PPREditorReportTask.inc.php | 2 + 44 files changed, 629 insertions(+), 7 deletions(-) create mode 100644 docs/Sphinx-guides/source/featureDescriptions.md create mode 100644 docs/Sphinx-guides/source/userGuide/surveys.md diff --git a/docs/Sphinx-guides/source/featureDescriptions.md b/docs/Sphinx-guides/source/featureDescriptions.md new file mode 100644 index 0000000..6bb7629 --- /dev/null +++ b/docs/Sphinx-guides/source/featureDescriptions.md @@ -0,0 +1,517 @@ +# Feature Descriptions + +## Technical Notes +All template overrides are implemented in the Service class: `pprOjsPlugin/services/PPRWorkflowService.inc.php` + +## Descriptions + +**Issue Id:** Issue 07
+**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
+**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
+**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
+**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.
+**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
+**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
+**Implementation:** Implemented with custom CSS and the `userRegister` template override: `pprOjsPlugin/templates/frontend/pages/userRegister.tpl` + +**Issue Id:** Issue 022
+**Area:** Submission
+**Title:** Streamlining Submission Process with Checklist Integration
+**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
+**Implementation:** Implemented with template overrides: `pprOjsPlugin/templates/submission/form/step[1,4].tpl` + +**Issue Id:** Issue 023
+**Area:** Submission
+**Title:** Separate Fields for Institutional Position and Academic Department
+**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
+**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
+**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
+**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.
+**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
+**Implementation:** Implemented with the `PPRWorkflowService` service: `pprOjsPlugin/services/PPRWorkflowService.inc.php` + +**Issue Id:** Issue 037
+**Area:** Submission
+**Title:** Dedicated Field for Authors to Direct Reviewer Attention
+**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
+**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` + +**Issue Id:** Issue 045
+**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
+**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. 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` + +**Issue Id:** Issue 052
+**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
+**Implementation:** This issue is to add the contributors component to the workflow pages, submissions and reviews. + - PPRWorkflowService service: `pprOjsPlugin/services/PPRWorkflowService.inc.php` + +**Issue Id:** Issue 055
+**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.
+**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)
+**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. + +**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
+**Implementation:** This is implemented using the `PPRReviewDueDateEditorNotification` scheduled task: `pprOjsPlugin/tasks/PPRReviewDueDateEditorNotification.inc.php` + +The schedule for the task is defined: `pprOjsPlugin/scheduledTasks.xml` + +**Issue Id:** Issue 058
+**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
+**Implementation:** This is implemented using the `PPRReviewReminder` scheduled task: `pprOjsPlugin/tasks/PPRReviewReminder.inc.php` + +The schedule for the task is defined: `pprOjsPlugin/scheduledTasks.xml` + +**Issue Id:** Issue 060
+**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
+**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
+**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
+**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
+**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
+**Implementation:** This issue is to add the contributors component to the workflow pages, submissions and reviews. +- PPRWorkflowService service: `pprOjsPlugin/services/PPRWorkflowService.inc.php` + +**Issue Id:** Issue 065
+**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
+**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
+**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
+**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
+**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
+**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
+**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
+**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
+**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
+**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
+**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
+**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
+**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:** reviewerSurveyHtml - We use the actual survey HTML to know if enabled
+**Implementation:** Implemented with template override: `pprOjsPlugin/templates/reviewer/review/reviewCompleted.tpl` + +**Issue Id:** Issue 108
+**Area:** Emails
+**Title:** Author Notification: Submission Approved
+**User Story:** As a Managing Editor, I need the system to automatically send an email notification to the author when I click the "Send to Review" button, informing them that their submission has been approved and is now being assigned to a reviewer. This notification ensures that authors are kept informed about the progress of their submissions and fosters transparency in the review process.
+**Toggle:** submissionApprovedEmailEnabled
+**Implementation:** This is implemented using the `PPRSubmissionActionsService` service: `pprOjsPlugin/services/submission/PPRSubmissionActionsService.inc.php` + +**Issue Id:** Issue 109
+**Area:** Review Process
+**Title:** Popup Notification for Missed Review Attachment
+**User Story:** As an Associate Editor, I want to ensure that both reviews are sent to the Author after receiving them. If a second review is returned and I need to check the box for it to be sent, the Author only receives the old review without the new attachment. To prevent this oversight, I propose adding a column indicating whether the review was sent or displaying the reviewer's name, providing a visual cue to ensure all reviews are sent to the Author.
+**Toggle:** reviewAttachmentsOverrideEnabled
+**Implementation:** Implemented using the `PPRReviewAttachmentsService` service: `pprOjsPlugin/services/reviewer/PPRReviewAttachmentsService.inc.php` +- PPRReviewAttachmentsGridHandler handler: `pprOjsPlugin/services/reviewer/PPRReviewAttachmentsGridHandler.inc.php` +- PPRReviewAttachmentGridCellProvider form: `pprOjsPlugin/services/reviewer/PPRReviewAttachmentGridCellProvider.inc.php` + +**Issue Id:** Issue 111
+**Area:** Registration
+**Title:** Registration Page for Authors Only Wording
+**User Story:** As a user, clarity about the registration process is crucial. Since the registration page is exclusively for authors, adding wording like "author profile" is essential to avoid confusion. This addition will indicate that the registration process is tailored specifically for authors, helping users understand the page's purpose.
+**Toggle:** userCustomFieldsEnabled
+**Implementation:** Implemented with custom CSS and the `userRegister` template override: `pprOjsPlugin/templates/frontend/pages/userRegister.tpl` + +**Issue Id:** Issue 112
+**Area:** Email
+**Title:** Reviewer Accepted Confirmation Email
+**User Story:** As a reviewer, I want to receive a confirmation email after accepting a review request. The email should contain a link allowing me to reset my username/password if necessary, enabling me to log in directly as needed.
+**Toggle:** reviewAcceptedEmailEnabled
+**Implementation:** Implemented using the `PPRReviewAcceptedService` service: `pprOjsPlugin/services/reviewer/PPRReviewAcceptedService.inc.php` + +**Issue Id:** Issue 114
+**Area:** Email
+**Title:** Survey for Authors Post Submission on Review
+**User Story:** As the Managing Editor, I want to implement a survey that gathers authors' feedback one week after receiving a review for their submission. This survey should focus on the author's experience with the review they received, separate from the system survey. Each time a review is sent to an author, they should receive an email notification containing the survey link.
+**Toggle:** reviewSentAuthorTaskEnabled
+**Implementation:** This is implemented using the `PPRReviewSentAuthorNotification` scheduled task: `pprOjsPlugin/tasks/PPRReviewSentAuthorNotification.inc.php` + +The schedule for the task is defined: `pprOjsPlugin/scheduledTasks.xml` + +**Issue Id:** Issue 115
+**Area:** Submission
+**Title:** Remove "Other Selection" Under the Author Submission Workflow
+**User Story:** As an author, it can be confusing to see two 'Other' options when uploading my research document and being presented with a list of 'Primary academic disciplines' to choose from. We propose removing the "Other Selection" option under the Author Submission Workflow to enhance clarity and reduce confusion for Authors during the submission process.
+**Toggle:** N/A - Custom IQSS CSS is always included to OJS.
+**Implementation:** Implemented with custom CSS: `pprOjsPlugin/css/iqss.css` + +**Issue Id:** Issue 118
+**Area:** Reviewer Process
+**Title:** Review Submitted Confirmation Email (Reviewer)
+**User Story:** As a reviewer, I require confirmation of my review submission after clicking the 'Submit Review' button. I need to be assured that my review has been successfully submitted. Therefore, I want an email notification that automatically sends me a confirmation email immediately after I click the 'Submit Review' button.
+**Toggle:** reviewSubmittedEmailEnabled
+**Implementation:** Implemented using the `PPRReviewSubmittedService` service: `pprOjsPlugin/services/reviewer/PPRReviewSubmittedService.inc.php` + +**Issue Id:** Issue 119
+**Area:** Reviewer Process
+**Title:** Continue Button Renaming to Complete
+**User Story:** When uploading a file, users, especially reviewers, find it confusing when the button text says "Continue" without clear guidance on the subsequent steps, particularly if they need to take further action, such as clicking a button. This lack of clarity often leads to oversight, delaying the completion of the review process.
+**Toggle:** fileUploadTextOverrideEnabled
+**Implementation:** Implemented with template override: `pprOjsPlugin/templates/controllers/wizard/fileUpload/fileUploadWizard.tpl` + +**Issue Id:** Issue 120
+**Area:** Reviewer Process
+**Title:** Reviewer Reminder for Open Review with File Attached
+**User Story:** As a Reviewer, I'd appreciate a reminder when I have uploaded a file, but I have not clicked the blue "Submit Review" button. This reminder should be triggered when pending reviews are detected, and at least one file has been uploaded. + +The logic for this email reminder needs to be added to the existing custom review reminder notification for reviewers as they are both related. + +The logic will be updated as follows: +- Check all pending reviews that has been accepted by reviewer. +- First check if review is due. If due send notification and end. +- If not due yet, check for review files. If at least one file, send notification and end. + +**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` + +**Issue Id:** Issue 125
+**Area:** Survey
+**Title:** Survey for Authors About OJS System
+**User Story:** As an author, to avoid being inconvenienced with multiple system surveys, we propose sending the survey to authors only once after the submission takes place. By implementing this approach, we aim to gather valuable feedback from authors while minimizing disruption to their workflow and optimizing the effectiveness of the survey process.
+**Toggle:** authorSubmissionSurveyHtml - We use the actual survey HTML to know if enabled
+**Implementation:** Implemented using the `PPRAuthorSubmissionSurveyService` service: `pprOjsPlugin/services/submission/PPRAuthorSubmissionSurveyService.inc.php` + +**Issue Id:** Issue 127
+**Area:** Email
+**Title:** Utilize First Name Only in Email Communications
+**User Story:** As the Managing Editor, I want to update all active email templates in our current workflow to use only the recipient's first name. This adjustment aims to create a more informal and user-friendly communication style. + +This was implemented in batches using issues: 129, 130, 131, 132
+**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 135
+**Area:** Reports
+**Title:** Customized IQSS Report for Program Metrics Tracking
+**User Story:** As a Managing Editor who receives only one or two monthly submissions but frequently receives reports, setting the report default to quarterly would be more efficient. This adjustment ensures that reports are generated less often, aligning better with the volume of submissions.
+**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 136
+**Area:** Reviewer List
+**Title:** Track Unassigned Reviewers
+**User Story:** As an Associate Editor, I require unassigned reviewers to be consistently visible within the Reviewer list, designated with an 'Unassigned' status. This visibility is crucial for preventing the accidental sending of duplicate review requests.
+**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 137
+**Area:** Reviewer List
+**Title:** Track Declined Reviewers
+**User Story:** "As an Associate Editor, I require the ability to track the date when a reviewer declines review requests to manage submission statuses effectively. To facilitate this, I propose incorporating this information into our Reviewer list.
+**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` +- PPRReviewerGridCellProvider form: `pprOjsPlugin/services/reviewer/PPRReviewerGridCellProvider.inc.php` + +**Issue Id:** Issue 141
+**Area:** Email
+**Title:** Post-One-Year Survey: Tracking Publication Status
+**User Story:** As a program manager overseeing paper submissions, I need to implement a post-one-year survey to track the publication status of authors' papers. The survey must be designed to gather information specifically on whether papers have been published or are still in the publication process one year after submission closure. It should collect data on the publication status of each paper submitted to the program, including whether the paper has been published, is under review, or is still in the publication process. + +The survey should be sent to authors one year after the closure of paper submissions. It should be user-friendly and easy for authors to complete. The results of the survey must be recorded and stored in a centralized database for analysis. This data will be crucial for reporting to donors and updating metrics on the program webpage to demonstrate the program's success and impact. + +The survey should not be directly tied to individual reviews but should provide an overview of the progress of each author's paper. Authors' participation in the survey should be encouraged, emphasizing the importance of their input in monitoring submission progress and program success. The program team should be able to effectively monitor the progress of paper submissions using the collected data. +
+**Toggle:** submissionClosedAuthorTaskEnabled
+**Implementation:** This is implemented using the `PPRSubmissionClosedAuthorNotification` scheduled task: `pprOjsPlugin/tasks/PPRSubmissionClosedAuthorNotification.inc.php` + +The schedule for the task is defined: `pprOjsPlugin/scheduledTasks.xml` + +**Issue Id:** Issue 142
+**Area:** Reports
+**Title:** Add annual survey notification to Report
+**User Story:** As a Managing Editor, I want to see when a survey has been sent to the author. To facilitate this, I suggest adding a new column to the report titled "Survey Sent Date." In this column, the date of the annual survey email will be recorded. If the email has not been sent, the column will remain empty. This addition will provide valuable insight into the survey communication process, aiding in tracking and management.
+**Toggle:** N/A
+**Implementation:** This is implemented with the `pprReviewsReportPlugin` code. This report is available throw the OJS UI and sent via email. + +**Issue Id:** Issue 145
+**Area:** Submission
+**Title:** Remove Checkboxes Show Just Submission Requirements
+**User Story:** As an author, I find it confusing to check off boxes during the submission process only to realize later that not all requirements are necessary. To simplify the process and improve clarity, I propose removing the checkbox requirement altogether and instead displaying the complete list of submission components upfront.
+**Toggle:** submissionConfirmationChecklistEnabled
+**Implementation:** Implemented with template overrides: `pprOjsPlugin/templates/submission/form/step[1,4].tpl` \ No newline at end of file diff --git a/docs/Sphinx-guides/source/index.md b/docs/Sphinx-guides/source/index.md index 15ffa90..0b8c6c0 100644 --- a/docs/Sphinx-guides/source/index.md +++ b/docs/Sphinx-guides/source/index.md @@ -27,4 +27,5 @@ We have divided the documentation for this project into 4 different sections tha userGuide/index sysadminGuide/index developerGuide/index -features \ No newline at end of file +features +featureDescriptions \ No newline at end of file diff --git a/docs/Sphinx-guides/source/userGuide/index.md b/docs/Sphinx-guides/source/userGuide/index.md index 8eda391..b25ca53 100644 --- a/docs/Sphinx-guides/source/userGuide/index.md +++ b/docs/Sphinx-guides/source/userGuide/index.md @@ -4,4 +4,5 @@ ```{toctree} submissions reviews -researchDocumentTypes \ No newline at end of file +researchDocumentTypes +surveys \ No newline at end of file diff --git a/docs/Sphinx-guides/source/userGuide/surveys.md b/docs/Sphinx-guides/source/userGuide/surveys.md new file mode 100644 index 0000000..d83b262 --- /dev/null +++ b/docs/Sphinx-guides/source/userGuide/surveys.md @@ -0,0 +1,13 @@ +# Survey Code Analysis +This is an analysis implemented to understand the surveys implemented in PPR plugin. + +## Analysis +There are currently 4 surveys, 3 survey widgets shown in the OJS UI and 1 notification email that will send a survey. + +**Submission Completed Survey Widget:** This survey widget will be shown at the create submission wizard confirmation page. This survey will only be shown the first time a submission is completed. The system will set a flag once shown and will not show this survey again for the same author. + +**Author Dashboard Survey:** This survey will be shown in the author submission dashboard. This survey will be shown when the submission has at least one completed review. There are no time restrictions on this survey. + +**Review Completed Survey Widget:** This survey widget will be shown at the create review wizard confirmation page. This survey will be shown every time the reviewer access the final page of a review. + +**Review Sent Author Notification:** This is an email with a survey link that is sent to the author. The email is sent 7 days (configurable in the plugin settings) after a review file has been sent to the author. There will be an email sent for every review in the submission that has been sent to the author." \ No newline at end of file diff --git a/pprOjsPlugin/css/iqss.css b/pprOjsPlugin/css/iqss.css index c3d2f7c..86922b7 100644 --- a/pprOjsPlugin/css/iqss.css +++ b/pprOjsPlugin/css/iqss.css @@ -1,6 +1,6 @@ /** - HIDE COPYEDITING AND PRODUCTION TABS + HIDE COPYEDITING (ISSUE 013) AND PRODUCTION TABS */ #stageTabs li.stageId4.ui-tab { display: none; @@ -13,6 +13,7 @@ /** PUBLICATION HIDE TABS + ISSUE 055 */ div.pkpPublication .pkpTabs__buttons #contributors-button { display: none; @@ -37,6 +38,8 @@ div.pkpPublication .pkpTabs__buttons #issue-button { /** PUBLICATION HIDE ACTION BUTTONS + + ISSUE 095 */ div.pkpPublication__header div.pkpHeader__actions{ display: none; @@ -61,6 +64,8 @@ div.pkpPublication__header div.pkpHeader__actions{ /** Remove the Other file type added by OJS automatically + + Issue 115 */ button.-linkButton.listPanel--submissionFiles__setGenreButton:nth-last-child(1) { display: none; @@ -69,6 +74,7 @@ button.-linkButton.listPanel--submissionFiles__setGenreButton:nth-last-child(1) /** WORKFLOW - SUBMISSION HIDE ACCEPT AND SKIP REVIEW BUTTON - NOT REQUIRED BY PPR + ISSUE 033 */ #submissionWorkflow #editorialActions a.pkp_linkaction_accept { display: none; @@ -284,3 +290,10 @@ span.ppr-attachments-sent { fieldset#submissionSpecific ul.checkbox_and_radiobutton > li:last-child { display: none; } + +/* To hide notification/reviewer interest opt-in */ +form#register .optin-email, +form#register #reviewerOptinGroup +{ + display: none; +} diff --git a/pprOjsPlugin/services/PPRAuthorGridCellProvider.inc.php b/pprOjsPlugin/services/PPRAuthorGridCellProvider.inc.php index 23528f9..e6a18de 100644 --- a/pprOjsPlugin/services/PPRAuthorGridCellProvider.inc.php +++ b/pprOjsPlugin/services/PPRAuthorGridCellProvider.inc.php @@ -4,6 +4,8 @@ /** * This is based on PKPAuthorGridCellProvider + * + * Issue 050, Issue 064 */ class PPRAuthorGridCellProvider extends DataObjectGridCellProvider { diff --git a/pprOjsPlugin/services/PPRAuthorGridHandler.inc.php b/pprOjsPlugin/services/PPRAuthorGridHandler.inc.php index b7df6ee..b0b1ad6 100644 --- a/pprOjsPlugin/services/PPRAuthorGridHandler.inc.php +++ b/pprOjsPlugin/services/PPRAuthorGridHandler.inc.php @@ -5,6 +5,8 @@ /** * Custom AuthorGridHandler to control the columns that are displayed in the contributors component + * + * Issue 050, Issue 064 */ class PPRAuthorGridHandler extends AuthorGridHandler { diff --git a/pprOjsPlugin/services/PPROnLeaveCustomFieldsService.inc.php b/pprOjsPlugin/services/PPROnLeaveCustomFieldsService.inc.php index c9994c2..2f055fb 100644 --- a/pprOjsPlugin/services/PPROnLeaveCustomFieldsService.inc.php +++ b/pprOjsPlugin/services/PPROnLeaveCustomFieldsService.inc.php @@ -2,6 +2,8 @@ /** * Service to manage the new user on leave custom fields required for PPR + * + * Issue 062 */ class PPROnLeaveCustomFieldsService { const ON_LEAVE_FROM_FIELD = 'onLeaveFrom'; diff --git a/pprOjsPlugin/services/PPRUserCustomFieldsService.inc.php b/pprOjsPlugin/services/PPRUserCustomFieldsService.inc.php index 3c11bd2..5cd4b36 100644 --- a/pprOjsPlugin/services/PPRUserCustomFieldsService.inc.php +++ b/pprOjsPlugin/services/PPRUserCustomFieldsService.inc.php @@ -2,6 +2,8 @@ /** * Service to manage the new user/author custom fields required for PPR + * + * Issue 023 */ class PPRUserCustomFieldsService { const CATEGORY_DROPDOWN = 'categories'; diff --git a/pprOjsPlugin/services/PPRWorkflowService.inc.php b/pprOjsPlugin/services/PPRWorkflowService.inc.php index 623ba28..cdbf233 100644 --- a/pprOjsPlugin/services/PPRWorkflowService.inc.php +++ b/pprOjsPlugin/services/PPRWorkflowService.inc.php @@ -3,6 +3,8 @@ /** * Service to add/update components in the OJS workflow page * Workflow page controls the submission and review workflows + * + * Issue 036, Issue 037, Issue 050, Issue 052 */ class PPRWorkflowService { private $pprPlugin; @@ -16,6 +18,7 @@ function register() { } if ($this->pprPlugin->getPluginSettings()->submissionCommentsForReviewerEnabled()) { + //ISSUE 037 HookRegistry::register('Template::Workflow', array($this, 'addCommentsForReviewerToWorkflow')); } @@ -24,11 +27,13 @@ function register() { } if ($this->pprPlugin->getPluginSettings()->displayContributorsEnabled()) { + // ISSUE 050, ISSUE 052, ISSUE 064 HookRegistry::register('Template::Workflow', array($this, 'addContributorsToWorkflow')); HookRegistry::register('LoadComponentHandler', array($this, 'addPPRAuthorGridHandler')); } if ($this->pprPlugin->getPluginSettings()->displaySuggestedReviewersEnabled()) { + //ISSUE 036 HookRegistry::register('Template::Workflow', array($this, 'addSuggestedReviewersToWorkflow')); } } diff --git a/pprOjsPlugin/services/email/PPRDisableEmailService.inc.php b/pprOjsPlugin/services/email/PPRDisableEmailService.inc.php index 709a9bf..7ace742 100644 --- a/pprOjsPlugin/services/email/PPRDisableEmailService.inc.php +++ b/pprOjsPlugin/services/email/PPRDisableEmailService.inc.php @@ -2,6 +2,8 @@ /** * Service to disable email notifications + * + * Issue 068, Issue 078 */ class PPRDisableEmailService { diff --git a/pprOjsPlugin/services/email/PPREmailContributorsService.inc.php b/pprOjsPlugin/services/email/PPREmailContributorsService.inc.php index f8b32e8..17e0db3 100644 --- a/pprOjsPlugin/services/email/PPREmailContributorsService.inc.php +++ b/pprOjsPlugin/services/email/PPREmailContributorsService.inc.php @@ -2,6 +2,10 @@ /** * Service to manage the emails sent to contributors from different actions in OJS. + * + * emailContributors custom submission field is managed in PPRSubmissionEmailContributorsService + * + * Issue 079, Issue 081, Issue 083, Issue 093 */ class PPREmailContributorsService { diff --git a/pprOjsPlugin/services/email/PPRFirstNameEmailService.inc.php b/pprOjsPlugin/services/email/PPRFirstNameEmailService.inc.php index 874e2d7..e492e2c 100644 --- a/pprOjsPlugin/services/email/PPRFirstNameEmailService.inc.php +++ b/pprOjsPlugin/services/email/PPRFirstNameEmailService.inc.php @@ -2,6 +2,8 @@ /** * Service to add author and editor first name to all SubmissionMailTemplates and forms + * + * Issue 065, Issue 127 */ class PPRFirstNameEmailService { const SUPPORTED_EMAILS = diff --git a/pprOjsPlugin/services/email/PPRReviewAddEditorEmailService.inc.php b/pprOjsPlugin/services/email/PPRReviewAddEditorEmailService.inc.php index 3f82ce4..5cfd563 100644 --- a/pprOjsPlugin/services/email/PPRReviewAddEditorEmailService.inc.php +++ b/pprOjsPlugin/services/email/PPRReviewAddEditorEmailService.inc.php @@ -2,6 +2,8 @@ /** * Service to add the managing editor to emails related to reviews + * + * Issue 070 */ class PPRReviewAddEditorEmailService { diff --git a/pprOjsPlugin/services/email/PPRReviewReminderEmailService.inc.php b/pprOjsPlugin/services/email/PPRReviewReminderEmailService.inc.php index 21e4795..df5fa97 100644 --- a/pprOjsPlugin/services/email/PPRReviewReminderEmailService.inc.php +++ b/pprOjsPlugin/services/email/PPRReviewReminderEmailService.inc.php @@ -3,6 +3,8 @@ /** * Service to manage the review reminder action from the reviewers component. * This is the component in the front end used to send notifications to reviewers. + * + * Issue 076 */ class PPRReviewReminderEmailService { diff --git a/pprOjsPlugin/services/reviewer/PPRReviewAcceptedService.inc.php b/pprOjsPlugin/services/reviewer/PPRReviewAcceptedService.inc.php index 9628528..4870595 100644 --- a/pprOjsPlugin/services/reviewer/PPRReviewAcceptedService.inc.php +++ b/pprOjsPlugin/services/reviewer/PPRReviewAcceptedService.inc.php @@ -2,6 +2,8 @@ /** * Service to send an email when a reviewer accepts a review + * + * Issue 112 */ class PPRReviewAcceptedService { diff --git a/pprOjsPlugin/services/reviewer/PPRReviewAttachmentsService.inc.php b/pprOjsPlugin/services/reviewer/PPRReviewAttachmentsService.inc.php index 67687c1..86c8eec 100644 --- a/pprOjsPlugin/services/reviewer/PPRReviewAttachmentsService.inc.php +++ b/pprOjsPlugin/services/reviewer/PPRReviewAttachmentsService.inc.php @@ -1,5 +1,13 @@ step + * + * Issue 125 */ class PPRAuthorSubmissionSurveyService { diff --git a/pprOjsPlugin/services/submission/PPRSubmissionActionsService.inc.php b/pprOjsPlugin/services/submission/PPRSubmissionActionsService.inc.php index affab6e..6ef0393 100644 --- a/pprOjsPlugin/services/submission/PPRSubmissionActionsService.inc.php +++ b/pprOjsPlugin/services/submission/PPRSubmissionActionsService.inc.php @@ -7,6 +7,8 @@ * Service to attach additional functionality to editor actions panel: * - Add the close submission functionality * - Add the submission approved email to authors + * + * Issue 060, Issue 108 */ class PPRSubmissionActionsService { diff --git a/pprOjsPlugin/services/submission/PPRSubmissionCommentsForReviewerService.inc.php b/pprOjsPlugin/services/submission/PPRSubmissionCommentsForReviewerService.inc.php index 267c730..1e556eb 100644 --- a/pprOjsPlugin/services/submission/PPRSubmissionCommentsForReviewerService.inc.php +++ b/pprOjsPlugin/services/submission/PPRSubmissionCommentsForReviewerService.inc.php @@ -4,6 +4,8 @@ * Service to add the commentsForReviewer custom field to the create submission > metadata form * * This services adds the custom field to the create review form for the reviewer + * + * Issue 037 */ class PPRSubmissionCommentsForReviewerService { const COMMENTS_FOR_REVIEWER_FIELD = 'commentsForReviewer'; 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 fd9228e..ca43bea 100644 --- a/pprOjsPlugin/services/submission/PPRSubmissionResearchTypeService.inc.php +++ b/pprOjsPlugin/services/submission/PPRSubmissionResearchTypeService.inc.php @@ -4,6 +4,8 @@ * Service to add the submission researchType custom field to the create submission > metadata form * * This services adds the custom field to the add reviewer form + * + * Issue 074, Issue 090 */ class PPRSubmissionResearchTypeService { const RESEARCH_TYPE_FIELD = 'researchType'; diff --git a/pprOjsPlugin/tasks/PPRReviewDueDateEditorNotification.inc.php b/pprOjsPlugin/tasks/PPRReviewDueDateEditorNotification.inc.php index f32dd3e..711e30e 100644 --- a/pprOjsPlugin/tasks/PPRReviewDueDateEditorNotification.inc.php +++ b/pprOjsPlugin/tasks/PPRReviewDueDateEditorNotification.inc.php @@ -6,6 +6,8 @@ /** * Custom review due date notification for editors logic + * + * Issue 057 */ class PPRReviewDueDateEditorNotification extends PPRScheduledTask { diff --git a/pprOjsPlugin/tasks/PPRReviewReminder.inc.php b/pprOjsPlugin/tasks/PPRReviewReminder.inc.php index c924f1c..99008b3 100644 --- a/pprOjsPlugin/tasks/PPRReviewReminder.inc.php +++ b/pprOjsPlugin/tasks/PPRReviewReminder.inc.php @@ -7,6 +7,8 @@ /** * Task to send reviewers a review due date reminder. Based on OJS ReviewReminder class + * + * Issue 058, Issue 071, Issue 120 */ class PPRReviewReminder extends PPRScheduledTask { diff --git a/pprOjsPlugin/tasks/PPRReviewSentAuthorNotification.inc.php b/pprOjsPlugin/tasks/PPRReviewSentAuthorNotification.inc.php index ce07e98..55af6ce 100644 --- a/pprOjsPlugin/tasks/PPRReviewSentAuthorNotification.inc.php +++ b/pprOjsPlugin/tasks/PPRReviewSentAuthorNotification.inc.php @@ -9,6 +9,8 @@ * a review has been sent to them. This is used to send a survey to the author. * The initial requirement was to send an email after a week, * but the time in days is configurable in the plugin settings. + * + * Issue 114 */ class PPRReviewSentAuthorNotification extends PPRScheduledTask { diff --git a/pprOjsPlugin/tasks/PPRSubmissionClosedAuthorNotification.inc.php b/pprOjsPlugin/tasks/PPRSubmissionClosedAuthorNotification.inc.php index 6092a8f..288f404 100644 --- a/pprOjsPlugin/tasks/PPRSubmissionClosedAuthorNotification.inc.php +++ b/pprOjsPlugin/tasks/PPRSubmissionClosedAuthorNotification.inc.php @@ -9,6 +9,8 @@ * a submission is closed. This is used to send a survey to the author. * The initial requirement was to send an email after a year of the closed submission, * but the time in days is configurable in the plugin settings. + * + * Issue 141 */ class PPRSubmissionClosedAuthorNotification extends PPRScheduledTask { 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/grid/users/reviewer/form/createReviewerForm.tpl b/pprOjsPlugin/templates/controllers/grid/users/reviewer/form/createReviewerForm.tpl index 8e0d851..49b8c12 100644 --- a/pprOjsPlugin/templates/controllers/grid/users/reviewer/form/createReviewerForm.tpl +++ b/pprOjsPlugin/templates/controllers/grid/users/reviewer/form/createReviewerForm.tpl @@ -60,6 +60,7 @@ {/fbvFormSection} + {fbvFormSection title="user.affiliation" required="true"} {fbvElement type="text" multilingual="true" name="affiliation" id="affiliation" value=$affiliation size=$fbvStyles.size.LARGE required="true"} diff --git a/pprOjsPlugin/templates/controllers/grid/users/reviewer/form/reviewerFormFooter.tpl b/pprOjsPlugin/templates/controllers/grid/users/reviewer/form/reviewerFormFooter.tpl index b7c8120..0b421ea 100644 --- a/pprOjsPlugin/templates/controllers/grid/users/reviewer/form/reviewerFormFooter.tpl +++ b/pprOjsPlugin/templates/controllers/grid/users/reviewer/form/reviewerFormFooter.tpl @@ -53,7 +53,7 @@ {if $pprPluginSettings->hideReviewMethodEnabled()} - {** PPR - DEFAULT TO DOUBLE ANONYMOUS **} + {** PPR - DEFAULT TO DOUBLE ANONYMOUS - ISSUE 024 **} {else} {fbvFormSection list=true title="editor.submissionReview.reviewType"} @@ -76,6 +76,7 @@ {/fbvFormSection} {** PPR - REMOVED DEFAULT OPTION **} + {** ISSUE 066 **} {if !$pprPluginSettings->hideReviewFormDefaultEnabled()} {assign var=defaultLabel value="manager.reviewForms.noneChosen"|translate} {assign var=defaultValue value=0} diff --git a/pprOjsPlugin/templates/controllers/modals/editorDecision/form/sendReviewsForm.tpl b/pprOjsPlugin/templates/controllers/modals/editorDecision/form/sendReviewsForm.tpl index 954f7b8..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} @@ -12,10 +13,12 @@ {if $pprPluginSettings->hideSendToReviewersEnabled() && in_array($decision, [constant('SUBMISSION_EDITOR_DECISION_PENDING_REVISIONS'), constant('SUBMISSION_EDITOR_DECISION_DECLINE')])} {/if} +{** ISSUE 061 *} {if $pprPluginSettings->submissionRequestRevisionsFileValidationEnabled() && $decision === constant('SUBMISSION_EDITOR_DECISION_PENDING_REVISIONS')} {** ONLY ADD FILE VALIDATION FOR REQUEST REVISIONS ACTION *} {assign var="modalId" value="requestRevisionsFileMessage"|uniqid|escape} diff --git a/pprOjsPlugin/templates/controllers/wizard/fileUpload/fileUploadWizard.tpl b/pprOjsPlugin/templates/controllers/wizard/fileUpload/fileUploadWizard.tpl index 63dbe54..2c67ecb 100644 --- a/pprOjsPlugin/templates/controllers/wizard/fileUpload/fileUploadWizard.tpl +++ b/pprOjsPlugin/templates/controllers/wizard/fileUpload/fileUploadWizard.tpl @@ -15,6 +15,7 @@ {assign var=uploadWizardId value="fileUploadWizard"|uniqid} {** PPR PROGRAM - OVERRIDE FILE UPLOAD WIZARD TEXT *} +{** ISSUE 119 *} {** - PPR REQUIREMENT TO ADD SUBMISSION CHECKLIST TO THE CONFIRMATION PAGE + PPR REQUIREMENT TO ADD SUBMISSION CHECKLIST TO THE CONFIRMATION PAGE - ISSUE 022 *} {* Submission checklist *} {if $currentContext->getLocalizedData('submissionChecklist')} 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/PPRReviewsReportPlugin.inc.php b/pprReviewsReportPlugin/PPRReviewsReportPlugin.inc.php index b6e1ad0..af7bbff 100644 --- a/pprReviewsReportPlugin/PPRReviewsReportPlugin.inc.php +++ b/pprReviewsReportPlugin/PPRReviewsReportPlugin.inc.php @@ -4,6 +4,8 @@ /** * PPR Submission and Review report plugin + * + * Issue 045 */ class PPRReviewsReportPlugin extends ReportPlugin { diff --git a/pprReviewsReportPlugin/tasks/PPREditorReportTask.inc.php b/pprReviewsReportPlugin/tasks/PPREditorReportTask.inc.php index a2fe3f1..ea05f7b 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, Issue 135, Issue 142 */ class PPREditorReportTask extends ScheduledTask {