From ac76581933ac6f017db08fbae4aaaf15ad789c94 Mon Sep 17 00:00:00 2001 From: Aday Bujeda Date: Thu, 13 Jun 2024 11:09:48 +0100 Subject: [PATCH] Completed email template variables documentation --- .../sysadminGuide/emailTemplateVariables.md | 50 +++++++++---------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/docs/Sphinx-guides/source/sysadminGuide/emailTemplateVariables.md b/docs/Sphinx-guides/source/sysadminGuide/emailTemplateVariables.md index 8320af8..0f8f618 100644 --- a/docs/Sphinx-guides/source/sysadminGuide/emailTemplateVariables.md +++ b/docs/Sphinx-guides/source/sysadminGuide/emailTemplateVariables.md @@ -24,32 +24,32 @@ Email Variables added by ``MailTemplate``: ## Descriptions -| Email Template | Variables | -|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| ``NOTIFICATION`` | ``MailTemplate``, notificationContents, url, siteTitle | -| ``EDITOR_DECISION_INITIAL_DECLINE`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, authorName, submissionUrl | -| ``EDITOR_DECISION_DECLINE`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, authorName, submissionUrl | -| ``EDITOR_DECISION_REVISIONS`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, authorName, submissionUrl | -| ``SUBMISSION_ACK`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, authorName, authorUsername, editorialContactSignature, submissionUrl | -| ``PPR_SUBMISSION_APPROVED`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, submissionUrl | -| ``EDITOR_ASSIGN`` | ``FirstNameEmailService``, ``SubmissionMailTemplate`` | -| ``REVIEW_REQUEST_ONECLICK`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, contextUrl, editorialContactSignature, signatureFullName, passwordResetUrl, messageToReviewer, abstractTermIfEnabled | -| ``REVIEW_CONFIRM`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, reviewDueDate | -| ``REVIEW_DECLINE`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, reviewDueDate | -| ``PPR_REVIEW_ACCEPTED`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, reviewerUserName, reviewDueDate, passwordResetUrl, submissionReviewUrl | +| Email Template | Variables | +|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ``NOTIFICATION`` | ``MailTemplate``, notificationContents, url, siteTitle | +| ``EDITOR_DECISION_INITIAL_DECLINE`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, authorName, submissionUrl | +| ``EDITOR_DECISION_DECLINE`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, authorName, submissionUrl | +| ``EDITOR_DECISION_REVISIONS`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, authorName, submissionUrl | +| ``SUBMISSION_ACK`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, authorName, authorUsername, editorialContactSignature, submissionUrl | +| ``PPR_SUBMISSION_APPROVED`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, submissionUrl | +| ``EDITOR_ASSIGN`` | ``FirstNameEmailService``, ``SubmissionMailTemplate`` | +| ``REVIEW_REQUEST_ONECLICK`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, contextUrl, editorialContactSignature, signatureFullName, passwordResetUrl, messageToReviewer, abstractTermIfEnabled | +| ``REVIEW_CONFIRM`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, reviewDueDate | +| ``REVIEW_DECLINE`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, reviewDueDate | +| ``PPR_REVIEW_ACCEPTED`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, reviewerUserName, reviewDueDate, passwordResetUrl, submissionReviewUrl | | ``PPR_REVIEW_DUE_DATE_REVIEWER`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, reviewerUserName, reviewDueDate, responseDueDate, editorialContactSignature, passwordResetUrl, submissionReviewUrl, messageToReviewer, abstractTermIfEnabled | | ``PPR_REVIEW_PENDING_WITH_FILES_REVIEWER`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, reviewerUserName, reviewDueDate, responseDueDate, editorialContactSignature, passwordResetUrl, submissionReviewUrl, messageToReviewer, abstractTermIfEnabled | | ``PPR_REVIEW_DUE_DATE_WITH_FILES_REVIEWER`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, reviewerUserName, reviewDueDate, responseDueDate, editorialContactSignature, passwordResetUrl, submissionReviewUrl, messageToReviewer, abstractTermIfEnabled | -| ``PPR_REVIEW_DUE_DATE_EDITOR`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, reviewDueDate, editorialContactSignature, submissionReviewUrl | -| ``PPR_REVIEW_REQUEST_DUE_DATE_REVIEWER`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, reviewDueDate, passwordResetUrl, submissionReviewUrl, editorialContactSignature | -| ``REVIEW_REMIND_ONECLICK`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, reviewDueDate, passwordResetUrl, submissionReviewUrl, editorialContactSignature | -| ``REVIEW_REMIND`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, reviewDueDate, passwordResetUrl, submissionReviewUrl, editorialContactSignature | -| ``PPR_REQUESTED_REVIEWER_UNASSIGN`` | reviewerName, reviewerFirstName, editorName, editorFirstName, authorName, authorFirstName | -| ``PPR_CONFIRMED_REVIEWER_UNASSIGN`` | reviewerName, reviewerFirstName, editorName, editorFirstName, authorName, authorFirstName | -| ``PPR_REVIEW_SUBMITTED`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, reviewerUserName, reviewDueDate | -| ``REVIEW_ACK`` | | -| ``PPR_SUBMISSIONS_REPORT_TASK`` | | -| ``PPR_REVIEW_SENT_AUTHOR`` | | -| ``PPR_SUBMISSION_CLOSED_AUTHOR`` | | -| ``REVIEW_CANCEL`` | | +| ``PPR_REVIEW_DUE_DATE_EDITOR`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, reviewDueDate, editorialContactSignature, submissionReviewUrl | +| ``PPR_REVIEW_REQUEST_DUE_DATE_REVIEWER`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, reviewDueDate, passwordResetUrl, submissionReviewUrl, editorialContactSignature | +| ``REVIEW_REMIND_ONECLICK`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, reviewDueDate, passwordResetUrl, submissionReviewUrl, editorialContactSignature | +| ``REVIEW_REMIND`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, reviewDueDate, passwordResetUrl, submissionReviewUrl, editorialContactSignature | +| ``PPR_REQUESTED_REVIEWER_UNASSIGN`` | reviewerName, reviewerFirstName, editorName, editorFirstName, authorName, authorFirstName | +| ``PPR_CONFIRMED_REVIEWER_UNASSIGN`` | reviewerName, reviewerFirstName, editorName, editorFirstName, authorName, authorFirstName | +| ``PPR_REVIEW_SUBMITTED`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, reviewerUserName, reviewDueDate | +| ``REVIEW_ACK`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, contextUrl, editorialContactSignature, signatureFullName | +| ``PPR_REVIEW_SENT_AUTHOR`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, editorialContactSignature, submissionUrl | +| ``PPR_SUBMISSION_CLOSED_AUTHOR`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, editorialContactSignature, submissionUrl | +| ``REVIEW_CANCEL`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, signatureFullName | +| ``PPR_SUBMISSIONS_REPORT_TASK`` | No variables are added |