Continue adding documentation for implemented features and related im…

…plementations
IQSS · Jul 3, 2024 · 9e157fc · 9e157fc
1 parent a8f7924
commit 9e157fc
Show file tree

Hide file tree

Showing 13 changed files with 140 additions and 43 deletions.
diff --git a/docs/Sphinx-guides/source/featureDescriptions.md b/docs/Sphinx-guides/source/featureDescriptions.md
diff --git a/pprOjsPlugin/css/iqss.css b/pprOjsPlugin/css/iqss.css
@@ -38,6 +38,8 @@ div.pkpPublication .pkpTabs__buttons #issue-button {
 /**
  PUBLICATION
  HIDE ACTION BUTTONS
+
+ ISSUE 095
  */
 div.pkpPublication__header div.pkpHeader__actions{
  display: none;

diff --git a/pprOjsPlugin/services/email/PPREmailContributorsService.inc.php b/pprOjsPlugin/services/email/PPREmailContributorsService.inc.php
@@ -3,7 +3,9 @@
 /**
  * Service to manage the emails sent to contributors from different actions in OJS.
  *
- * Issue 079, Issue 081
+ * emailContributors custom submission field is managed in PPRSubmissionEmailContributorsService
+ *
+ * Issue 079, Issue 081, Issue 083, Issue 093
  */
 class PPREmailContributorsService {
 

diff --git a/pprOjsPlugin/services/reviewer/PPRReviewerGridHandler.inc.php b/pprOjsPlugin/services/reviewer/PPRReviewerGridHandler.inc.php
@@ -7,6 +7,8 @@
 /**
  * Custom ReviewerGridHandler to control the form used when unassigning reviewers
  * and the text for the "considered" column in the reviewers list panel.
+ *
+ * Issue 092
  */
 class PPRReviewerGridHandler extends ReviewerGridHandler {
 

diff --git a/pprOjsPlugin/services/reviewer/PPRReviewerGridService.inc.php b/pprOjsPlugin/services/reviewer/PPRReviewerGridService.inc.php
@@ -5,6 +5,8 @@
  *
  * In order to achieve the new requirements, we need to override the ReviewerGridHandler
  * to have control of the UnassignReviewerForm
+ *
+ * Issue 092
  */
 class PPRReviewerGridService {
 

diff --git a/pprOjsPlugin/services/reviewer/PPRUnassignReviewerForm.inc.php b/pprOjsPlugin/services/reviewer/PPRUnassignReviewerForm.inc.php
@@ -13,6 +13,8 @@
  * - Always cancel the review assignment when unassign reviewer is executed.
  *
  * This form is used in the ReviewerGridHandler
+ *
+ * Issue 092
  */
 class PPRUnassignReviewerForm extends ReviewerNotifyActionForm {
 

diff --git a/pprOjsPlugin/services/submission/PPRAuthorSubmissionSurveyService.inc.php b/pprOjsPlugin/services/submission/PPRAuthorSubmissionSurveyService.inc.php
@@ -4,6 +4,8 @@
  * Service to show a submission completed survey to an author only once.
  * This survey is shown in the complete page in the author submission workflow.
  * See SubmissionHandler->step
+ *
+ * Issue 098
  */
 class PPRAuthorSubmissionSurveyService {
 

diff --git a/pprOjsPlugin/services/submission/PPRSubmissionEmailContributorsService.inc.php b/pprOjsPlugin/services/submission/PPRSubmissionEmailContributorsService.inc.php
@@ -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
@@ -5,7 +5,7 @@
  *
  * This services adds the custom field to the add reviewer form
  *
- * Issue 074
+ * Issue 074, Issue 090
  */
 class PPRSubmissionResearchTypeService {
  const RESEARCH_TYPE_FIELD = 'researchType';

diff --git a/pprOjsPlugin/templates/common/userDetails.tpl b/pprOjsPlugin/templates/common/userDetails.tpl
@@ -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}

diff --git 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')}
  <script type="text/javascript">
  {** HIDE REQUIRE REVISIONS ROUND SECTION *}
+ {** ISSUE 085 *}
  $('form#sendReviews [id="decisionRevisions"]').closest('div').hide();
  </script>
 {/if}

diff --git a/pprOjsPlugin/templates/user/publicProfileForm.tpl b/pprOjsPlugin/templates/user/publicProfileForm.tpl
@@ -59,6 +59,7 @@
  {/fbvFormSection}
 
  <!-- PPR PROGRAM - REMOVE BIO -->
+ <!-- ISSUE 084 -->
  {if !$pprPluginSettings->hideUserBioEnabled()}
  {fbvFormSection}
  {fbvElement type="textarea" label="user.biography" multilingual="true" name="biography" id="biography" rich=true value=$biography}

diff --git a/pprReviewsReportPlugin/tasks/PPREditorReportTask.inc.php b/pprReviewsReportPlugin/tasks/PPREditorReportTask.inc.php
@@ -7,6 +7,8 @@
 
 /**
  * Task to send the submissions/review report to a list of recipients configured in the plugin settings
+ *
+ * Issue 089
  */
 class PPREditorReportTask extends ScheduledTask {