Continue adding documentation for implemented features and related im…

…plementations

docs/Sphinx-guides/source/featureDescriptions.md

@@ -12,6 +12,13 @@ All template overrides are implemented in the Service class: `pprOjsPlugin/servi
 **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 <br>
+**Area:** Submission <br>
+**Title:** Hide the field ORIC iD <br>
+**User Story:** We do not need users' ORIC iD. Removing this field will simplify the interface, reduce clutter, and enhance the user experience. <br>
+**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 010 <br>
 **Area:** Submission <br>
 **Title:** Remove the "Include this contributor in the browse list" Option <br>
@@ -218,21 +225,65 @@ The schedule for the task is defined: `pprOjsPlugin/scheduledTasks.xml`
 **Title:** Eliminated the Registration Email <br>
 **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. <br>
 **Toggle:** reviewerRegistrationEmailDisabled
-**Implementation:** This is implemented using the PPRDisableEmailService service: `pprOjsPlugin/services/email/PPRDisableEmailService.inc.php`
-
-**Issue Id:** Issue 068 <br>
-**Area:** Review Process <br>
-**Title:** Eliminated the Registration Email <br>
-**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. <br>
-**Toggle:** reviewerRegistrationEmailDisabled
-**Implementation:** This is implemented using the PPRDisableEmailService service: `pprOjsPlugin/services/email/PPRDisableEmailService.inc.php`
+**Implementation:** This is implemented using the `PPRDisableEmailService` service: `pprOjsPlugin/services/email/PPRDisableEmailService.inc.php`
 
 **Issue Id:** Issue 070 <br>
 **Area:** Review Process <br>
 **Title:** Add BCC Managing Editor to the "Thank Reviewer" Email <br>
 **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. <br>
 **Toggle:** reviewAddEditorToBccEnabled
-**Implementation:** This is implemented using the PPRReviewAddEditorEmailService service: `pprOjsPlugin/services/email/PPRReviewAddEditorEmailService.inc.php`
+**Implementation:** This is implemented using the `PPRReviewAddEditorEmailService` service: `pprOjsPlugin/services/email/PPRReviewAddEditorEmailService.inc.php`
+
+**Issue Id:** Issue 071 <br>
+**Area:** Review Process <br>
+**Title:** Reviewer Missed Review Reminder <br>
+**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. <br>
+**Toggle:** reviewReminderReviewerTaskEnabled
+**Implementation:** This is implemented using the `PPRReviewReminder` scheduled task: `pprOjsPlugin/tasks/PPRReviewReminder.inc.php`
+
+**Issue Id:** Issue 072 <br>
+**Area:** Review Process <br>
+**Title:** Remove the BCC Option to Reviewer <br>
+**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. <br>
+**Toggle:** hideSendToReviewersEnabled
+**Implementation:** Implemented with custom Javascript and the `sendReviewsForm` template override: `pprOjsPlugin/templates/controllers/modals/editorDecision/form/sendReviewsForm.tpl`
+
+**Issue Id:** Issue 074 <br>
+**Area:** Submission <br>
+**Title:** Capture the type of research document <br>
+**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." <br>
+**Toggle:** submissionResearchTypeEnabled
+**Implementation:** This is implemented using the `PPRSubmissionResearchTypeService` service: `pprOjsPlugin/services/submission/PPRSubmissionResearchTypeService.inc.php`
+
+**Issue Id:** Issue 076 <br>
+**Area:** Emails <br>
+**Title:** Response for Review Reminder for Overdue Reviewers <br>
+**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. <br>
+**Toggle:** reviewReminderEmailOverrideEnabled
+**Implementation:** This is implemented using the `PPRReviewReminderEmailService` service: `pprOjsPlugin/services/email/PPRReviewReminderEmailService.inc.php`
+
+**Issue Id:** Issue 078 <br>
+**Area:** Submission <br>
+**Title:** Disable 'Submission Acknowledgement' Email to the Coauthor <br>
+**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. <br>
+**Toggle:** submissionConfirmationContributorsEmailDisabled
+**Implementation:** This is implemented using the `PPRDisableEmailService` service: `pprOjsPlugin/services/email/PPRDisableEmailService.inc.php`
+
+**Issue Id:** Issue 079 <br>
+**Area:** Emails <br>
+**Title:** Ready for Review Email Only Sent to Author <br>
+**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. <br>
+**Toggle:** emailContributorsEnabled
+**Implementation:** This is implemented using the `PPREmailContributorsService` service: `pprOjsPlugin/services/email/PPREmailContributorsService.inc.php`
+
+**Issue Id:** Issue 081 <br>
+**Area:** Emails <br>
+**Title:** Coauthor Email Exclusion List <br>
+**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. <br>
+**Toggle:** emailContributorsEnabled
+**Implementation:** This has been bundled and implemented using the `PPREmailContributorsService` service: `pprOjsPlugin/services/email/PPREmailContributorsService.inc.php`
+
+
 
 
 

pprOjsPlugin/services/email/PPRDisableEmailService.inc.php

@@ -3,7 +3,7 @@
 /**
  * Service to disable email notifications
  *
- * Issue 068
+ * Issue 068, Issue 078
  */
 class PPRDisableEmailService {
 

pprOjsPlugin/services/email/PPREmailContributorsService.inc.php

@@ -2,6 +2,8 @@
 
 /**
  * Service to manage the emails sent to contributors from different actions in OJS.
+ *
+ * Issue 079, Issue 081
  */
 class PPREmailContributorsService {
 

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 {
 

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
  */
 class PPRSubmissionResearchTypeService {
     const RESEARCH_TYPE_FIELD = 'researchType';

pprOjsPlugin/tasks/PPRReviewReminder.inc.php

@@ -8,7 +8,7 @@
 /**
  * Task to send reviewers a review due date reminder. Based on OJS ReviewReminder class
  *
- * Issue 058
+ * Issue 058, Issue 071
  */
 class PPRReviewReminder extends PPRScheduledTask {
 

pprOjsPlugin/templates/controllers/modals/editorDecision/form/sendReviewsForm.tpl

@@ -12,13 +12,14 @@
 {if $pprPluginSettings->hideSendToReviewersEnabled() && in_array($decision, [constant('SUBMISSION_EDITOR_DECISION_PENDING_REVISIONS'), constant('SUBMISSION_EDITOR_DECISION_DECLINE')])}
 	<script type="text/javascript">
 		{** HIDE SEND TO REVIEWERS SECTION *}
+		{** ISSUE 072 *}
 		$('form#sendReviews [id="bccReviewers[]"]').closest('div').hide();
 	</script>
 {/if}
 
+{** ISSUE 061 *}
 {if $pprPluginSettings->submissionRequestRevisionsFileValidationEnabled() && $decision === constant('SUBMISSION_EDITOR_DECISION_PENDING_REVISIONS')}
 	{** ONLY ADD FILE VALIDATION FOR REQUEST REVISIONS ACTION *}
-	{** ISSUE 061 *}
 	{assign var="modalId" value="requestRevisionsFileMessage"|uniqid|escape}
 	{include file="ppr/modalMessage.tpl" cancelButton=true modalId=$modalId
 		modalHeader="revisions.ppr.review.files.validation.header"|translate