Merge pull request #15 from IQSS/feature_descriptions_01

Added documentation for implemented features and related implementations

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
+features
+featureDescriptions

docs/Sphinx-guides/source/userGuide/index.md

@@ -4,4 +4,5 @@
 ```{toctree}
 submissions
 reviews
-researchDocumentTypes
+researchDocumentTypes
+surveys

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

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;
+}

pprOjsPlugin/services/PPRAuthorGridCellProvider.inc.php

@@ -4,6 +4,8 @@
 
 /**
  * This is based on PKPAuthorGridCellProvider
+ *
+ * Issue 050, Issue 064
  */
 class PPRAuthorGridCellProvider extends DataObjectGridCellProvider {
 

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 {
 

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';

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';

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'));
         }
     }

pprOjsPlugin/services/email/PPRDisableEmailService.inc.php

@@ -2,6 +2,8 @@
 
 /**
  * Service to disable email notifications
+ *
+ * Issue 068, Issue 078
  */
 class PPRDisableEmailService {
 

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 {
 

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 =

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 {
 

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/reviewer/PPRReviewAcceptedService.inc.php

@@ -2,6 +2,8 @@
 
 /**
  * Service to send an email when a reviewer accepts a review
+ *
+ * Issue 112
  */
 class PPRReviewAcceptedService {
 

pprOjsPlugin/services/reviewer/PPRReviewAttachmentsService.inc.php

@@ -1,5 +1,13 @@
 <?php
 
+/**
+ * Service to customize the send review files attachment component
+ *
+ * In order to achieve the new requirements, we need to override the ReviewAttachmentGridHandler
+ * to have control of the ReviewAttachmentGridCellProvider
+ *
+ * Issue 109
+ */
 class PPRReviewAttachmentsService {
 
     private $pprPlugin;

pprOjsPlugin/services/reviewer/PPRReviewSubmittedService.inc.php

@@ -2,6 +2,8 @@
 
 /**
  * Service to send an email to the reviewer when a review is submitted
+ *
+ * Issue 118
  */
 class PPRReviewSubmittedService {
 

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 {
 

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, Issue 136
  */
 class PPRReviewerGridService {
 

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 {
 

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 125
  */
 class PPRAuthorSubmissionSurveyService {
 

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 {
 

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';

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';

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';

pprOjsPlugin/tasks/PPRReviewDueDateEditorNotification.inc.php

@@ -6,6 +6,8 @@
 
 /**
  * Custom review due date notification for editors logic
+ *
+ * Issue 057
  */
 class PPRReviewDueDateEditorNotification extends PPRScheduledTask {
 

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 {
 

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 {
 

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 {
 

pprOjsPlugin/templates/common/userDetails.tpl

@@ -36,6 +36,7 @@
 	{/fbvFormSection}
 
 	<!-- REMOVED PREFERRED PUBLIC NAME -->
+	<!-- ISSUE 09 -->
 	{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}

pprOjsPlugin/templates/controllers/grid/users/reviewer/form/createReviewerForm.tpl

@@ -60,6 +60,7 @@
 	{/fbvFormSection}
 
 	<!-- REMOVED REVIEWER INTERESTS -->
+	<!-- ISSUE 056 -->
 
 	{fbvFormSection title="user.affiliation" required="true"}
 		{fbvElement type="text" multilingual="true" name="affiliation" id="affiliation" value=$affiliation size=$fbvStyles.size.LARGE required="true"}

pprOjsPlugin/templates/controllers/grid/users/reviewer/form/reviewerFormFooter.tpl

@@ -53,7 +53,7 @@
 	</div>
 
 	{if $pprPluginSettings->hideReviewMethodEnabled()}
-		{** PPR - DEFAULT TO DOUBLE ANONYMOUS **}
+		{** PPR - DEFAULT TO DOUBLE ANONYMOUS  - ISSUE 024 **}
 		<input type="hidden" name="reviewMethod" value="{constant('SUBMISSION_REVIEW_METHOD_DOUBLEANONYMOUS')}" />
 	{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}

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

@@ -5,17 +5,20 @@
 {if $pprPluginSettings->hideReviewRoundSelectionEnabled() && $decision === constant('SUBMISSION_EDITOR_DECISION_PENDING_REVISIONS')}
 	<script type="text/javascript">
 		{** HIDE REQUIRE REVISIONS ROUND SECTION *}
+		{** ISSUE 085 *}
 		$('form#sendReviews [id="decisionRevisions"]').closest('div').hide();
 	</script>
 {/if}
 
 {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 *}
 	{assign var="modalId" value="requestRevisionsFileMessage"|uniqid|escape}