Skip to content

Commit

Permalink
Merge pull request #10 from IQSS/email_template_variables_update
Browse files Browse the repository at this point in the history 
Updated email template variables documentation
  • Loading branch information
@jp-tosca
jp-tosca authored Jun 11, 2024
2 parents 2fc6672 + 894ddc4 commit 77630b4
Showing 1 changed file with 40 additions and 35 deletions.
75 changes: 40 additions & 35 deletions docs/Sphinx-guides/source/sysadminGuide/emailTemplateVariables.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,46 +5,51 @@ These variables can be used in the templates in the form ``{$variable_name}``

## Backend classes
Email variables added by ``FirstNameEmailService``:

authorName, authorFullName, authorFirstName, contributorsNames,
reviewerName, reviewerFullName, reviewerFirstName, firstNameOnly,
editorName, editorFullName, editorFirstName
* authorName, authorFullName, authorFirstName, contributorsNames
* reviewerName, reviewerFullName, reviewerFirstName, firstNameOnly
* editorName, editorFullName, editorFirstName

Email variables added by ``SubmissionMailTemplate``:

submissionTitle, submissionId, submissionAbstract, authorString, principalContactSignature, contextName, contextUrl, senderEmail, senderName, siteTitle
* submissionTitle, submissionId, submissionAbstract
* authorString, principalContactSignature
* contextName, contextUrl
* senderEmail, senderName
* siteTitle

Email Variables added by ``MailTemplate``:

principalContactSignature, contextName, contextUrl, senderEmail, senderName, siteTitle
* principalContactSignature
* contextName, contextUrl
* senderEmail, senderName
* siteTitle

## Descriptions

| Email Template | Variables |
|-----------------|----------------------------------------------------------------------------------|
| ``NOTIFICATION`` | |
| ``EDITOR_DECISION_INITIAL_DECLINE`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, authorName, submissionUrl |
| ``EDITOR_DECISION_DECLINE`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, authorName, submissionUrl |
| ``EDITOR_DECISION_REVISIONS`` | ``FirstNameEmailService``, ``SubmissionMailTemplate``, authorName, submissionUrl |
| ``SUBMISSION_ACK`` | |
| ``PPR_SUBMISSION_APPROVED`` | |
| ``EDITOR_ASSIGN`` | |
| ``REVIEW_REQUEST_ONECLICK`` | |
| ``REVIEW_CONFIRM`` | |
| ``REVIEW_DECLINE`` | |
| ``PPR_REVIEW_ACCEPTED`` | |
| ``PPR_REVIEW_DUE_DATE_REVIEWER`` | |
| ``PPR_REVIEW_DUE_DATE_EDITOR`` | |
| ``PPR_REVIEW_REQUEST_DUE_DATE_REVIEWER`` | |
| ``REVIEW_REMIND_ONECLICK`` | |
| ``PPR_REQUESTED_REVIEWER_UNASSIGN`` | |
| ``PPR_CONFIRMED_REVIEWER_UNASSIGN`` | |
| ``PPR_REVIEW_SUBMITTED`` | |
| ``REVIEW_ACK`` | |
| ``PPR_SUBMISSIONS_REPORT_TASK`` | |
| ``PPR_REVIEW_SENT_AUTHOR`` | |
| ``PPR_REVIEW_PENDING_WITH_FILES_REVIEWER`` | |
| ``PPR_REVIEW_DUE_DATE_WITH_FILES_REVIEWER`` | |
| ``PPR_SUBMISSION_CLOSED_AUTHOR`` | |
| ``REVIEW_CANCEL`` | |
| 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`` | |

0 comments on commit 77630b4

Please sign in to comment.