Skip to content

Commit

Permalink
Merge pull request #12 from IQSS/email_template_variables_final
Browse files Browse the repository at this point in the history
Completed email template variables documentation
  • Loading branch information
jp-tosca authored Jun 13, 2024
2 parents be5deb9 + ac76581 commit 22597a3
Showing 1 changed file with 25 additions and 25 deletions.
50 changes: 25 additions & 25 deletions docs/Sphinx-guides/source/sysadminGuide/emailTemplateVariables.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |

0 comments on commit 22597a3

Please sign in to comment.